-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathconfiguration-logging.html
468 lines (446 loc) · 28.9 KB
/
configuration-logging.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Configure logging | APM Server Reference [7.15] | Elastic</title>
<meta class="elastic" name="content" content="Configure logging | APM Server Reference [7.15]">
<link rel="home" href="index.html" title="APM Server Reference [7.15]"/>
<link rel="up" href="configuring-howto-apm-server.html" title="Configure APM Server"/>
<link rel="prev" href="setup-kibana-endpoint.html" title="Configure the Kibana endpoint"/>
<link rel="next" href="configuring-output.html" title="Configure the output"/>
<meta class="elastic" name="product_version" content="7.15"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/7.15"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.15"/>
<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-v1.css" />
</head>
<!--© 2015-2025 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">
The Elastic APM integration became generally available in 7.16 — see the <a href="https://www.elastic.co/guide/en/apm/guide/current/index.html">APM Guide</a> for updated documentation. Standalone APM Server users can see the <a href="https://www.elastic.co/guide/en/apm/guide/current/legacy-apm-overview.html" title="Legacy APM Overview">Legacy APM Overview</a> and <a href="https://www.elastic.co/guide/en/apm/guide/current/overview.html" title="Legacy APM Server Reference">Legacy APM Server Reference</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="setup-kibana-endpoint.html">« Configure the Kibana endpoint</a>
</span>
<span class="next">
<a href="configuring-output.html">Configure the output »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
<div id="related-products" class="dropdown">
<div class="related-products-title">APM:</div>
<div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
<div class="dropdown-content">
<ul>
<li class="dropdown-category">APM</li>
<ul>
<li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
</ul>
<li class="dropdown-category">APM agents</li>
<ul>
<li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
</ul>
<li class="dropdown-category">APM extensions</li>
<ul>
<li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
<li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
</ul>
</ul>
</div>
</div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="configuring-howto-apm-server.html">Configure APM Server</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Configure logging</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
<strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="configuration-logging"></a>Configure logging</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
</div></div></div>
<p>The <code class="literal">logging</code> section of the <code class="literal">apm-server.yml</code> config file contains options
for configuring the logging output.
The logging system can write logs to the syslog or rotate log files. If logging
is not explicitly configured the file output is used.</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">logging.level: info
logging.to_files: true
logging.files:
path: /var/log/apm-server
name: apm-server
keepfiles: 7
permissions: 0644</pre>
</div>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>In addition to setting logging options in the config file, you can modify
the logging output configuration from the command line. See
<a class="xref" href="command-line-options.html" title="APM Server command reference">Command reference</a>.</p>
</div>
</div>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>When APM Server is running on a Linux system with systemd, it uses
by default the <code class="literal">-e</code> command line option, that makes it write all the logging output
to stderr so it can be captured by journald. Other outputs are disabled. See
<a class="xref" href="running-with-systemd.html" title="APM Server and systemd">APM Server and systemd</a> to know more and learn how to change this.</p>
</div>
</div>
<div class="position-relative"><h3><a id="_configuration_options_3"></a>Configuration options</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>You can specify the following options in the <code class="literal">logging</code> section of the
<code class="literal">apm-server.yml</code> config file:</p>
<div class="position-relative"><h4><a id="_logging_to_stderr"></a><code class="literal">logging.to_stderr</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, writes all logging output to standard error output. This is
equivalent to using the <code class="literal">-e</code> command line option.</p>
<div class="position-relative"><h4><a id="_logging_to_syslog"></a><code class="literal">logging.to_syslog</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, writes all logging output to the syslog.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This option is not supported on Windows.</p>
</div>
</div>
<div class="position-relative"><h4><a id="_logging_to_eventlog"></a><code class="literal">logging.to_eventlog</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, writes all logging output to the Windows Event Log.</p>
<div class="position-relative"><h4><a id="_logging_to_files"></a><code class="literal">logging.to_files</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, writes all logging output to files. The log files are automatically
rotated when the log file size limit is reached.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>APM Server only creates a log file if there is logging output. For
example, if you set the log <a class="xref" href="configuration-logging.html#level" title="logging.level"><code class="literal">level</code></a> to <code class="literal">error</code> and there are no
errors, there will be no log file in the directory specified for logs.</p>
</div>
</div>
<div class="position-relative"><h4><a id="level"></a><code class="literal">logging.level</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>Minimum log level. One of <code class="literal">debug</code>, <code class="literal">info</code>, <code class="literal">warning</code>, or <code class="literal">error</code>. The default
log level is <code class="literal">info</code>.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">debug</code>
</span>
</dt>
<dd>
Logs debug messages, including a detailed printout of all events
flushed. Also logs informational messages, warnings, errors, and
critical errors. When the log level is <code class="literal">debug</code>, you can specify a list of
<a class="xref" href="configuration-logging.html#selectors" title="logging.selectors"><code class="literal">selectors</code></a> to display debug messages for specific components. If
no selectors are specified, the <code class="literal">*</code> selector is used to display debug messages
for all components.
</dd>
<dt>
<span class="term">
<code class="literal">info</code>
</span>
</dt>
<dd>
Logs informational messages, including the number of events that are
published. Also logs any warnings, errors, or critical errors.
</dd>
<dt>
<span class="term">
<code class="literal">warning</code>
</span>
</dt>
<dd>
Logs warnings, errors, and critical errors.
</dd>
<dt>
<span class="term">
<code class="literal">error</code>
</span>
</dt>
<dd>
Logs errors and critical errors.
</dd>
</dl>
</div>
<div class="position-relative"><h4><a id="selectors"></a><code class="literal">logging.selectors</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The list of debugging-only selector tags used by different APM Server components.
Use <code class="literal">*</code> to enable debug output for all components. Use <code class="literal">publisher</code> to display
debug messages related to event publishing.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>The list of available selectors may change between releases, so avoid creating
tests that depend on specific selectors.</p>
<p>To see which selectors are available, run APM Server in debug mode
(set <code class="literal">logging.level: debug</code> in the configuration). The selector name appears
after the log level and is enclosed in brackets.</p>
</div>
</div>
<p>To configure multiple selectors, use the following <a href="/guide/en/beats/libbeat/7.15/config-file-format.html" class="ulink" target="_top">YAML list syntax</a>:</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">logging.selectors: [ harvester, input ]</pre>
</div>
<p>To override selectors at the command line, use the <code class="literal">-d</code> global flag (<code class="literal">-d</code> also
sets the debug log level). For more information, see <a class="xref" href="command-line-options.html" title="APM Server command reference">Command reference</a>.</p>
<div class="position-relative"><h4><a id="_logging_metrics_enabled"></a><code class="literal">logging.metrics.enabled</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>By default, APM Server periodically logs its internal metrics that have
changed in the last period. For each metric that changed, the delta from the
value at the beginning of the period is logged. Also, the total values for all
non-zero internal metrics are logged on shutdown. Set this to false to disable
this behavior. The default is true.</p>
<p>Here is an example log line:</p>
<div class="pre_wrapper lang-shell">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-shell">2017-12-17T19:17:42.667-0500 INFO [metrics] log/log.go:110 Non-zero metrics in the last 30s: beat.info.uptime.ms=30004 beat.memstats.gc_next=5046416</pre>
</div>
<p>Note that we currently offer no backwards compatible guarantees for the internal
metrics and for this reason they are also not documented.</p>
<div class="position-relative"><h4><a id="_logging_metrics_period"></a><code class="literal">logging.metrics.period</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The period after which to log the internal metrics. The default is 30s.</p>
<div class="position-relative"><h4><a id="_logging_files_path"></a><code class="literal">logging.files.path</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The directory that log files are written to. The default is the logs path. See
the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for details.</p>
<div class="position-relative"><h4><a id="_logging_files_name"></a><code class="literal">logging.files.name</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The name of the file that logs are written to. The default is <em>apm-server</em>.</p>
<div class="position-relative"><h4><a id="_logging_files_rotateeverybytes"></a><code class="literal">logging.files.rotateeverybytes</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The maximum size of a log file. If the limit is reached, a new log file is
generated. The default size limit is 10485760 (10 MB).</p>
<div class="position-relative"><h4><a id="_logging_files_keepfiles"></a><code class="literal">logging.files.keepfiles</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The number of most recent rotated log files to keep on disk. Older files are
deleted during log rotation. The default value is 7. The <code class="literal">keepfiles</code> options has
to be in the range of 2 to 1024 files.</p>
<div class="position-relative"><h4><a id="_logging_files_permissions"></a><code class="literal">logging.files.permissions</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The permissions mask to apply when rotating log files. The default value is
0600. The <code class="literal">permissions</code> option must be a valid Unix-style file permissions mask
expressed in octal notation. In Go, numbers in octal notation must start with
<em>0</em>.</p>
<p>Examples:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
0644: give read and write access to the file owner, and read access to all others.
</li>
<li class="listitem">
0600: give read and write access to the file owner, and no access to all others.
</li>
<li class="listitem">
0664: give read and write access to the file owner and members of the group
associated with the file, as well as read access to all other users.
</li>
</ul>
</div>
<div class="position-relative"><h4><a id="_logging_files_interval"></a><code class="literal">logging.files.interval</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>Enable log file rotation on time intervals in addition to size-based rotation.
Intervals must be at least 1s. Values of 1m, 1h, 24h, 7*24h, 30*24h, and 365*24h
are boundary-aligned with minutes, hours, days, weeks, months, and years as
reported by the local system clock. All other intervals are calculated from the
unix epoch. Defaults to disabled.</p>
<div class="position-relative"><h4><a id="_logging_files_rotateonstartup"></a><code class="literal">logging.files.rotateonstartup</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>If the log file already exists on startup, immediately rotate it and start
writing to a new file instead of appending to the existing one. Defaults to
true.</p>
<div class="position-relative"><h4><a id="_logging_json"></a><code class="literal">logging.json</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, logs messages in JSON format. The default is false.</p>
<div class="position-relative"><h4><a id="_logging_ecs"></a><code class="literal">logging.ecs</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, logs messages with minimal required Elastic Common Schema (ECS)
information.</p>
<div class="position-relative"><h4><a id="_logging_files_redirect_stderr"></a><code class="literal">logging.files.redirect_stderr</code> <span class="Admonishment Admonishment--preview">
[<span class="Admonishment-title u-mono">preview</span>]
<span class="Admonishment-detail">
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
</span>
</span></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>When true, diagnostic messages printed to APM Server’s standard error output
will also be logged to the log file. This can be helpful in situations were
APM Server terminates unexpectedly because an error has been detected by
Go’s runtime but diagnostic information is not present in the log file.
This feature is only available when logging to files (<code class="literal">logging.to_files</code> is true).
Disabled by default.</p>
<div class="position-relative"><h3><a id="_logging_format"></a>Logging format</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/copied-from-beats/docs/loggingconfig.asciidoc">edit</a></div>
<p>The logging format is generally the same for each logging output. The one
exception is with the syslog output where the timestamp is not included in the
message because syslog adds its own timestamp.</p>
<p>Each log message consists of the following parts:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Timestamp in ISO8601 format
</li>
<li class="listitem">
Level
</li>
<li class="listitem">
Logger name contained in brackets (Optional)
</li>
<li class="listitem">
File name and line number of the caller
</li>
<li class="listitem">
Message
</li>
<li class="listitem">
Structured data encoded in JSON (Optional)
</li>
</ul>
</div>
<p>Below are some samples:</p>
<p><code class="literal">2017-12-17T18:54:16.241-0500 INFO logp/core_test.go:13 unnamed global logger</code></p>
<p><code class="literal">2017-12-17T18:54:16.242-0500 INFO [example] logp/core_test.go:16 some message</code></p>
<p><code class="literal">2017-12-17T18:54:16.242-0500 INFO [example] logp/core_test.go:19 some message {"x": 1}</code></p>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="setup-kibana-endpoint.html">« Configure the Kibana endpoint</a>
</span>
<span class="next">
<a href="configuring-output.html">Configure the output »</a>
</span>
</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?page=docs&placement=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?page=docs&placement=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?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
<!-- Feedback widget -->
<div id="feedbackWidgetContainer"></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>
<!-- Feedback modal -->
<div id="feedbackModalContainer"></div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs-v1.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>