forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmonitoring-logstash.html
309 lines (287 loc) · 17.3 KB
/
monitoring-logstash.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Monitoring Logstash with APIs | Logstash Reference [8.0] | Elastic</title>
<meta class="elastic" name="content" content="Monitoring Logstash with APIs | Logstash Reference [8.0]">
<link rel="home" href="index.html" title="Logstash Reference [8.0]"/>
<link rel="up" href="index.html" title="Logstash Reference [8.0]"/>
<link rel="prev" href="monitoring-troubleshooting.html" title="Troubleshooting monitoring in Logstash"/>
<link rel="next" href="node-info-api.html" title="Node Info API"/>
<meta class="elastic" name="product_version" content="8.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/8.0"/>
<meta name="DC.subject" content="Logstash"/>
<meta name="DC.identifier" content="8.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 [8.0]</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="monitoring-troubleshooting.html">« Troubleshooting monitoring in Logstash</a>
</span>
<span class="next">
<a href="node-info-api.html">Node Info API »</a>
</span>
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<h1 class="title"><a id="monitoring-logstash"></a>Monitoring Logstash with APIs<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring.asciidoc">edit</a></h1>
</div></div></div>
<p>When you run Logstash, it automatically captures runtime metrics that you can
use to monitor the health and performance of your Logstash deployment.</p>
<p>The metrics collected by Logstash include:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
Logstash node info, like pipeline settings, OS info, and JVM info.
</li>
<li class="listitem">
Plugin info, including a list of installed plugins.
</li>
<li class="listitem">
Node stats, like JVM stats, process stats, event-related stats, and pipeline
runtime stats.
</li>
<li class="listitem">
Hot threads.
</li>
</ul>
</div>
<p>You can use <a class="xref" href="monitoring-logstash.html#monitoring" title="APIs for monitoring Logstash">monitoring APIs</a> provided by Logstash
to retrieve these metrics. These APIs are available by default without
requiring any extra configuration.</p>
<p>Alternatively, you can <a class="xref" href="configuring-logstash.html" title="Monitoring Logstash">configure X-Pack monitoring</a> to send
data to a monitoring cluster.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Monitoring is a feature under the Basic License and is therefore
<span class="strong strong"><strong>free to use</strong></span>.</p>
</div>
</div>
<h2><a id="monitoring"></a>APIs for monitoring Logstash<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring-apis.asciidoc">edit</a></h2>
<p>Logstash provides monitoring APIs for retrieving runtime metrics
about Logstash:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a class="xref" href="node-info-api.html" title="Node Info API">Node Info API</a>
</li>
<li class="listitem">
<a class="xref" href="plugins-api.html" title="Plugins info API">Plugins info API</a>
</li>
<li class="listitem">
<a class="xref" href="node-stats-api.html" title="Node Stats API">Node Stats API</a>
</li>
<li class="listitem">
<a class="xref" href="hot-threads-api.html" title="Hot Threads API">Hot Threads API</a>
</li>
</ul>
</div>
<p>You can use the root resource to retrieve general information about the Logstash instance, including
the host and version.</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">curl -XGET 'localhost:9600/?pretty'</pre>
</div>
<p>Example response:</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">{
"host": "skywalker",
"version": "8.0.1",
"http_address": "127.0.0.1:9600"
}</pre>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>By default, the monitoring API attempts to bind to <code class="literal">tcp:9600</code>. If this port is already in use by another Logstash
instance, you need to launch Logstash with the <code class="literal">--api.http.port</code> flag specified to bind to a different port. See
<a class="xref" href="running-logstash-command-line.html#command-line-flags" title="Command-Line Flags">Command-Line Flags</a> for more information.</p>
</div>
</div>
<h4><a id="monitoring-api-security"></a>Securing the Logstash API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring-apis.asciidoc">edit</a></h4>
<p>The Logstash Monitoring APIs are not secured by default, but you can configure Logstash to secure them in one of several ways to meet your organization’s needs.</p>
<p>You can enable SSL for the Logstash API by setting <code class="literal">api.ssl.enabled: true</code> in the <code class="literal">logstash.yml</code>, and providing the relevant keystore settings <code class="literal">api.ssl.keystore.path</code> and <code class="literal">api.ssl.keystore.password</code>:</p>
<pre class="screen">api.ssl.enabled: true
api.ssl.keystore.path: /path/to/keystore.jks
api.ssl.keystore.password: "s3cUr3p4$$w0rd"</pre>
<p>The keystore must be in either jks or p12 format, and must contain both a certificate and a private key.
Connecting clients receive this certificate, allowing them to authenticate the Logstash endpoint.</p>
<p>You can also require HTTP Basic authentication by setting <code class="literal">api.auth.type: basic</code> in the <code class="literal">logstash.yml</code>, and providing the relevant credentials <code class="literal">api.auth.basic.username</code> and <code class="literal">api.auth.basic.password</code>:</p>
<pre class="screen">api.auth.type: basic
api.auth.basic.username: "logstash"
api.auth.basic.password: "stashy"</pre>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Usage of Keystore or Environment or variable replacements is encouraged for password-type fields to avoid storing them in plain text.
For example, specifying the value <code class="literal">"${HTTP_PASS}"</code> will resolve to the value stored in the <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">secure keystore’s</a> <code class="literal">HTTP_PASS</code> variable if present or the same variable from the <a class="xref" href="environment-variables.html" title="Using environment variables in the configuration">environment</a>)</p>
</div>
</div>
<h4><a id="monitoring-common-options"></a>Common options<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring-apis.asciidoc">edit</a></h4>
<p>The following options can be applied to all of the Logstash monitoring APIs.</p>
<h5><a id="_pretty_results"></a>Pretty results<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring-apis.asciidoc">edit</a></h5>
<p>When appending <code class="literal">?pretty=true</code> to any request made, the JSON returned
will be pretty formatted (use it for debugging only!).</p>
<h5><a id="_human_readable_output"></a>Human-readable output<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/logstash/edit/8.0/docs/static/monitoring/monitoring-apis.asciidoc">edit</a></h5>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>For Logstash 8.0.1, the <code class="literal">human</code> option is supported for the <a class="xref" href="hot-threads-api.html" title="Hot Threads API">Hot Threads API</a>
only. When you specify <code class="literal">human=true</code>, the results are returned in plain text instead of
JSON format. The default is false.</p>
</div>
</div>
<p>Statistics are returned in a format suitable for humans
(eg <code class="literal">"exists_time": "1h"</code> or <code class="literal">"size": "1kb"</code>) and for computers
(eg <code class="literal">"exists_time_in_millis": 3600000</code> or <code class="literal">"size_in_bytes": 1024</code>).
The human-readable values can be turned off by adding <code class="literal">?human=false</code>
to the query string. This makes sense when the stats results are
being consumed by a monitoring tool, rather than intended for human
consumption. The default for the <code class="literal">human</code> flag is
<code class="literal">false</code>.</p>
</div>
<div class="navfooter">
<span class="prev">
<a href="monitoring-troubleshooting.html">« Troubleshooting monitoring in Logstash</a>
</span>
<span class="next">
<a href="node-info-api.html">Node Info API »</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>