<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/features/logging.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/features/logging.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/features/logging.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/features/logging.md in fork/static-web-server at allow-symlink.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="allow-symlink" data-tip="4414610fe1b0370ff0ac415e9367548840584710">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/static-web-server</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/static-web-server</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Jose Quintana</span><span class="commit-message" data-commit="b6856eaccc82b4895aebd050ad9d535d30831411">docs: local-time support for logs (#638)</span><span class="snapshot-sha sha" data-commit="b6856eaccc82b4895aebd050ad9d535d30831411">b6856ea</span><time datetime="2026-02-27T21:32:06+01:00" title="2026-02-27 21:32:06 +0100">2026-02-27</time></p>
<header class="topbar"><details class="switcher"><summary>allow-symlink</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/static-web-server/ref/allow-symlink/">allow-symlink</a><a class="all" href="/fork/static-web-server/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/static-web-server/">static-web-server</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/">docs</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/">content</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/features/">features</a> / <span class="cur">logging.md</span></nav>
<span class="view-stats"><span>8.2 KiB</span><span>179 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/b48baa0a1a05aa6130726a35671cb7a38e281177/docs/content/features/logging.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Logging</h1>
<p><strong><code>SWS</code></strong> provides logging support by just specifying a log level in lower case. The values allowed are <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code> and <code>trace</code>. The default value is <code>error</code>.</p>
<p>This feature is enabled by default and can be controlled by the string <code>-g, --log-level</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_log_level">SERVER_LOG_LEVEL</a> env.</p>
<p>Below is an example of how to adjust the log level.</p>
<pre class="language-bash"><a-f>static-web-server</a-f> \
    <a-co>--port</a-co> 8787 \
    <a-co>--root</a-co> ./my-public-dir \
    <a-co>--log-level</a-co> <a-s>&quot;trace&quot;</a-s></pre>
<blockquote>
<p>Note: The log format is not well defined and is subject to change.</p>
</blockquote>
<h2>Log Date-Timestamp</h2>
<p>SWS prefers the local-time (system date and time) for logs by default to respect the user's system time.
But SWS also allows the usage of the POSIX <a href="https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html">TZ</a> environment variable to override the default timezone.</p>
<p>Below are some examples.</p>
<p>Use the default system time zone (e.g. CET "UTC +1"):</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>static</a-pr><a-f>-web-server</a-f> <a-co>-p</a-co> 8788 <a-co>-d</a-co> /var/public/ <a-co>-g</a-co> info
<a-c># 2026-02-26T22:26:56.369326294+01:00  INFO static_web_server::server: static-web-server 2.41.0</a-c>
<a-c># 2026-02-26T22:26:56.369448665+01:00  INFO static_web_server::server: log level: info</a-c>
<a-c># 2026-02-26T22:26:56.369514676+01:00  INFO static_web_server::server: server bound to tcp socket [::]:8788</a-c>
<a-c># 2026-02-26T22:26:56.369553858+01:00  INFO static_web_server::server: runtime worker threads: 4</a-c>
<a-c># 2026-02-26T22:26:56.369591864+01:00  INFO static_web_server::server: runtime max blocking threads: 512</a-c>
<a-c># ....</a-c></pre>
<p>Use a particular time zone via the <code>TZ</code> env (e.g. PET "UTC -5"):</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>TZ</a-pr><a-f>=</a-f><a-s>&quot;America/Lima&quot;</a-s> \
    static-web-server <a-co>-p</a-co> 8788 <a-co>-d</a-co> /var/public/ <a-co>-g</a-co> info
<a-c># 2026-02-26T16:25:55.345113713-05:00  INFO static_web_server::server: static-web-server 2.41.0</a-c>
<a-c># 2026-02-26T16:25:55.349553610-05:00  INFO static_web_server::server: log level: info</a-c>
<a-c># 2026-02-26T16:25:55.350314431-05:00  INFO static_web_server::server: server bound to tcp socket [::]:8788</a-c>
<a-c># 2026-02-26T16:25:55.350388002-05:00  INFO static_web_server::server: runtime worker threads: 4</a-c>
<a-c># 2026-02-26T16:25:55.350436754-05:00  INFO static_web_server::server: runtime max blocking threads: 512</a-c>
<a-c># ....</a-c></pre>
<h2>Log output with ANSI</h2>
<p>SWS does not output ANSI escape codes by default. However, If you want ANSI escape for colors and other text formatting when logging then use the boolean <code>--log-with-ansi</code> CLI option and its equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_log_with_ansi">SERVER_LOG_WITH_ANSI</a> env.</p>
<p>For example, if you want colored log output then use the <code>--log-with-ansi</code> option as follows:</p>
<pre class="language-bash"><a-f>static-web-server</a-f> <a-co>-p</a-co> 8788 <a-co>-d</a-co> ./public/ <a-co>-g</a-co> trace <a-co>-z</a-co> <a-co>--log-with-ansi</a-co></pre>
<h2>Log Remote Addresses</h2>
<p>SWS provides <em>Remote Address (IP)</em> logging for every request via an <code>INFO</code> log level.</p>
<p>This feature is disabled by default and can be enabled by the boolean <code>--log-remote-address</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_log_remote_address">SERVER_LOG_REMOTE_ADDRESS</a> env.</p>
<p>If the feature is enabled then log entries for requests will contain a <code>remote_addr</code> section with the remote address (IP) value. Otherwise, it will be empty.</p>
<p>Log entry example:</p>
<pre>2022-05-23T22:24:50.519540Z  INFO static_web_server::handler: incoming request: method=GET uri=/ remote_addr=192.168.1.126:57625
</pre>
<p>Below is an example of how to enable Remote Address (IP) logging.</p>
<pre class="language-bash"><a-f>static-web-server</a-f> <a-co>-a</a-co> <a-s>&quot;0.0.0.0&quot;</a-s> <a-co>-p</a-co> 8080 <a-co>-d</a-co> docker/public/ <a-co>-g</a-co> info <a-co>--log-remote-address=true</a-co></pre>
<p>The relevant log output:</p>
<pre>INFO static_web_server::logger: logging level: info
&lt;...&gt;
INFO static_web_server::info: log requests with remote IP addresses: enabled=true
&lt;...&gt;
INFO static_web_server::handler: incoming request: method=GET uri=/ remote_addr=192.168.1.126:57625
INFO static_web_server::handler: incoming request: method=GET uri=/favicon.ico remote_addr=192.168.1.126:57625
</pre>
<h2>Logging Client IP from X-Real-IP header</h2>
<p>Some upstream proxies will report the client's real IP address in the <code>X-Real-IP</code> header.</p>
<p>To enable logging of the X-Real-IP header, enable the <code>--log-x-real-ip</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_log_x_real_ip">SERVER_LOG_X_REAL_IP</a> environment variable.</p>
<p>When enabled, the log entries will look like:</p>
<pre>INFO static_web_server::handler: incoming request: method=GET uri=/ x_real_ip=203.0.113.195
</pre>
<p>If the value of the <code>X-Real-IP</code> header does not parse as an IP address, no value will be logged.</p>
<p>To restrict the logging to only requests that originate from trusted proxy IPs, you can use the <code>--trusted-proxies</code> option, or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_trusted_proxies">SERVER_TRUSTED_PROXIES</a> env. This should be a list of IPs, separated by commas. An empty list (the default) indicates that all IPs should be trusted.</p>
<h2>Logging Client IP from X-Forwarded-For header</h2>
<blockquote>
<p>Note: This header should only be trusted when you know your upstream is handling X-Forwarded-For securely and when using the <code>--trusted-proxies</code> option.</p>
</blockquote>
<p>When used behind a reverse proxy the reported <code>remote_addr</code> indicates the proxies IP address and port, not the client's real IP.
The Proxy server can be configured to provide the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For">X-Forwarded-For header</a>, containing a comma-separated list of IP addresses, starting with the <em>real remote client IP</em>, and all following intermediate proxies (if any).</p>
<p>To enable logging of the real remote IP, enable the <code>--log-forwarded-for</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_log_forwarded_for">SERVER_LOG_FORWARDED_FOR</a> env. By default this will log all requests which have a correctly formatted <code>X-Forwarded-For</code> header.</p>
<p>Since the content of the <code>X-Forwarded-For</code> header can be changed by all proxies in the chain, the remote IP address reported may not be trusted.</p>
<p>To restrict the logging to only requests that originate from trusted proxy IPs, you can use the <code>--trusted-proxies</code> option, or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_trusted_proxies">SERVER_TRUSTED_PROXIES</a> env. This should be a list of IPs, separated by commas. An empty list (the default) indicates that all IPs should be trusted.</p>
<p>Command used for the following examples:</p>
<pre class="language-bash"><a-f>static-web-server</a-f> <a-co>-a</a-co> <a-s>&quot;::&quot;</a-s> <a-co>--log-forwarded-for=true</a-co> <a-co>--trusted-proxies=</a-co><a-s>&quot;::1&quot;</a-s> <a-co>-p</a-co> 8080 <a-co>-d</a-co> docker/public/ <a-co>-g</a-co> info</pre>
<p>Look for these lines in the log output:</p>
<pre>&lt;...&gt;
INFO static_web_server::info: log level: info
INFO static_web_server::info: log requests with remote IP addresses: enabled=false
INFO static_web_server::info: log X-Forwarded-For real remote IP addresses: enabled=true
INFO static_web_server::info: trusted IPs for X-Forwarded-For: [::1]
&lt;...&gt;
</pre>
<p>We can simulate request as from behind reverse proxy with additional intermediate-proxy with following command:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-s>&quot;http://[::1]:8080&quot;</a-s> <a-co>--header</a-co> <a-s>&quot;X-Forwarded-For: 203.0.113.195, 2001:db8:85a3:8d3:1319:8a2e:370:7348&quot;</a-s></pre>
<p>Log entry for this request will look like:</p>
<pre>INFO static_web_server::handler: incoming request: method=GET uri=/ real_remote_ip=203.0.113.195
</pre>
<hr />
<p>If we send the request from <code>127.0.0.1</code> instead:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-s>&quot;http://127.0.0.1:8080&quot;</a-s> <a-co>--header</a-co> <a-s>&quot;X-Forwarded-For: 203.0.113.195, 2001:db8:85a3:8d3:1319:8a2e:370:7348&quot;</a-s></pre>
<p>we get the following log output:</p>
<pre>INFO static_web_server::handler: incoming request: method=GET uri=/
</pre>
<p><code>127.0.0.1</code> is not in the <code>trusted_proxies</code>, so we dont get a <code>real_remote_address</code> in the log.</p>
<p>Note the absence of the proxies remote address in these examples. If you want to log the remote address and the real remote address, you need to specify both <code>--log-remote-address</code> and <code>--log-forwarded-for</code>.</p>
<hr />
<p><strong><code>SWS</code></strong> will parse the <code>X-Forwarded-For</code> header and if the provided client IP is invalid, it will be ignored to prevent log poisoning attacks. In such cases the <code>real_remote_ip</code> section will not be added.</p>
<p>Example from above, but with invalid header:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-s>&quot;http://[::1]:8080&quot;</a-s> <a-co>--header</a-co> <a-s>&quot;X-Forwarded-For: &lt;iframe src=//malware.attack&gt;&quot;</a-s></pre>
<pre>2022-05-23T22:24:50.519540Z  INFO static_web_server::handler: incoming request: method=GET uri=/
</pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Logging</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">**`SWS`** provides logging support by just specifying a log level in lower case. The values allowed are `error`, `warn`, `info`, `debug` and `trace`. The default value is `error`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">This feature is enabled by default and can be controlled by the string `-g, --log-level` option or the equivalent [SERVER_LOG_LEVEL](./../configuration/environment-variables.md#server_log_level) env.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Below is an example of how to adjust the log level.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>static-web-server \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>    --port 8787 \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>    --root ./my-public-dir \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>    --log-level &quot;trace&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>&gt; Note: The log format is not well defined and is subject to change.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>## </a-p><a-tt>Log Date-Timestamp</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>SWS prefers the local-time (system date and time) for logs by default to respect the user&#39;s system time.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>But SWS also allows the usage of the POSIX [TZ](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html) environment variable to override the default timezone.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>Below are some examples.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>Use the default system time zone (e.g. CET &quot;UTC +1&quot;):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>$ static-web-server -p 8788 -d /var/public/ -g info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p># 2026-02-26T22:26:56.369326294+01:00  INFO static_web_server::server: static-web-server 2.41.0</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p># 2026-02-26T22:26:56.369448665+01:00  INFO static_web_server::server: log level: info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p># 2026-02-26T22:26:56.369514676+01:00  INFO static_web_server::server: server bound to tcp socket [::]:8788</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p># 2026-02-26T22:26:56.369553858+01:00  INFO static_web_server::server: runtime worker threads: 4</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p># 2026-02-26T22:26:56.369591864+01:00  INFO static_web_server::server: runtime max blocking threads: 512</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p># ....</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>Use a particular time zone via the `TZ` env (e.g. PET &quot;UTC -5&quot;):</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>$ TZ=&quot;America/Lima&quot; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    static-web-server -p 8788 -d /var/public/ -g info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p># 2026-02-26T16:25:55.345113713-05:00  INFO static_web_server::server: static-web-server 2.41.0</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p># 2026-02-26T16:25:55.349553610-05:00  INFO static_web_server::server: log level: info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p># 2026-02-26T16:25:55.350314431-05:00  INFO static_web_server::server: server bound to tcp socket [::]:8788</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p># 2026-02-26T16:25:55.350388002-05:00  INFO static_web_server::server: runtime worker threads: 4</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p># 2026-02-26T16:25:55.350436754-05:00  INFO static_web_server::server: runtime max blocking threads: 512</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p># ....</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>## </a-p><a-tt>Log output with ANSI</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>SWS does not output ANSI escape codes by default. However, If you want ANSI escape for colors and other text formatting when logging then use the boolean `--log-with-ansi` CLI option and its equivalent [SERVER_LOG_WITH_ANSI](./../configuration/environment-variables.md#server_log_with_ansi) env.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>For example, if you want colored log output then use the `--log-with-ansi` option as follows:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>static-web-server -p 8788 -d ./public/ -g trace -z --log-with-ansi</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>## </a-p><a-tt>Log Remote Addresses</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>SWS provides *Remote Address (IP)* logging for every request via an `INFO` log level.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>This feature is disabled by default and can be enabled by the boolean `--log-remote-address` option or the equivalent [SERVER_LOG_REMOTE_ADDRESS](./../configuration/environment-variables.md#server_log_remote_address) env.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>If the feature is enabled then log entries for requests will contain a `remote_addr` section with the remote address (IP) value. Otherwise, it will be empty.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>Log entry example:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>2022-05-23T22:24:50.519540Z  INFO static_web_server::handler: incoming request: method=GET uri=/ remote_addr=192.168.1.126:57625</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>Below is an example of how to enable Remote Address (IP) logging.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>static-web-server -a &quot;0.0.0.0&quot; -p 8080 -d docker/public/ -g info --log-remote-address=true</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>The relevant log output:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>INFO static_web_server::logger: logging level: info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>&lt;...&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>INFO static_web_server::info: log requests with remote IP addresses: enabled=true</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>&lt;...&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>INFO static_web_server::handler: incoming request: method=GET uri=/ remote_addr=192.168.1.126:57625</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>INFO static_web_server::handler: incoming request: method=GET uri=/favicon.ico remote_addr=192.168.1.126:57625</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>## </a-p><a-tt>Logging Client IP from X-Real-IP header</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>Some upstream proxies will report the client&#39;s real IP address in the `X-Real-IP` header.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>To enable logging of the X-Real-IP header, enable the `--log-x-real-ip` option or the equivalent [SERVER_LOG_X_REAL_IP](../configuration/environment-variables.md#server_log_x_real_ip) environment variable.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>When enabled, the log entries will look like:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>INFO static_web_server::handler: incoming request: method=GET uri=/ x_real_ip=203.0.113.195</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>If the value of the `X-Real-IP` header does not parse as an IP address, no value will be logged.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>To restrict the logging to only requests that originate from trusted proxy IPs, you can use the `--trusted-proxies` option, or the equivalent [SERVER_TRUSTED_PROXIES](../configuration/environment-variables.md#server_trusted_proxies) env. This should be a list of IPs, separated by commas. An empty list (the default) indicates that all IPs should be trusted.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>## </a-p><a-tt>Logging Client IP from X-Forwarded-For header</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>&gt; Note: This header should only be trusted when you know your upstream is handling X-Forwarded-For securely and when using the `--trusted-proxies` option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>When used behind a reverse proxy the reported `remote_addr` indicates the proxies IP address and port, not the client&#39;s real IP.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>The Proxy server can be configured to provide the [X-Forwarded-For header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For), containing a comma-separated list of IP addresses, starting with the *real remote client IP*, and all following intermediate proxies (if any).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>To enable logging of the real remote IP, enable the `--log-forwarded-for` option or the equivalent [SERVER_LOG_FORWARDED_FOR](../configuration/environment-variables.md#server_log_forwarded_for) env. By default this will log all requests which have a correctly formatted `X-Forwarded-For` header.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>Since the content of the `X-Forwarded-For` header can be changed by all proxies in the chain, the remote IP address reported may not be trusted.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>To restrict the logging to only requests that originate from trusted proxy IPs, you can use the `--trusted-proxies` option, or the equivalent [SERVER_TRUSTED_PROXIES](../configuration/environment-variables.md#server_trusted_proxies) env. This should be a list of IPs, separated by commas. An empty list (the default) indicates that all IPs should be trusted.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>Command used for the following examples:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>static-web-server -a &quot;::&quot; --log-forwarded-for=true --trusted-proxies=&quot;::1&quot; -p 8080 -d docker/public/ -g info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>Look for these lines in the log output:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-p>&lt;...&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"><a-p>INFO static_web_server::info: log level: info</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>INFO static_web_server::info: log requests with remote IP addresses: enabled=false</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>INFO static_web_server::info: log X-Forwarded-For real remote IP addresses: enabled=true</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>INFO static_web_server::info: trusted IPs for X-Forwarded-For: [::1]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>&lt;...&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>We can simulate request as from behind reverse proxy with additional intermediate-proxy with following command:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>curl &quot;http://[::1]:8080&quot; --header &quot;X-Forwarded-For: 203.0.113.195, 2001:db8:85a3:8d3:1319:8a2e:370:7348&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>Log entry for this request will look like:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>INFO static_web_server::handler: incoming request: method=GET uri=/ real_remote_ip=203.0.113.195</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>______________________________________________________________________</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"><a-p>If we send the request from `127.0.0.1` instead:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>curl &quot;http://127.0.0.1:8080&quot; --header &quot;X-Forwarded-For: 203.0.113.195, 2001:db8:85a3:8d3:1319:8a2e:370:7348&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"><a-p>we get the following log output:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"><a-p>INFO static_web_server::handler: incoming request: method=GET uri=/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>`127.0.0.1` is not in the `trusted_proxies`, so we dont get a `real_remote_address` in the log.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>Note the absence of the proxies remote address in these examples. If you want to log the remote address and the real remote address, you need to specify both `--log-remote-address` and `--log-forwarded-for`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"><a-p>______________________________________________________________________</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>**`SWS`** will parse the `X-Forwarded-For` header and if the provided client IP is invalid, it will be ignored to prevent log poisoning attacks. In such cases the `real_remote_ip` section will not be added.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>Example from above, but with invalid header:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"><a-p>curl &quot;http://[::1]:8080&quot; --header &quot;X-Forwarded-For: &lt;iframe src=//malware.attack&gt;&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>```</a-p><a-tl>log</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"><a-p>2022-05-23T22:24:50.519540Z  INFO static_web_server::handler: incoming request: method=GET uri=/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
