Add document for fluent-plugin-groonga-query-log

naokia · Jan 22, 2016 · 4073043 · 4073043
1 parent 8837b8d
commit 4073043
Show file tree

Hide file tree

Showing 36 changed files with 5,336 additions and 0 deletions.
diff --git a/fluent-plugin-groonga-query-log/en/Fluent.html b/fluent-plugin-groonga-query-log/en/Fluent.html
@@ -0,0 +1,111 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Fluent
+
+    &mdash; fluent-plugin-groonga-query-log
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Fluent.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+
+    <a href="alphabetical_index.html">Index (F)</a> &raquo;
+
+
+    <span class="title">Fluent</span>
+
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Fluent
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/fluent/plugin/filter_groonga_query_log.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+
+
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Fluent/GroongaQueryLogFilter.html" title="Fluent::GroongaQueryLogFilter (class)">GroongaQueryLogFilter</a></span>
+
+
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer"></div>
+
+  </body>
+</html>
diff --git a/fluent-plugin-groonga-query-log/en/Fluent/GroongaQueryLogFilter.html b/fluent-plugin-groonga-query-log/en/Fluent/GroongaQueryLogFilter.html
@@ -0,0 +1,264 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Fluent::GroongaQueryLogFilter
+
+    &mdash; fluent-plugin-groonga-query-log
+
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Fluent/GroongaQueryLogFilter.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+
+    <a href="../alphabetical_index.html">Index (G)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Fluent.html" title="Fluent (module)">Fluent</a></span></span>
+     &raquo; 
+    <span class="title">GroongaQueryLogFilter</span>
+
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Fluent::GroongaQueryLogFilter
+
+
+
+</h1>
+
+<dl class="box">
+
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Filter</span>
+
+        <ul class="fullTree">
+          <li>Object</li>
+
+            <li class="next">Filter</li>
+
+            <li class="next">Fluent::GroongaQueryLogFilter</li>
+
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+
+      </dd>
+
+
+
+
+
+
+
+
+
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/fluent/plugin/filter_groonga_query_log.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+
+
+
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#configure-instance_method" title="#configure (instance method)">- (Object) <strong>configure</strong>(conf) </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#filter_stream-instance_method" title="#filter_stream (instance method)">- (Object) <strong>filter_stream</strong>(tag, event_stream) </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+
+</li>
+
+
+    </ul>
+
+
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+
+      <div class="method_details first">
+  <h3 class="signature first" id="configure-instance_method">
+
+    - (<tt>Object</tt>) <strong>configure</strong>(conf) 
+
+
+
+
+
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+30
+31
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/fluent/plugin/filter_groonga_query_log.rb', line 30</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='rparen'>)</span>
+  <span class='kw'>super</span>
+
+  <span class='ivar'>@parser</span> <span class='op'>=</span> <span class='const'>Groonga</span><span class='op'>::</span><span class='const'>QueryLog</span><span class='op'>::</span><span class='const'>Parser</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="filter_stream-instance_method">
+
+    - (<tt>Object</tt>) <strong>filter_stream</strong>(tag, event_stream) 
+
+
+
+
+
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/fluent/plugin/filter_groonga_query_log.rb', line 36</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_filter_stream'>filter_stream</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='comma'>,</span> <span class='id identifier rubyid_event_stream'>event_stream</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_statistics_event_stream'>statistics_event_stream</span> <span class='op'>=</span> <span class='const'>MultiEventStream</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_event_stream'>event_stream</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_time'>time</span><span class='comma'>,</span> <span class='id identifier rubyid_record'>record</span><span class='op'>|</span>
+    <span class='id identifier rubyid_raw_data'>raw_data</span> <span class='op'>=</span> <span class='id identifier rubyid_record'>record</span><span class='lbracket'>[</span><span class='ivar'>@raw_data_column_name</span><span class='rbracket'>]</span>
+    <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_raw_data'>raw_data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='ivar'>@parser</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_raw_data'>raw_data</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_statistic'>statistic</span><span class='op'>|</span>
+      <span class='id identifier rubyid_statistic_record'>statistic_record</span> <span class='op'>=</span> <span class='id identifier rubyid_create_record'>create_record</span><span class='lparen'>(</span><span class='id identifier rubyid_statistic'>statistic</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_statistics_event_stream'>statistics_event_stream</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='comma'>,</span> <span class='id identifier rubyid_statistic_record'>statistic_record</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_statistics_event_stream'>statistics_event_stream</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+  </div>
+
+</div>
+
+    <div id="footer"></div>
+
+  </body>
+</html>