forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig-setting-files.html
266 lines (246 loc) · 14.5 KB
/
config-setting-files.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Logstash Configuration Files | Logstash Reference [7.1] | Elastic</title>
<meta class="elastic" name="content" content="Logstash Configuration Files | Logstash Reference [7.1]">
<link rel="home" href="index.html" title="Logstash Reference [7.1]"/>
<link rel="up" href="setup-logstash.html" title="Setting Up and Running Logstash"/>
<link rel="prev" href="dir-layout.html" title="Logstash Directory Layout"/>
<link rel="next" href="logstash-settings-file.html" title="logstash.yml"/>
<meta class="elastic" name="product_version" content="7.1"/>
<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.1"/>
<meta name="DC.subject" content="Logstash"/>
<meta name="DC.identifier" content="7.1"/>
<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.1]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="setup-logstash.html">Setting Up and Running Logstash</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="dir-layout.html">« Logstash Directory Layout</a>
</span>
<span class="next">
<a href="logstash-settings-file.html">logstash.yml »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="config-setting-files"></a>Logstash Configuration Files<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.1/docs/static/setting-up-logstash.asciidoc">edit</a></h2>
</div></div></div>
<p>Logstash has two types of configuration files: <em>pipeline configuration files</em>, which define the Logstash processing
pipeline, and <em>settings files</em>, which specify options that control Logstash startup and execution.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_pipeline_configuration_files"></a>Pipeline Configuration Files<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.1/docs/static/setting-up-logstash.asciidoc">edit</a></h3>
</div></div></div>
<p>You create pipeline configuration files when you define the stages of your Logstash processing pipeline. On deb and
rpm, you place the pipeline configuration files in the <code class="literal">/etc/logstash/conf.d</code> directory. Logstash tries to load only
files with <code class="literal">.conf</code> extension in the <code class="literal">/etc/logstash/conf.d directory</code> and ignores all other files.</p>
<p>See <a class="xref" href="configuration.html" title="Configuring Logstash"><em>Configuring Logstash</em></a> for more info.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_settings_files"></a>Settings Files<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.1/docs/static/setting-up-logstash.asciidoc">edit</a></h3>
</div></div></div>
<p>The settings files are already defined in the Logstash installation. Logstash includes the following settings files:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">logstash.yml</code></strong></span>
</span>
</dt>
<dd>
Contains Logstash configuration flags. You can set flags in this file instead of passing the flags at the command
line. Any flags that you set at the command line override the corresponding settings in the <code class="literal">logstash.yml</code> file. See <a class="xref" href="logstash-settings-file.html" title="logstash.yml">logstash.yml</a> for more info.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pipelines.yml</code></strong></span>
</span>
</dt>
<dd>
Contains the framework and instructions for running multiple pipelines in a single Logstash instance. See <a class="xref" href="multiple-pipelines.html" title="Multiple Pipelines">Multiple Pipelines</a> for more info.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">jvm.options</code></strong></span>
</span>
</dt>
<dd>
Contains JVM configuration flags. Use this file to set initial and maximum values for
total heap space. You can also use this file to set the locale for Logstash.
Specify each flag on a separate line. All other settings in this file are
considered expert settings.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log4j2.properties</code></strong></span>
</span>
</dt>
<dd>
Contains default settings for <code class="literal">log4j 2</code> library. See <a class="xref" href="logging.html#log4j2" title="Log4j2 configuration">Log4j2 configuration</a> for more info.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">startup.options</code> (Linux)</strong></span>
</span>
</dt>
<dd>
Contains options used by the <code class="literal">system-install</code> script in <code class="literal">/usr/share/logstash/bin</code> to build the appropriate startup
script for your system. When you install the Logstash package, the <code class="literal">system-install</code> script executes at the end of the
installation process and uses the settings specified in <code class="literal">startup.options</code> to set options such as the user, group,
service name, and service description. By default, Logstash services are installed under the user <code class="literal">logstash</code>. The <code class="literal">startup.options</code> file makes it easier for you to install multiple instances of the Logstash service. You can copy
the file and change the values for specific settings. Note that the <code class="literal">startup.options</code> file is not read at startup. If
you want to change the Logstash startup script (for example, to change the Logstash user or read from a different
configuration path), you must re-run the <code class="literal">system-install</code> script (as root) to pass in the new settings.
</dd>
</dl>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="dir-layout.html">« Logstash Directory Layout</a>
</span>
<span class="next">
<a href="logstash-settings-file.html">logstash.yml »</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>