forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstall-metrics-monitoring.html
272 lines (254 loc) · 18.2 KB
/
install-metrics-monitoring.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Get started | Metrics Monitoring Guide [7.9] | Elastic</title>
<meta class="elastic" name="content" content="Get started | Metrics Monitoring Guide [7.9]">
<link rel="home" href="index.html" title="Metrics Monitoring Guide [7.9]"/>
<link rel="up" href="index.html" title="Metrics Monitoring Guide [7.9]"/>
<link rel="prev" href="metrics-overview.html" title="Metrics monitoring overview"/>
<link rel="next" href="metrics-app-overview.html" title="Metrics app"/>
<meta class="elastic" name="product_version" content="7.9"/>
<meta class="elastic" name="product_name" content="Metrics"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Metrics/Guide/7.9"/>
<meta name="DC.subject" content="Metrics"/>
<meta name="DC.identifier" content="7.9"/>
<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">
A newer version is available. For the latest information, see the
<a href="https://www.elastic.co/guide/en/observability/current/analyze-metrics.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">Metrics Monitoring Guide [7.9]</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="metrics-overview.html">« Metrics monitoring overview</a>
</span>
<span class="next">
<a href="metrics-app-overview.html">Metrics app »</a>
</span>
</div>
<div class="chapter xpack">
<div class="titlepage"><div><div>
<h1 class="title"><a id="install-metrics-monitoring"></a>Get started<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a></h1>
</div></div></div>
<p>To use the Metrics app, you need Elasticsearch for storing and searching your data, and Kibana
for visualizing and managing it.</p>
<p>To ingest data, you can use Metricbeat installed on each server you want to monitor, or
third-party collectors that are configured to ship ECS-compliant data. The <a class="xref" href="metrics-fields-reference.html" title="Metrics fields reference">Metrics fields reference</a>
provides a list of all fields used in the Metrics app.</p>
<h3><a id="before-you-begin-metricbeat"></a>Before you begin<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a></h3>
<p>To get started quickly, spin up a deployment of our <a href="/cloud/elasticsearch-service?baymax=docs-body&elektra=docs" class="ulink" target="_top">hosted Elasticsearch Service</a>. The deployment includes
Elasticsearch and Kibana, and is available on AWS, GCP, and Azure. <a href="/cloud/elasticsearch-service/signup?baymax=docs-body&elektra=docs" class="ulink" target="_top">Try Elasticsearch Service for free</a>.</p>
<p>To install Metricbeat from Kibana, on the machine where you want to collect the data, open a Kibana browser window.
In the <span class="strong strong"><strong>Observability</strong></span> section displayed on the home page of Kibana, click <span class="strong strong"><strong>Add metric data</strong></span>.
Now follow the instructions for the type of data you want to collect.
The instructions include how to install and configure Metricbeat, and enable the appropriate Metricbeat integration for your data.</p>
<div class="imageblock screenshot">
<div class="content">
<img src="images/add-data.png" alt="Add metrics data">
</div>
</div>
<p>Alternatively, you can install and self manage <a href="/guide/en/elastic-stack-get-started/7.9/get-started-elastic-stack.html#install-elasticsearch" class="ulink" target="_top">Elasticsearch</a>
and <a href="/guide/en/elastic-stack-get-started/7.9/get-started-elastic-stack.html#install-kibana" class="ulink" target="_top">Kibana</a>. First see the
<a href="/support/matrix" class="ulink" target="_top">Elastic Support Matrix</a>
for information about supported operating systems and product compatibility.</p>
<h3><a id="download-install-metricbeat"></a>Step 1: Download and install Metricbeat<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a></h3>
<p>Install Metricbeat as close as possible to the service you want to monitor. For example, if you have four servers with
MySQL running, it’s recommended that you run Metricbeat on each server. This allows Metricbeat to access your service from
localhost and does not cause any additional network traffic or prevent Metricbeat from collecting metrics when there are
network problems. Metrics from multiple Metricbeat instances will be combined on the Elasticsearch server.</p>
<p>To download and install Metricbeat, see <a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#install" class="ulink" target="_top">Installing Metricbeat</a>
and use the commands that work with your system.</p>
<h3><a id="configuring-metricbeat"></a>Step 2: Configure Metricbeat<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a></h3>
<p>Now that you have completed the Metricbeat download and installation process, the next step is to configure Metricbeat.</p>
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
<p>Connect to Elasticsearch and Kibana.</p>
<p>Connections to Elasticsearch and Kibana are required to set up Metricbeat. Set the connection information in <code class="literal">metricbeat.yml</code>.
To locate this configuration file, see <a href="/guide/en/beats/metricbeat/7.9/directory-layout.html" class="ulink" target="_top">Directory layout</a>.</p>
<p>For information on how to connect to the Elasticsearch and Kibana, see <a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#set-connection" class="ulink" target="_top">Connecting
to Elastic Stack</a>.</p>
</li>
<li class="listitem">
<p>Enable Metricbeat integrations.</p>
<p>Metricbeat uses integrations to collect metrics for populating the Metrics app with data. Each integration defines the basic
logic for collecting data from a specific service, such as Redis or MySQL. An
integration consists of metricsets that fetch and structure the data. Read
<a href="/guide/en/beats/metricbeat/7.9/how-metricbeat-works.html" class="ulink" target="_top">How Metricbeat works</a> to learn more.</p>
<p>See <a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#enable-modules" class="ulink" target="_top">Enabling and configuring metrics collection modules</a>
for information on how to identify which integrations are available, how to enable them, and how to
configure them.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>If you’re monitoring Docker containers or Kubernetes pods, you can use autodiscovery to automatically change the configuration settings in response to changes in your containers.
Autodiscovery ensures that even when your container configuration changes, data is still collected.
To learn how to do this, see <a href="/guide/en/beats/metricbeat/7.9/configuration-autodiscover.html" class="ulink" target="_top">Metricbeat autodiscover configuration</a></p>
</div>
</div>
</li>
<li class="listitem">
<p>Set up assets.</p>
<p>Metricbeat comes with predefined assets for parsing, indexing, and visualizing your data. For information on how to load these assets, see
<a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#setup-assets" class="ulink" target="_top">Setting up assets</a>.</p>
</li>
</ol>
</div>
<h3><a id="starting-metricbeat"></a>Step 3: Start Metricbeat<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a></h3>
<p>Before starting Metricbeat, modify the user credentials in <code class="literal">metricbeat.yml</code> and specify a user who is <a href="/guide/en/beats/metricbeat/7.9/privileges-to-publish-events.html" class="ulink" target="_top">authorized to publish events</a>.</p>
<p>To start Metricbeat, see <a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#start" class="ulink" target="_top">Starting Metricbeat</a>
and use the commands that work with your system.</p>
<h3><a id="verify-metricbeat-data"></a>Step 4: Verify your data in Kibana<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/observability-docs/edit/7.9/docs/en/metrics/metrics-installation.asciidoc">edit</a></h3>
<p>Metricbeat comes with pre-built Kibana dashboards and UIs for visualizing log data. You loaded the dashboards earlier when you
ran the <code class="literal">setup</code> command as part of setting up assets. The dashboards are provided as examples. We recommend that you <a href="/guide/en/kibana/7.9/dashboard.html" class="ulink" target="_top">customize them</a>
to meet your needs.</p>
<p>For more information, see <a href="/guide/en/beats/metricbeat/7.9/metricbeat-installation-configuration.html#view-data" class="ulink" target="_top">Viewing your data in Kibana</a>.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>If your metrics have custom index patterns, or use non-default fields, you can override the default <a class="xref" href="configure-metrics-source.html" title="Configure metrics source data">configuration settings</a>.
To modify configurations, use the <a class="xref" href="configure-metrics-source.html" title="Configure metrics source data">Settings tab</a> in the Metrics app.
Alternatively, see <a href="/guide/en/kibana/7.9/infrastructure-ui-settings-kb.html" class="ulink" target="_top">metrics settings</a> for
a complete list of metrics configuration settings.</p>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="metrics-overview.html">« Metrics monitoring overview</a>
</span>
<span class="next">
<a href="metrics-app-overview.html">Metrics app »</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>