<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: MrLogaLoga::Formatters::Json
— Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "MrLogaLoga::Formatters::Json";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (J)</a> »
<span class='title'><span class='object_link'><a href="../../MrLogaLoga.html" title="MrLogaLoga (module)">MrLogaLoga</a></span></span> » <span class='title'><span class='object_link'><a href="../Formatters.html" title="MrLogaLoga::Formatters (module)">Formatters</a></span></span>
»
<span class="title">Json</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: MrLogaLoga::Formatters::Json
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Logger::Formatter</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Logger::Formatter</li>
<li class="next">MrLogaLoga::Formatters::Json</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/mr_loga_loga/formatters/json.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<h2 id="label-Description">Description</h2>
<p>A simple Json formatter for MrLogaLoga.</p>
<h2 id="label-Format">Format</h2>
<p>The json formatter renders messages into a single-line json. Context keys are embedded on the top level.</p>
<p>Log Format:</p>
<pre class="code ruby"><code class="ruby">{ "severity": "Severity", .. "message": "Message", "key1": "Key1" }
</code></pre>
</div>
</div>
<div class="tags">
</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="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Render a log message in JSON.</p>
</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="call-instance_method">
#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Render a log message in JSON</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>severity</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The message severity</p>
</div>
</li>
<li>
<span class='name'>datetime</span>
<span class='type'>(<tt>DateTime</tt>)</span>
—
<div class='inline'>
<p>The message date time</p>
</div>
</li>
<li>
<span class='name'>progname</span>
<span class='type'>(<tt>DateTime</tt>)</span>
—
<div class='inline'>
<p>The program name</p>
</div>
</li>
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>The log message</p>
</div>
</li>
<li>
<span class='name'>context</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>The log message context</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>the formatted log message</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31
32
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mr_loga_loga/formatters/json.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span> <span class='id identifier rubyid_datetime'>datetime</span><span class='comma'>,</span> <span class='id identifier rubyid_progname'>progname</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_context'>context</span><span class='rparen'>)</span>
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_message'>message</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_msg2str'>msg2str</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
<span class='id identifier rubyid_message_hash'>message_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>severity:</span> <span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span>
<span class='label'>datetime:</span> <span class='id identifier rubyid_datetime'>datetime</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%Y-%m-%dT%H:%M:%S.%6N</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span>
<span class='label'>pid:</span> <span class='const'>Process</span><span class='period'>.</span><span class='id identifier rubyid_pid'>pid</span><span class='comma'>,</span>
<span class='label'>progname:</span> <span class='id identifier rubyid_progname'>progname</span><span class='comma'>,</span>
<span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
<span class='op'>**</span><span class='id identifier rubyid_context'>context</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message_hash'>message_hash</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Jan 5 09:59:09 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.0.0).
</div>
</div>
</body>
</html>