forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugins-codecs-multiline.html
609 lines (576 loc) · 38.2 KB
/
plugins-codecs-multiline.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>multiline | Logstash Reference [5.3] | Elastic</title>
<meta class="elastic" name="content" content="multiline | Logstash Reference [5.3]">
<link rel="home" href="index.html" title="Logstash Reference [5.3]"/>
<link rel="up" href="codec-plugins.html" title="Codec plugins"/>
<link rel="prev" href="plugins-codecs-msgpack.html" title="msgpack"/>
<link rel="next" href="plugins-codecs-netflow.html" title="netflow"/>
<meta class="elastic" name="product_version" content="5.3"/>
<meta class="elastic" name="product_name" content="Logstash"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Logstash/Reference/5.3"/>
<meta name="DC.subject" content="Logstash"/>
<meta name="DC.identifier" content="5.3"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles.css" />
</head>
<!--© 2015-2022 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Logstash Reference [5.3]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="codec-plugins.html">Codec plugins</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="plugins-codecs-msgpack.html">« msgpack</a>
</span>
<span class="next">
<a href="plugins-codecs-netflow.html">netflow »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="plugins-codecs-multiline"></a>multiline<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h2>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Version: 3.0.3
</li>
<li class="listitem">
Released on: September 15, 2016
</li>
<li class="listitem">
<a href="https://github.com/logstash-plugins/logstash-codec-multiline/blob/master/CHANGELOG.md#303" class="ulink" target="_top">Changelog</a>
</li>
</ul>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_getting_help_93"></a>Getting Help<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h3>
</div></div></div>
<p>For questions about the plugin, open a topic in the <a href="http://discuss.elastic.co" class="ulink" target="_top">Discuss</a> forums. For bugs or feature requests, open an issue in <a href="https://github.com/elastic/logstash" class="ulink" target="_top">Github</a>.
For the list of Elastic supported plugins, please consult the <a href="/support/matrix#show_logstash_plugins" class="ulink" target="_top">Elastic Support Matrix</a>.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_description_94"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h3>
</div></div></div>
<p>The multiline codec will collapse multiline messages and merge them into a
single event.</p>
<p>The original goal of this codec was to allow joining of multiline messages
from files into a single event. For example, joining Java exception and
stacktrace messages into a single event.</p>
<p>The config looks like this:</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> input {
stdin {
codec => multiline {
pattern => "pattern, a regexp"
negate => "true" or "false"
what => "previous" or "next"
}
}
}</pre>
</div>
<p>The <code class="literal">pattern</code> should match what you believe to be an indicator that the field
is part of a multi-line event.</p>
<p>The <code class="literal">what</code> must be <code class="literal">previous</code> or <code class="literal">next</code> and indicates the relation
to the multi-line event.</p>
<p>The <code class="literal">negate</code> can be <code class="literal">true</code> or <code class="literal">false</code> (defaults to <code class="literal">false</code>). If <code class="literal">true</code>, a
message not matching the pattern will constitute a match of the multiline
filter and the <code class="literal">what</code> will be applied. (vice-versa is also true)</p>
<p>For example, Java stack traces are multiline and usually have the message
starting at the far-left, with each subsequent line indented. Do this:</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> input {
stdin {
codec => multiline {
pattern => "^\s"
what => "previous"
}
}
}</pre>
</div>
<p>This says that any line starting with whitespace belongs to the previous line.</p>
<p>Another example is to merge lines not starting with a date up to the previous
line..</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> input {
file {
path => "/var/log/someapp.log"
codec => multiline {
# Grok pattern names are valid! :)
pattern => "^%{TIMESTAMP_ISO8601} "
negate => true
what => previous
}
}
}</pre>
</div>
<p>This says that any line not starting with a timestamp should be merged with the previous line.</p>
<p>One more common example is C line continuations (backslash). Here’s how to do that:</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> filter {
multiline {
type => "somefiletype"
pattern => "\\$"
what => "next"
}
}</pre>
</div>
<p>This says that any line ending with a backslash should be combined with the
following line.</p>
<p> </p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_synopsis_175"></a>Synopsis<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h3>
</div></div></div>
<p>This plugin supports the following configuration options:</p>
<p>Required configuration options:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">multiline {
pattern => ...
what => ...
}</pre>
</div>
<p>Available configuration options:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1"/>
<col class="col_2"/>
<col class="col_3"/>
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Setting</th>
<th align="left" valign="top">Input type</th>
<th align="left" valign="top">Required</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-auto_flush_interval" title="auto_flush_interval"><code class="literal">auto_flush_interval</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#number" title="Number">number</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-charset" title="charset"><code class="literal">charset</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#string" title="String">string</a>, one of <code class="literal">["ASCII-8BIT", "UTF-8", "US-ASCII", "Big5", "Big5-HKSCS", "Big5-UAO", "CP949", "Emacs-Mule", "EUC-JP", "EUC-KR", "EUC-TW", "GB2312", "GB18030", "GBK", "ISO-8859-1", "ISO-8859-2", "ISO-8859-3", "ISO-8859-4", "ISO-8859-5", "ISO-8859-6", "ISO-8859-7", "ISO-8859-8", "ISO-8859-9", "ISO-8859-10", "ISO-8859-11", "ISO-8859-13", "ISO-8859-14", "ISO-8859-15", "ISO-8859-16", "KOI8-R", "KOI8-U", "Shift_JIS", "UTF-16BE", "UTF-16LE", "UTF-32BE", "UTF-32LE", "Windows-31J", "Windows-1250", "Windows-1251", "Windows-1252", "IBM437", "IBM737", "IBM775", "CP850", "IBM852", "CP852", "IBM855", "CP855", "IBM857", "IBM860", "IBM861", "IBM862", "IBM863", "IBM864", "IBM865", "IBM866", "IBM869", "Windows-1258", "GB1988", "macCentEuro", "macCroatian", "macCyrillic", "macGreek", "macIceland", "macRoman", "macRomania", "macThai", "macTurkish", "macUkraine", "CP950", "CP951", "IBM037", "stateless-ISO-2022-JP", "eucJP-ms", "CP51932", "EUC-JIS-2004", "GB12345", "ISO-2022-JP", "ISO-2022-JP-2", "CP50220", "CP50221", "Windows-1256", "Windows-1253", "Windows-1255", "Windows-1254", "TIS-620", "Windows-874", "Windows-1257", "MacJapanese", "UTF-7", "UTF8-MAC", "UTF-16", "UTF-32", "UTF8-DoCoMo", "SJIS-DoCoMo", "UTF8-KDDI", "SJIS-KDDI", "ISO-2022-JP-KDDI", "stateless-ISO-2022-JP-KDDI", "UTF8-SoftBank", "SJIS-SoftBank", "BINARY", "CP437", "CP737", "CP775", "IBM850", "CP857", "CP860", "CP861", "CP862", "CP863", "CP864", "CP865", "CP866", "CP869", "CP1258", "Big5-HKSCS:2008", "ebcdic-cp-us", "eucJP", "euc-jp-ms", "EUC-JISX0213", "eucKR", "eucTW", "EUC-CN", "eucCN", "CP936", "ISO2022-JP", "ISO2022-JP2", "ISO8859-1", "ISO8859-2", "ISO8859-3", "ISO8859-4", "ISO8859-5", "ISO8859-6", "CP1256", "ISO8859-7", "CP1253", "ISO8859-8", "CP1255", "ISO8859-9", "CP1254", "ISO8859-10", "ISO8859-11", "CP874", "ISO8859-13", "CP1257", "ISO8859-14", "ISO8859-15", "ISO8859-16", "CP878", "MacJapan", "ASCII", "ANSI_X3.4-1968", "646", "CP65000", "CP65001", "UTF-8-MAC", "UTF-8-HFS", "UCS-2BE", "UCS-4BE", "UCS-4LE", "CP932", "csWindows31J", "SJIS", "PCK", "CP1250", "CP1251", "CP1252", "external", "locale"]</code></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-enable_metric" title="enable_metric"><code class="literal">enable_metric</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#boolean" title="Boolean">boolean</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-id" title="id"><code class="literal">id</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#string" title="String">string</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-max_bytes" title="max_bytes"><code class="literal">max_bytes</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#bytes" title="Bytes">bytes</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-max_lines" title="max_lines"><code class="literal">max_lines</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#number" title="Number">number</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-multiline_tag" title="multiline_tag"><code class="literal">multiline_tag</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#string" title="String">string</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-negate" title="negate"><code class="literal">negate</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#boolean" title="Boolean">boolean</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-pattern" title="pattern"><code class="literal">pattern</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#string" title="String">string</a></p></td>
<td align="left" valign="top"><p>Yes</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-patterns_dir" title="patterns_dir"><code class="literal">patterns_dir</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#array" title="Array">array</a></p></td>
<td align="left" valign="top"><p>No</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><a class="xref" href="plugins-codecs-multiline.html#plugins-codecs-multiline-what" title="what"><code class="literal">what</code></a></p></td>
<td align="left" valign="top"><p><a class="xref" href="configuration-file-structure.html#string" title="String">string</a>, one of <code class="literal">["previous", "next"]</code></p></td>
<td align="left" valign="top"><p>Yes</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_details_176"></a>Details<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h3>
</div></div></div>
<p> </p>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-auto_flush_interval"></a><code class="literal">auto_flush_interval</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#number" title="Number">number</a>
</li>
<li class="listitem">
There is no default value for this setting.
</li>
</ul>
</div>
<p>The accumulation of multiple lines will be converted to an event when either a
matching new line is seen or there has been no new data appended for this time
auto_flush_interval. No default. If unset, no auto_flush. Units: seconds</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-charset"></a><code class="literal">charset</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value can be any of: <code class="literal">ASCII-8BIT</code>, <code class="literal">UTF-8</code>, <code class="literal">US-ASCII</code>, <code class="literal">Big5</code>, <code class="literal">Big5-HKSCS</code>, <code class="literal">Big5-UAO</code>, <code class="literal">CP949</code>, <code class="literal">Emacs-Mule</code>, <code class="literal">EUC-JP</code>, <code class="literal">EUC-KR</code>, <code class="literal">EUC-TW</code>, <code class="literal">GB2312</code>, <code class="literal">GB18030</code>, <code class="literal">GBK</code>, <code class="literal">ISO-8859-1</code>, <code class="literal">ISO-8859-2</code>, <code class="literal">ISO-8859-3</code>, <code class="literal">ISO-8859-4</code>, <code class="literal">ISO-8859-5</code>, <code class="literal">ISO-8859-6</code>, <code class="literal">ISO-8859-7</code>, <code class="literal">ISO-8859-8</code>, <code class="literal">ISO-8859-9</code>, <code class="literal">ISO-8859-10</code>, <code class="literal">ISO-8859-11</code>, <code class="literal">ISO-8859-13</code>, <code class="literal">ISO-8859-14</code>, <code class="literal">ISO-8859-15</code>, <code class="literal">ISO-8859-16</code>, <code class="literal">KOI8-R</code>, <code class="literal">KOI8-U</code>, <code class="literal">Shift_JIS</code>, <code class="literal">UTF-16BE</code>, <code class="literal">UTF-16LE</code>, <code class="literal">UTF-32BE</code>, <code class="literal">UTF-32LE</code>, <code class="literal">Windows-31J</code>, <code class="literal">Windows-1250</code>, <code class="literal">Windows-1251</code>, <code class="literal">Windows-1252</code>, <code class="literal">IBM437</code>, <code class="literal">IBM737</code>, <code class="literal">IBM775</code>, <code class="literal">CP850</code>, <code class="literal">IBM852</code>, <code class="literal">CP852</code>, <code class="literal">IBM855</code>, <code class="literal">CP855</code>, <code class="literal">IBM857</code>, <code class="literal">IBM860</code>, <code class="literal">IBM861</code>, <code class="literal">IBM862</code>, <code class="literal">IBM863</code>, <code class="literal">IBM864</code>, <code class="literal">IBM865</code>, <code class="literal">IBM866</code>, <code class="literal">IBM869</code>, <code class="literal">Windows-1258</code>, <code class="literal">GB1988</code>, <code class="literal">macCentEuro</code>, <code class="literal">macCroatian</code>, <code class="literal">macCyrillic</code>, <code class="literal">macGreek</code>, <code class="literal">macIceland</code>, <code class="literal">macRoman</code>, <code class="literal">macRomania</code>, <code class="literal">macThai</code>, <code class="literal">macTurkish</code>, <code class="literal">macUkraine</code>, <code class="literal">CP950</code>, <code class="literal">CP951</code>, <code class="literal">IBM037</code>, <code class="literal">stateless-ISO-2022-JP</code>, <code class="literal">eucJP-ms</code>, <code class="literal">CP51932</code>, <code class="literal">EUC-JIS-2004</code>, <code class="literal">GB12345</code>, <code class="literal">ISO-2022-JP</code>, <code class="literal">ISO-2022-JP-2</code>, <code class="literal">CP50220</code>, <code class="literal">CP50221</code>, <code class="literal">Windows-1256</code>, <code class="literal">Windows-1253</code>, <code class="literal">Windows-1255</code>, <code class="literal">Windows-1254</code>, <code class="literal">TIS-620</code>, <code class="literal">Windows-874</code>, <code class="literal">Windows-1257</code>, <code class="literal">MacJapanese</code>, <code class="literal">UTF-7</code>, <code class="literal">UTF8-MAC</code>, <code class="literal">UTF-16</code>, <code class="literal">UTF-32</code>, <code class="literal">UTF8-DoCoMo</code>, <code class="literal">SJIS-DoCoMo</code>, <code class="literal">UTF8-KDDI</code>, <code class="literal">SJIS-KDDI</code>, <code class="literal">ISO-2022-JP-KDDI</code>, <code class="literal">stateless-ISO-2022-JP-KDDI</code>, <code class="literal">UTF8-SoftBank</code>, <code class="literal">SJIS-SoftBank</code>, <code class="literal">BINARY</code>, <code class="literal">CP437</code>, <code class="literal">CP737</code>, <code class="literal">CP775</code>, <code class="literal">IBM850</code>, <code class="literal">CP857</code>, <code class="literal">CP860</code>, <code class="literal">CP861</code>, <code class="literal">CP862</code>, <code class="literal">CP863</code>, <code class="literal">CP864</code>, <code class="literal">CP865</code>, <code class="literal">CP866</code>, <code class="literal">CP869</code>, <code class="literal">CP1258</code>, <code class="literal">Big5-HKSCS:2008</code>, <code class="literal">ebcdic-cp-us</code>, <code class="literal">eucJP</code>, <code class="literal">euc-jp-ms</code>, <code class="literal">EUC-JISX0213</code>, <code class="literal">eucKR</code>, <code class="literal">eucTW</code>, <code class="literal">EUC-CN</code>, <code class="literal">eucCN</code>, <code class="literal">CP936</code>, <code class="literal">ISO2022-JP</code>, <code class="literal">ISO2022-JP2</code>, <code class="literal">ISO8859-1</code>, <code class="literal">ISO8859-2</code>, <code class="literal">ISO8859-3</code>, <code class="literal">ISO8859-4</code>, <code class="literal">ISO8859-5</code>, <code class="literal">ISO8859-6</code>, <code class="literal">CP1256</code>, <code class="literal">ISO8859-7</code>, <code class="literal">CP1253</code>, <code class="literal">ISO8859-8</code>, <code class="literal">CP1255</code>, <code class="literal">ISO8859-9</code>, <code class="literal">CP1254</code>, <code class="literal">ISO8859-10</code>, <code class="literal">ISO8859-11</code>, <code class="literal">CP874</code>, <code class="literal">ISO8859-13</code>, <code class="literal">CP1257</code>, <code class="literal">ISO8859-14</code>, <code class="literal">ISO8859-15</code>, <code class="literal">ISO8859-16</code>, <code class="literal">CP878</code>, <code class="literal">MacJapan</code>, <code class="literal">ASCII</code>, <code class="literal">ANSI_X3.4-1968</code>, <code class="literal">646</code>, <code class="literal">CP65000</code>, <code class="literal">CP65001</code>, <code class="literal">UTF-8-MAC</code>, <code class="literal">UTF-8-HFS</code>, <code class="literal">UCS-2BE</code>, <code class="literal">UCS-4BE</code>, <code class="literal">UCS-4LE</code>, <code class="literal">CP932</code>, <code class="literal">csWindows31J</code>, <code class="literal">SJIS</code>, <code class="literal">PCK</code>, <code class="literal">CP1250</code>, <code class="literal">CP1251</code>, <code class="literal">CP1252</code>, <code class="literal">external</code>, <code class="literal">locale</code>
</li>
<li class="listitem">
Default value is <code class="literal">"UTF-8"</code>
</li>
</ul>
</div>
<p>The character encoding used in this input. Examples include <code class="literal">UTF-8</code>
and <code class="literal">cp1252</code></p>
<p>This setting is useful if your log files are in <code class="literal">Latin-1</code> (aka <code class="literal">cp1252</code>)
or in another character set other than <code class="literal">UTF-8</code>.</p>
<p>This only affects "plain" format logs since JSON is <code class="literal">UTF-8</code> already.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-enable_metric"></a><code class="literal">enable_metric</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#boolean" title="Boolean">boolean</a>
</li>
<li class="listitem">
Default value is <code class="literal">true</code>
</li>
</ul>
</div>
<p>Disable or enable metric logging for this specific plugin instance
by default we record all the metrics we can, but you can disable metrics collection
for a specific plugin.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-id"></a><code class="literal">id</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#string" title="String">string</a>
</li>
<li class="listitem">
There is no default value for this setting.
</li>
</ul>
</div>
<p>Add a unique <code class="literal">ID</code> to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type, for example, if you have 2 grok filters.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby">output {
stdout {
id => "my_plugin_id"
}
}</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-max_bytes"></a><code class="literal">max_bytes</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#bytes" title="Bytes">bytes</a>
</li>
<li class="listitem">
Default value is <code class="literal">"10 MiB"</code>
</li>
</ul>
</div>
<p>The accumulation of events can make logstash exit with an out of memory error
if event boundaries are not correctly defined. This settings make sure to flush
multiline events after reaching a number of bytes, it is used in combination
max_lines.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-max_lines"></a><code class="literal">max_lines</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#number" title="Number">number</a>
</li>
<li class="listitem">
Default value is <code class="literal">500</code>
</li>
</ul>
</div>
<p>The accumulation of events can make logstash exit with an out of memory error
if event boundaries are not correctly defined. This settings make sure to flush
multiline events after reaching a number of lines, it is used in combination
max_bytes.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-multiline_tag"></a><code class="literal">multiline_tag</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#string" title="String">string</a>
</li>
<li class="listitem">
Default value is <code class="literal">"multiline"</code>
</li>
</ul>
</div>
<p>Tag multiline events with a given tag. This tag will only be added
to events that actually have multiple lines in them.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-negate"></a><code class="literal">negate</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#boolean" title="Boolean">boolean</a>
</li>
<li class="listitem">
Default value is <code class="literal">false</code>
</li>
</ul>
</div>
<p>Negate the regexp pattern (<em>if not matched</em>).</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-pattern"></a><code class="literal">pattern</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
This is a required setting.
</li>
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#string" title="String">string</a>
</li>
<li class="listitem">
There is no default value for this setting.
</li>
</ul>
</div>
<p>The regular expression to match.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-patterns_dir"></a><code class="literal">patterns_dir</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Value type is <a class="xref" href="configuration-file-structure.html#array" title="Array">array</a>
</li>
<li class="listitem">
Default value is <code class="literal">[]</code>
</li>
</ul>
</div>
<p>Logstash ships by default with a bunch of patterns, so you don’t
necessarily need to define this yourself unless you are adding additional
patterns.</p>
<p>Pattern files are plain text with format:</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> NAME PATTERN</pre>
</div>
<p>For example:</p>
<div class="pre_wrapper lang-ruby">
<pre class="programlisting prettyprint lang-ruby"> NUMBER \d+</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="plugins-codecs-multiline-what"></a><code class="literal">what</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/logstash-plugins/logstash-codec-multiline/edit/master/docs/index.asciidoc">edit</a></h4>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
This is a required setting.
</li>
<li class="listitem">
Value can be any of: <code class="literal">previous</code>, <code class="literal">next</code>
</li>
<li class="listitem">
There is no default value for this setting.
</li>
</ul>
</div>
<p>If the pattern matched, does event belong to the next or previous event?</p>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="plugins-codecs-msgpack.html">« msgpack</a>
</span>
<span class="next">
<a href="plugins-codecs-netflow.html">netflow »</a>
</span>
</div>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>