forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmultiline.html
325 lines (303 loc) · 17.2 KB
/
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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Managing Multiline Events | Logstash Reference [7.0] | Elastic</title>
<meta class="elastic" name="content" content="Managing Multiline Events | Logstash Reference [7.0]">
<link rel="home" href="index.html" title="Logstash Reference [7.0]"/>
<link rel="up" href="configuration.html" title="Configuring Logstash"/>
<link rel="prev" href="reloading-config.html" title="Reloading the Config File"/>
<link rel="next" href="glob-support.html" title="Glob Pattern Support"/>
<meta class="elastic" name="product_version" content="7.0"/>
<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/7.0"/>
<meta name="DC.subject" content="Logstash"/>
<meta name="DC.identifier" content="7.0"/>
<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 [7.0]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="configuration.html">Configuring Logstash</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="reloading-config.html">« Reloading the Config File</a>
</span>
<span class="next">
<a href="glob-support.html">Glob Pattern Support »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="multiline"></a>Managing Multiline Events<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/7.0/docs/static/managing-multiline-events.asciidoc">edit</a></h2>
</div></div></div>
<p>Several use cases generate events that span multiple lines of text. In order to correctly handle these multiline events,
Logstash needs to know how to tell which lines are part of a single event.</p>
<p>Multiline event processing is complex and relies on proper event ordering. The best way to guarantee ordered log
processing is to implement the processing as early in the pipeline as possible.</p>
<p>The <a class="xref" href="plugins-codecs-multiline.html" title="Multiline codec plugin">multiline</a> codec is the preferred tool for handling multiline events
in the Logstash pipeline. The multiline codec merges lines from a single input using
a simple set of rules.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>If you are using a Logstash input plugin that supports multiple hosts, such as
the <a class="xref" href="plugins-inputs-beats.html" title="Beats input plugin">beats</a> input plugin, you should not use the
<a class="xref" href="plugins-codecs-multiline.html" title="Multiline codec plugin">multiline</a> codec to handle multiline events. Doing so may result in the
mixing of streams and corrupted event data. In this situation, you need to handle multiline
events before sending the event data to Logstash.</p>
</div>
</div>
<p>The most important aspects of configuring the multiline codec are the following:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The <code class="literal">pattern</code> option specifies a regular expression. Lines that match the specified regular expression are considered
either continuations of a previous line or the start of a new multiline event. You can use
<a href="/guide/en/logstash/7.0/plugins-filters-grok.html" class="ulink" target="_top">grok</a> regular expression templates with this configuration option.
</li>
<li class="listitem">
The <code class="literal">what</code> option takes two values: <code class="literal">previous</code> or <code class="literal">next</code>. The <code class="literal">previous</code> value specifies that lines that match the
value in the <code class="literal">pattern</code> option are part of the previous line. The <code class="literal">next</code> value specifies that lines that match the value
in the <code class="literal">pattern</code> option are part of the following line.* The <code class="literal">negate</code> option applies the multiline codec to lines that
<em>do not</em> match the regular expression specified in the <code class="literal">pattern</code> option.
</li>
</ul>
</div>
<p>See the full documentation for the <a class="xref" href="plugins-codecs-multiline.html" title="Multiline codec plugin">multiline</a> codec plugin for more information
on configuration options.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_examples_of_multiline_codec_configuration"></a>Examples of Multiline Codec Configuration<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/7.0/docs/static/managing-multiline-events.asciidoc">edit</a></h3>
</div></div></div>
<p>The examples in this section cover the following use cases:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Combining a Java stack trace into a single event
</li>
<li class="listitem">
Combining C-style line continuations into a single event
</li>
<li class="listitem">
Combining multiple lines from time-stamped events
</li>
</ul>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_java_stack_traces"></a>Java Stack Traces<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/7.0/docs/static/managing-multiline-events.asciidoc">edit</a></h4>
</div></div></div>
<p>Java stack traces consist of multiple lines, with each line after the initial line beginning with whitespace, as in
this example:</p>
<div class="pre_wrapper lang-java">
<pre class="programlisting prettyprint lang-java">Exception in thread "main" java.lang.NullPointerException
at com.example.myproject.Book.getTitle(Book.java:16)
at com.example.myproject.Author.getBookTitles(Author.java:25)
at com.example.myproject.Bootstrap.main(Bootstrap.java:14)</pre>
</div>
<p>To consolidate these lines into a single event in Logstash, use the following configuration for the multiline codec:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">input {
stdin {
codec => multiline {
pattern => "^\s"
what => "previous"
}
}
}</pre>
</div>
<p>This configuration merges any line that begins with whitespace up to the previous line.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_line_continuations"></a>Line Continuations<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/7.0/docs/static/managing-multiline-events.asciidoc">edit</a></h4>
</div></div></div>
<p>Several programming languages use the <code class="literal">\</code> character at the end of a line to denote that the line continues, as in this
example:</p>
<div class="pre_wrapper lang-c">
<pre class="programlisting prettyprint lang-c">printf ("%10.10ld \t %10.10ld \t %s\
%f", w, x, y, z );</pre>
</div>
<p>To consolidate these lines into a single event in Logstash, use the following configuration for the multiline codec:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">input {
stdin {
codec => multiline {
pattern => "\\$"
what => "next"
}
}
}</pre>
</div>
<p>This configuration merges any line that ends with the <code class="literal">\</code> character with the following line.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_timestamps"></a>Timestamps<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/7.0/docs/static/managing-multiline-events.asciidoc">edit</a></h4>
</div></div></div>
<p>Activity logs from services such as Elasticsearch typically begin with a timestamp, followed by information on the
specific activity, as in this example:</p>
<div class="pre_wrapper lang-shell">
<pre class="programlisting prettyprint lang-shell">[2015-08-24 11:49:14,389][INFO ][env ] [Letha] using [1] data paths, mounts [[/
(/dev/disk1)]], net usable_space [34.5gb], net total_space [118.9gb], types [hfs]</pre>
</div>
<p>To consolidate these lines into a single event in Logstash, use the following configuration for the multiline codec:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">input {
file {
path => "/var/log/someapp.log"
codec => multiline {
pattern => "^%{TIMESTAMP_ISO8601} "
negate => true
what => previous
}
}
}</pre>
</div>
<p>This configuration uses the <code class="literal">negate</code> option to specify that any line that does not begin with a timestamp belongs to
the previous line.</p>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="reloading-config.html">« Reloading the Config File</a>
</span>
<span class="next">
<a href="glob-support.html">Glob Pattern Support »</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>