File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/AccessLog.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module WEBrick::AccessLog - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-escape">#escape</a>
<li ><a href="#method-i-format">#format</a>
<li ><a href="#method-i-setup_params">#setup_params</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-WEBrick::AccessLog">
<h1 id="module-WEBrick::AccessLog" class="module">
module WEBrick::AccessLog
</h1>
<section class="description">
<p><a href="AccessLog.html"><code>AccessLog</code></a> provides logging to various files in various formats.</p>
<p>Multiple logs may be written to at the same time:</p>
<pre class="ruby"><span class="ruby-identifier">access_log</span> = [
[<span class="ruby-identifier">$stderr</span>, <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-constant">COMMON_LOG_FORMAT</span>],
[<span class="ruby-identifier">$stderr</span>, <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-constant">REFERER_LOG_FORMAT</span>],
]
<span class="ruby-identifier">server</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPServer</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:AccessLog</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">access_log</span>
</pre>
<p>Custom log formats may be defined. <a href="AccessLog.html"><code>WEBrick::AccessLog</code></a> provides a subset of the formatting from Apache's mod_log_config <a href="http://httpd.apache.org/docs/mod/mod_log_config.html#formats">httpd.apache.org/docs/mod/mod_log_config.html#formats</a>. See AccessLog::setup_params for a list of supported options</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="AGENT_LOG_FORMAT">AGENT_LOG_FORMAT
<dd><p>User-Agent <a href="Log.html"><code>Log</code></a> Format</p>
<dt id="CLF">CLF
<dd><p>Short alias for Common <a href="Log.html"><code>Log</code></a> Format</p>
<dt id="CLF_TIME_FORMAT">CLF_TIME_FORMAT
<dd><p>The Common <a href="Log.html"><code>Log</code></a> Format's time format</p>
<dt id="COMBINED_LOG_FORMAT">COMBINED_LOG_FORMAT
<dd><p>Combined <a href="Log.html"><code>Log</code></a> Format</p>
<dt id="COMMON_LOG_FORMAT">COMMON_LOG_FORMAT
<dd><p>Common <a href="Log.html"><code>Log</code></a> Format</p>
<dt id="REFERER_LOG_FORMAT">REFERER_LOG_FORMAT
<dd><p>Referer <a href="Log.html"><code>Log</code></a> Format</p>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-escape" class="method-detail ">
<div class="method-heading">
<span class="method-name">escape</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Escapes control characters in <code>data</code></p>
<div class="method-source-code" id="escape-source">
<pre><span class="ruby-comment"># File lib/webrick/accesslog.rb, line 151</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">escape</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[[:cntrl:]\\]+/</span>) {<span class="ruby-node">$&</span>.<span class="ruby-identifier">dump</span>[<span class="ruby-value">1</span><span class="ruby-operator">...</span><span class="ruby-value">-1</span>]}
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">untaint</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">RUBY_VERSION</span> <span class="ruby-operator"><</span> <span class="ruby-string">'2.7'</span>
<span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-format" class="method-detail ">
<div class="method-heading">
<span class="method-name">format</span><span
class="method-args">(format_string, params)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Formats <code>params</code> according to <code>format_string</code> which is described in setup_params.</p>
<div class="method-source-code" id="format-source">
<pre><span class="ruby-comment"># File lib/webrick/accesslog.rb, line 123</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">format</span>(<span class="ruby-identifier">format_string</span>, <span class="ruby-identifier">params</span>)
<span class="ruby-identifier">format_string</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\%(?:\{(.*?)\})?>?([a-zA-Z%])/</span>){
<span class="ruby-identifier">param</span>, <span class="ruby-identifier">spec</span> = <span class="ruby-node">$1</span>, <span class="ruby-node">$2</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">spec</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">when</span> <span class="ruby-value">?e</span>, <span class="ruby-value">?i</span>, <span class="ruby-value">?n</span>, <span class="ruby-value">?o</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">AccessLogError</span>,
<span class="ruby-node">"parameter is required for \"#{spec}\""</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">param</span>
(<span class="ruby-identifier">param</span> = <span class="ruby-identifier">params</span>[<span class="ruby-identifier">spec</span>][<span class="ruby-identifier">param</span>]) <span class="ruby-operator">?</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">param</span>) <span class="ruby-operator">:</span> <span class="ruby-string">"-"</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">?t</span>
<span class="ruby-identifier">params</span>[<span class="ruby-identifier">spec</span>].<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">param</span> <span class="ruby-operator">||</span> <span class="ruby-constant">CLF_TIME_FORMAT</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">?p</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">param</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'remote'</span>
<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">params</span>[<span class="ruby-string">"i"</span>].<span class="ruby-identifier">peeraddr</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">params</span>[<span class="ruby-string">"p"</span>].<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">?%</span>
<span class="ruby-string">"%"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">params</span>[<span class="ruby-identifier">spec</span>].<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_params" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_params</span><span
class="method-args">(config, req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This format specification is a subset of mod_log_config of Apache:</p>
<dl class="rdoc-list note-list"><dt>%a
<dd>
<p>Remote IP address</p>
</dd><dt>%b
<dd>
<p>Total response size</p>
</dd><dt>%e{variable}
<dd>
<p>Given variable in <a href="../ENV.html"><code>ENV</code></a></p>
</dd><dt>%f
<dd>
<p>Response filename</p>
</dd><dt>%h
<dd>
<p>Remote host name</p>
</dd><dt>%{header}i
<dd>
<p>Given request header</p>
</dd><dt>%l
<dd>
<p>Remote logname, always “-”</p>
</dd><dt>%m
<dd>
<p>Request method</p>
</dd><dt>%{attr}n
<dd>
<p>Given request attribute from <code>req.attributes</code></p>
</dd><dt>%{header}o
<dd>
<p>Given response header</p>
</dd><dt>%p
<dd>
<p>Server's request port</p>
</dd><dt>%{format}p
<dd>
<p>The canonical port of the server serving the request or the actual port or the client's actual port. Valid formats are canonical, local or remote.</p>
</dd><dt>%q
<dd>
<p>Request query string</p>
</dd><dt>%r
<dd>
<p>First line of the request</p>
</dd><dt>%s
<dd>
<p>Request status</p>
</dd><dt>%t
<dd>
<p><a href="../Time.html"><code>Time</code></a> the request was received</p>
</dd><dt>%T
<dd>
<p><a href="../Time.html"><code>Time</code></a> taken to process the request</p>
</dd><dt>%u
<dd>
<p>Remote user from auth</p>
</dd><dt>%U
<dd>
<p>Unparsed <a href="../URI.html"><code>URI</code></a></p>
</dd><dt>%%
<dd>
<p>Literal %</p>
</dd></dl>
<div class="method-source-code" id="setup_params-source">
<pre><span class="ruby-comment"># File lib/webrick/accesslog.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_params</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">params</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">""</span>)
<span class="ruby-identifier">params</span>[<span class="ruby-string">"a"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">peeraddr</span>[<span class="ruby-value">3</span>]
<span class="ruby-identifier">params</span>[<span class="ruby-string">"b"</span>] = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">sent_size</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"e"</span>] = <span class="ruby-constant">ENV</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"f"</span>] = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"h"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">peeraddr</span>[<span class="ruby-value">2</span>]
<span class="ruby-identifier">params</span>[<span class="ruby-string">"i"</span>] = <span class="ruby-identifier">req</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"l"</span>] = <span class="ruby-string">"-"</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"m"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"n"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">attributes</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"o"</span>] = <span class="ruby-identifier">res</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"p"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">port</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"q"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">query_string</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"r"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_line</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\x0d?\x0a\z/o</span>, <span class="ruby-string">''</span>)
<span class="ruby-identifier">params</span>[<span class="ruby-string">"s"</span>] = <span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span> <span class="ruby-comment"># won't support "%>s"</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"t"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_time</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"T"</span>] = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_time</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"u"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">||</span> <span class="ruby-string">"-"</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"U"</span>] = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">unparsed_uri</span>
<span class="ruby-identifier">params</span>[<span class="ruby-string">"v"</span>] = <span class="ruby-identifier">config</span>[<span class="ruby-value">:ServerName</span>]
<span class="ruby-identifier">params</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>