Skip to content

Commit

Permalink
Restructure monitoring docs
Browse files Browse the repository at this point in the history
  • Loading branch information
karenzone committed Apr 8, 2020
1 parent c2d107b commit 19ca70e
Show file tree
Hide file tree
Showing 14 changed files with 452 additions and 109 deletions.
7 changes: 3 additions & 4 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -187,14 +187,13 @@ include::static/deploying.asciidoc[]
:edit_url: https://github.com/elastic/logstash/edit/{branch}/docs/static/performance-checklist.asciidoc
include::static/performance-checklist.asciidoc[]

// Monitoring
:edit_url!:
include::static/monitoring/monitoring.asciidoc[]

// X-Pack Monitoring
:edit_url!:
include::static/monitoring/monitoring-overview.asciidoc[]

// Monitoring
:edit_url!:
include::static/monitoring/monitoring.asciidoc[]

// Working with Plugins

Expand Down
49 changes: 49 additions & 0 deletions docs/static/monitoring/collectors-legacy.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[float]
[role="xpack"]
[[logstash-monitoring-collectors-legacy]]
===== Collectors

Collectors, as their name implies, collect things. In monitoring for Logstash,
collectors are just <<pipeline,Inputs>> in the same way that ordinary Logstash
configurations provide inputs.

Like monitoring for {es}, each collector can create zero or more monitoring
documents. As it is currently implemented, each Logstash node runs two types of
collectors: one for node stats and one for pipeline stats.

[options="header"]
|=======================
| Collector | Data Types | Description
| Node Stats | `logstash_stats`
| Gathers details about the running node, such as memory utilization and CPU
usage (for example, `GET /_stats`).

This runs on every Logstash node with monitoring enabled. One common
failure is that Logstash directories are copied with their `path.data` directory
included (`./data` by default), which copies the persistent UUID of the Logstash
node along with it. As a result, it generally appears that one or more Logstash
nodes are failing to collect monitoring data, when in fact they are all really
misreporting as the _same_ Logstash node. Re-use `path.data` directories only
when upgrading Logstash, such that upgraded nodes replace the previous versions.
| Pipeline Stats | `logstash_state`
| Gathers details about the node's running pipelines, which powers the
Monitoring Pipeline UI.
|=======================

Per collection interval, which defaults to 10 seconds (`10s`), each collector is
run. The failure of an individual collector does not impact any other collector.
Each collector, as an ordinary Logstash input, creates a separate Logstash event
in its isolated monitoring pipeline. The Logstash output then sends the data.

The collection interval can be configured dynamically and you can also disable
data collection. For more information about the configuration options for the
collectors, see <<monitoring-settings-legacy>>.

WARNING: Unlike {es} and {kib} monitoring, there is no
`xpack.monitoring.collection.enabled` setting on Logstash. You must use the
`xpack.monitoring.enabled` setting to enable and disable data collection.

If gaps exist in the monitoring charts in {kib}, it is typically because either
a collector failed or the monitoring cluster did not receive the data (for
example, it was being restarted). In the event that a collector fails, a logged
error should exist on the node that attempted to perform the collection.
8 changes: 4 additions & 4 deletions docs/static/monitoring/collectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[[logstash-monitoring-collectors]]
===== Collectors

Collectors, as their name implies, collect things. In {monitoring} for Logstash,
Collectors, as their name implies, collect things. In monitoring for Logstash,
collectors are just <<pipeline,Inputs>> in the same way that ordinary Logstash
configurations provide inputs.

Like {monitoring} for {es}, each collector can create zero or more monitoring
Like monitoring for {es}, each collector can create zero or more monitoring
documents. As it is currently implemented, each Logstash node runs two types of
collectors: one for node stats and one for pipeline stats.

Expand All @@ -18,7 +18,7 @@ collectors: one for node stats and one for pipeline stats.
| Gathers details about the running node, such as memory utilization and CPU
usage (for example, `GET /_stats`).

This runs on every Logstash node with {monitoring} enabled. One common
This runs on every Logstash node with monitoring enabled. One common
failure is that Logstash directories are copied with their `path.data` directory
included (`./data` by default), which copies the persistent UUID of the Logstash
node along with it. As a result, it generally appears that one or more Logstash
Expand All @@ -39,7 +39,7 @@ The collection interval can be configured dynamically and you can also disable
data collection. For more information about the configuration options for the
collectors, see <<monitoring-settings>>.

WARNING: Unlike {monitoring} for {es} and {kib}, there is no
WARNING: Unlike for {es} and {kib} monitoring, there is no
`pack.monitoring.collection.enabled` setting on Logstash. You must use the
`monitoring.enabled` setting to enable and disable data collection.

Expand Down
151 changes: 143 additions & 8 deletions docs/static/monitoring/monitoring-internal-legacy.asciidoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,152 @@
[role="xpack"]
[[monitoring-internal-collection-legacy]]
=== Collect {ls} monitoring data using internal legacy collectors
=== Collect {ls} monitoring data using legacy internal collectors
++++
<titleabbrev>Legacy internal collection (deprecated)</titleabbrev>
<titleabbrev>Legacy internal collection</titleabbrev>
++++

deprecated[7.7.0]
IMPORTANT: Use <<monitoring-internal-collection,internal collection>> or
<<monitoring-with-metricbeat, {metricbeat} collection>> instead of legacy
internal collection. If you are currently using legacy internal collection, you
should migrate to either Metricbeat collection or internal collection.

Starting in {ls} version 7.7, the legacy settings for internal collection are deprecated and
will be removed in version 8.0.0. Instead of sending monitoring data to {es} exporter,
it’s recommended that you use the <<monitoring-internal-collection,internal collection>>
to route monitoring data directly to your monitoring indices.
==== Migrating from legacy internal collection to new internal collection

Or as an alternative to internal collection, use <<monitoring-with-metricbeat, {metricbeat} collection>>.
Migrating from legacy internal collection to new
<<monitoring-internal-collection,Internal collection>> is straightforward. Drop
the `xpack` prefix from your configuration settings.
For example, `xpack.monitoring.enabled` is now `monitoring.enabled`.
See <<monitoring-settings, Monitoring Settings>> for the list of settings.

If you don’t have an Elasticsearch output plugin configured in the pipelines,
add the setting `monitoring.cluster_uuid` to your logstash.yml.

==== Components for legacy internal collection

Monitoring {ls} with legacy internal collection uses these components:

* <<logstash-monitoring-collectors-legacy,Collectors>>
* <<logstash-monitoring-output-legacy,Output>>

These pieces live outside of the default Logstash pipeline in a dedicated monitoring
pipeline. This configuration ensures that all data and processing has a minimal
impact on ordinary Logstash processing. Existing Logstash features, such as the
<<plugins-outputs-elasticsearch,`elasticsearch` output>>, can be reused to
benefit from its retry policies.

NOTE: The `elasticsearch` output that is used for monitoring {ls} is
configured exclusively through settings found in `logstash.yml`. It is not
configured by using anything from the Logstash configurations that might also be
using their own separate `elasticsearch` outputs.


The production {es} cluster should be configured to receive {ls} monitoring
data. This configuration enables the production {es} cluster to add metadata
(for example, its cluster UUID) to the Logstash monitoring data and then route
it to the monitoring clusters. For more information about typical monitoring
architectures, see {ref}/how-monitoring-works.html[How monitoring works] in the
{ref}[Elasticsearch Reference].


include::collectors-legacy.asciidoc[]
include::monitoring-output-legacy.asciidoc[]


[[configure-internal-collectors-legacy]]
==== Configure {ls} monitoring with internal collectors
++++
<titleabbrev>Configure internal collection</titleabbrev>
++++

To monitor Logstash nodes:

. Specify where to send monitoring data. This cluster is often referred to as
the _production cluster_. For examples of typical monitoring architectures, see
{ref}/how-monitoring-works.html[How monitoring works].
+
--
IMPORTANT: To visualize Logstash as part of the Elastic Stack (as shown in Step
6), send metrics to your _production_ cluster. Sending metrics to a dedicated
monitoring cluster will show the Logstash metrics under the _monitoring_ cluster.

--

. Verify that the `xpack.monitoring.collection.enabled` setting is `true` on the
production cluster. If that setting is `false`, the collection of monitoring data
is disabled in {es} and data is ignored from all other sources.

. Configure your Logstash nodes to send metrics by setting the
`xpack.monitoring.elasticsearch.hosts` in `logstash.yml`. If {security-features}
are enabled, you also need to specify the credentials for the
{ref}/built-in-users.html[built-in `logstash_system` user]. For more information
about these settings, see <<monitoring-settings-legacy>>.
+
--
[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.hosts: ["http://es-prod-node-1:9200", "http://es-prod-node-2:9200"] <1>
xpack.monitoring.elasticsearch.username: "logstash_system"
xpack.monitoring.elasticsearch.password: "changeme"
--------------------------------------------------

<1> If SSL/TLS is enabled on the production cluster, you must
connect through HTTPS. As of v5.2.1, you can specify multiple
Elasticsearch hosts as an array as well as specifying a single
host as a string. If multiple URLs are specified, Logstash
can round-robin requests to these production nodes.
--

. If SSL/TLS is enabled on the production {es} cluster, specify the trusted
CA certificates that will be used to verify the identity of the nodes
in the cluster.
+
--
To add a CA certificate to a Logstash node's trusted certificates, you
can specify the location of the PEM encoded certificate with the
`certificate_authority` setting:

[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.ssl.certificate_authority: /path/to/ca.crt
--------------------------------------------------

Alternatively, you can configure trusted certificates using a truststore
(a Java Keystore file that contains the certificates):

[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.ssl.truststore.path: /path/to/file
xpack.monitoring.elasticsearch.ssl.truststore.password: password
--------------------------------------------------

Also, optionally, you can set up client certificate using a keystore
(a Java Keystore file that contains the certificate):

[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.ssl.keystore.path: /path/to/file
xpack.monitoring.elasticsearch.ssl.keystore.password: password
--------------------------------------------------

Set sniffing to `true` to enable discovery of other nodes of the {es} cluster.
It defaults to `false`.

[source,yaml]
--------------------------------------------------
xpack.monitoring.elasticsearch.sniffing: false
--------------------------------------------------

--

. Restart your Logstash nodes.

. To verify your monitoring configuration, point your web browser at your {kib}
host, and select **Monitoring** from the side navigation. Metrics reported from
your Logstash nodes should be visible in the Logstash section. When security is
enabled, to view the monitoring dashboards you must log in to {kib} as a user
who has the `kibana_user` and `monitoring_user` roles.
+
image::images/monitoring-ui.png["Monitoring",link="monitoring/images/monitoring-ui.png"]

include::../settings/monitoring-settings-legacy.asciidoc[]

Loading

0 comments on commit 19ca70e

Please sign in to comment.