mr_loga_loga 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/release.yml +2 -2
- data/.gitignore +1 -0
- data/.yardopts +1 -0
- data/CHANGELOG.md +17 -0
- data/Gemfile.lock +7 -3
- data/README.md +4 -4
- data/docs/MrLogaLoga/Configuration.html +376 -0
- data/docs/MrLogaLoga/Context.html +628 -0
- data/docs/MrLogaLoga/Error.html +124 -0
- data/docs/MrLogaLoga/Extensions/LogrageExtension.html +305 -0
- data/docs/MrLogaLoga/Extensions/RailsExtension/LoggerPatch.html +322 -0
- data/docs/MrLogaLoga/Extensions/RailsExtension/ServerPatch.html +201 -0
- data/docs/MrLogaLoga/Extensions/RailsExtension.html +242 -0
- data/docs/MrLogaLoga/Extensions.html +117 -0
- data/docs/MrLogaLoga/Formatters/Json.html +350 -0
- data/docs/MrLogaLoga/Formatters/KeyValue.html +338 -0
- data/docs/MrLogaLoga/Formatters.html +117 -0
- data/docs/MrLogaLoga/InstanceMethods.html +350 -0
- data/docs/MrLogaLoga/Logger.html +618 -0
- data/docs/MrLogaLoga/LoggerProxy.html +319 -0
- data/docs/MrLogaLoga.html +374 -0
- data/docs/_config.yml +1 -0
- data/docs/_index.html +280 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +255 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +255 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +283 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/mr_loga_loga/context.rb +10 -0
- data/lib/mr_loga_loga/extensions/{lograge_patch.rb → lograge.rb} +19 -6
- data/lib/mr_loga_loga/extensions/rails.rb +142 -0
- data/lib/mr_loga_loga/instance_methods.rb +5 -1
- data/lib/mr_loga_loga/logger.rb +3 -5
- data/lib/mr_loga_loga/version.rb +1 -1
- data/lib/mr_loga_loga.rb +3 -3
- data/mr_loga_loga.gemspec +3 -2
- metadata +53 -8
- data/lib/mr_loga_loga/extensions/active_support_logger_patch.rb +0 -94
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: MrLogaLoga::Formatters::Json
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "MrLogaLoga::Formatters::Json";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (J)</a> »
|
|
40
|
+
<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>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Json</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: MrLogaLoga::Formatters::Json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Logger::Formatter</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Logger::Formatter</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">MrLogaLoga::Formatters::Json</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/mr_loga_loga/formatters/json.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<h2 id="label-Description">Description</h2>
|
|
108
|
+
|
|
109
|
+
<p>A simple Json formatter for MrLogaLoga.</p>
|
|
110
|
+
|
|
111
|
+
<h2 id="label-Format">Format</h2>
|
|
112
|
+
|
|
113
|
+
<p>The json formatter renders messages into a single-line json. Context keys are embedded on the top level.</p>
|
|
114
|
+
|
|
115
|
+
<p>Log Format:</p>
|
|
116
|
+
|
|
117
|
+
<pre class="code ruby"><code class="ruby">{ "severity": "Severity", .. "message": "Message", "key1": "Key1" }
|
|
118
|
+
</code></pre>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="tags">
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h2>
|
|
135
|
+
Instance Method Summary
|
|
136
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
137
|
+
</h2>
|
|
138
|
+
|
|
139
|
+
<ul class="summary">
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ String </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
|
159
|
+
<p>Render a log message in JSON.</p>
|
|
160
|
+
</div></span>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</ul>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div id="instance_method_details" class="method_details_list">
|
|
172
|
+
<h2>Instance Method Details</h2>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<div class="method_details first">
|
|
176
|
+
<h3 class="signature first" id="call-instance_method">
|
|
177
|
+
|
|
178
|
+
#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ <tt>String</tt>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</h3><div class="docstring">
|
|
185
|
+
<div class="discussion">
|
|
186
|
+
|
|
187
|
+
<p>Render a log message in JSON</p>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
</div>
|
|
192
|
+
<div class="tags">
|
|
193
|
+
<p class="tag_title">Parameters:</p>
|
|
194
|
+
<ul class="param">
|
|
195
|
+
|
|
196
|
+
<li>
|
|
197
|
+
|
|
198
|
+
<span class='name'>severity</span>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
—
|
|
206
|
+
<div class='inline'>
|
|
207
|
+
<p>The message severity</p>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
<li>
|
|
213
|
+
|
|
214
|
+
<span class='name'>datetime</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class='type'>(<tt>DateTime</tt>)</span>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
—
|
|
222
|
+
<div class='inline'>
|
|
223
|
+
<p>The message date time</p>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
<li>
|
|
229
|
+
|
|
230
|
+
<span class='name'>progname</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<span class='type'>(<tt>DateTime</tt>)</span>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
—
|
|
238
|
+
<div class='inline'>
|
|
239
|
+
<p>The program name</p>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
</li>
|
|
243
|
+
|
|
244
|
+
<li>
|
|
245
|
+
|
|
246
|
+
<span class='name'>message</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
—
|
|
254
|
+
<div class='inline'>
|
|
255
|
+
<p>The log message</p>
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
<li>
|
|
261
|
+
|
|
262
|
+
<span class='name'>context</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
—
|
|
270
|
+
<div class='inline'>
|
|
271
|
+
<p>The log message context</p>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
</ul>
|
|
277
|
+
|
|
278
|
+
<p class="tag_title">Returns:</p>
|
|
279
|
+
<ul class="return">
|
|
280
|
+
|
|
281
|
+
<li>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
—
|
|
289
|
+
<div class='inline'>
|
|
290
|
+
<p>the formatted log message</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
</div><table class="source_code">
|
|
298
|
+
<tr>
|
|
299
|
+
<td>
|
|
300
|
+
<pre class="lines">
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
27
|
|
304
|
+
28
|
|
305
|
+
29
|
|
306
|
+
30
|
|
307
|
+
31
|
|
308
|
+
32
|
|
309
|
+
33
|
|
310
|
+
34
|
|
311
|
+
35
|
|
312
|
+
36
|
|
313
|
+
37
|
|
314
|
+
38
|
|
315
|
+
39</pre>
|
|
316
|
+
</td>
|
|
317
|
+
<td>
|
|
318
|
+
<pre class="code"><span class="info file"># File 'lib/mr_loga_loga/formatters/json.rb', line 27</span>
|
|
319
|
+
|
|
320
|
+
<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>
|
|
321
|
+
<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>
|
|
322
|
+
|
|
323
|
+
<span class='id identifier rubyid_message_hash'>message_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
324
|
+
<span class='label'>severity:</span> <span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span>
|
|
325
|
+
<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>
|
|
326
|
+
<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>
|
|
327
|
+
<span class='label'>progname:</span> <span class='id identifier rubyid_progname'>progname</span><span class='comma'>,</span>
|
|
328
|
+
<span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
|
|
329
|
+
<span class='op'>**</span><span class='id identifier rubyid_context'>context</span>
|
|
330
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
|
|
331
|
+
<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>
|
|
332
|
+
<span class='kw'>end</span></pre>
|
|
333
|
+
</td>
|
|
334
|
+
</tr>
|
|
335
|
+
</table>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
</div>
|
|
339
|
+
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
<div id="footer">
|
|
343
|
+
Generated on Wed Jan 5 09:59:09 2022 by
|
|
344
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
345
|
+
0.9.27 (ruby-3.0.0).
|
|
346
|
+
</div>
|
|
347
|
+
|
|
348
|
+
</div>
|
|
349
|
+
</body>
|
|
350
|
+
</html>
|
|
@@ -0,0 +1,338 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: MrLogaLoga::Formatters::KeyValue
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "MrLogaLoga::Formatters::KeyValue";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (K)</a> »
|
|
40
|
+
<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>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">KeyValue</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: MrLogaLoga::Formatters::KeyValue
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Logger::Formatter</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Logger::Formatter</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">MrLogaLoga::Formatters::KeyValue</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/mr_loga_loga/formatters/key_value.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<h2 id="label-Description">Description</h2>
|
|
108
|
+
|
|
109
|
+
<p>A simple key value formatter that extends the standard formatter by rendering additional contextual information.</p>
|
|
110
|
+
|
|
111
|
+
<h2 id="label-Format">Format</h2>
|
|
112
|
+
|
|
113
|
+
<p>The key-value formatter renders messages into the following format:</p>
|
|
114
|
+
|
|
115
|
+
<p>Log format:</p>
|
|
116
|
+
|
|
117
|
+
<pre class="code ruby"><code class="ruby">SeverityID, [DateTime #pid] SeverityLabel -- ProgName: message key1=value1 key2=value2
|
|
118
|
+
</code></pre>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="tags">
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h2>
|
|
135
|
+
Instance Method Summary
|
|
136
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
137
|
+
</h2>
|
|
138
|
+
|
|
139
|
+
<ul class="summary">
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ String </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
|
159
|
+
<p>Render a log message.</p>
|
|
160
|
+
</div></span>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</ul>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div id="instance_method_details" class="method_details_list">
|
|
172
|
+
<h2>Instance Method Details</h2>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<div class="method_details first">
|
|
176
|
+
<h3 class="signature first" id="call-instance_method">
|
|
177
|
+
|
|
178
|
+
#<strong>call</strong>(severity, datetime, progname, message, **context) ⇒ <tt>String</tt>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</h3><div class="docstring">
|
|
185
|
+
<div class="discussion">
|
|
186
|
+
|
|
187
|
+
<p>Render a log message</p>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
</div>
|
|
192
|
+
<div class="tags">
|
|
193
|
+
<p class="tag_title">Parameters:</p>
|
|
194
|
+
<ul class="param">
|
|
195
|
+
|
|
196
|
+
<li>
|
|
197
|
+
|
|
198
|
+
<span class='name'>severity</span>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
—
|
|
206
|
+
<div class='inline'>
|
|
207
|
+
<p>The message severity</p>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
<li>
|
|
213
|
+
|
|
214
|
+
<span class='name'>datetime</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class='type'>(<tt>DateTime</tt>)</span>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
—
|
|
222
|
+
<div class='inline'>
|
|
223
|
+
<p>The message date time</p>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
<li>
|
|
229
|
+
|
|
230
|
+
<span class='name'>progname</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<span class='type'>(<tt>DateTime</tt>)</span>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
—
|
|
238
|
+
<div class='inline'>
|
|
239
|
+
<p>The program name</p>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
</li>
|
|
243
|
+
|
|
244
|
+
<li>
|
|
245
|
+
|
|
246
|
+
<span class='name'>message</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
—
|
|
254
|
+
<div class='inline'>
|
|
255
|
+
<p>The log message</p>
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
<li>
|
|
261
|
+
|
|
262
|
+
<span class='name'>context</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
—
|
|
270
|
+
<div class='inline'>
|
|
271
|
+
<p>The log message context</p>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
</ul>
|
|
277
|
+
|
|
278
|
+
<p class="tag_title">Returns:</p>
|
|
279
|
+
<ul class="return">
|
|
280
|
+
|
|
281
|
+
<li>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
—
|
|
289
|
+
<div class='inline'>
|
|
290
|
+
<p>the formatted log message</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
</div><table class="source_code">
|
|
298
|
+
<tr>
|
|
299
|
+
<td>
|
|
300
|
+
<pre class="lines">
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
27
|
|
304
|
+
28
|
|
305
|
+
29
|
|
306
|
+
30
|
|
307
|
+
31
|
|
308
|
+
32
|
|
309
|
+
33</pre>
|
|
310
|
+
</td>
|
|
311
|
+
<td>
|
|
312
|
+
<pre class="code"><span class="info file"># File 'lib/mr_loga_loga/formatters/key_value.rb', line 27</span>
|
|
313
|
+
|
|
314
|
+
<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>
|
|
315
|
+
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
|
316
|
+
<span class='period'>.</span><span class='id identifier rubyid_prepend'>prepend</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
317
|
+
<span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
|
|
318
|
+
<span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
319
|
+
<span class='kw'>super</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='rparen'>)</span>
|
|
320
|
+
<span class='kw'>end</span></pre>
|
|
321
|
+
</td>
|
|
322
|
+
</tr>
|
|
323
|
+
</table>
|
|
324
|
+
</div>
|
|
325
|
+
|
|
326
|
+
</div>
|
|
327
|
+
|
|
328
|
+
</div>
|
|
329
|
+
|
|
330
|
+
<div id="footer">
|
|
331
|
+
Generated on Wed Jan 5 09:59:09 2022 by
|
|
332
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
333
|
+
0.9.27 (ruby-3.0.0).
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
</body>
|
|
338
|
+
</html>
|