diff --git a/docs/how-to.asciidoc b/docs/how-to.asciidoc index 4afc717db56..f9e553802ec 100644 --- a/docs/how-to.asciidoc +++ b/docs/how-to.asciidoc @@ -5,7 +5,6 @@ Learn how to perform common APM configuration and management tasks. * <> * <> -* <> * <> * <> @@ -13,8 +12,6 @@ include::./source-map-how-to.asciidoc[] include::./jaeger-integration.asciidoc[] -include::./monitor.asciidoc[] - include::./ingest-pipelines.asciidoc[] include::./custom-index-template.asciidoc[] diff --git a/docs/integrations-index.asciidoc b/docs/integrations-index.asciidoc index 097c3ea2fe8..435e50a6a66 100644 --- a/docs/integrations-index.asciidoc +++ b/docs/integrations-index.asciidoc @@ -82,6 +82,8 @@ include::configure/index.asciidoc[leveloffset=+1] include::secure-agent-communication.asciidoc[] +include::monitor-apm-server.asciidoc[] + include::api.asciidoc[] include::troubleshoot-apm.asciidoc[] @@ -132,8 +134,6 @@ include::./legacy/getting-started-apm-server.asciidoc[] :beat-specific-security: {docdir}/legacy/security.asciidoc include::{libbeat-dir}/shared-securing-beat.asciidoc[leveloffset=+1] -include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[leveloffset=+1] - include::./legacy/troubleshooting.asciidoc[leveloffset=+1] // include::./legacy/breaking-changes.asciidoc[leveloffset=+1] diff --git a/docs/legacy/copied-from-beats/docs/monitoring/monitoring-beats.asciidoc b/docs/legacy/copied-from-beats/docs/monitoring/monitoring-beats.asciidoc index f02a6dbd4bc..b902461970f 100644 --- a/docs/legacy/copied-from-beats/docs/monitoring/monitoring-beats.asciidoc +++ b/docs/legacy/copied-from-beats/docs/monitoring/monitoring-beats.asciidoc @@ -1,22 +1,13 @@ -[role="xpack"] [[monitoring]] -= Monitor {beatname_uc} += Monitor the APM Server binary ++++ -Monitor +APM Server binary ++++ -You can use the {stack} {monitor-features} to gain insight into the health of -ifndef::apm-server[] -{beatname_uc} instances running in your environment. -endif::[] -ifdef::apm-server[] -{beatname_uc}. -endif::[] - -To monitor {beatname_uc}, make sure monitoring is enabled on your {es} cluster, -then configure the method used to collect {beatname_uc} metrics. You can use one -of following methods: +There are two methods to monitor the APM Server binary. +Make sure monitoring is enabled on your {es} cluster, +then configure one of these methods to collect {beatname_uc} metrics: * <> - Internal collectors send monitoring data directly to your monitoring cluster. @@ -26,11 +17,6 @@ ifndef::serverless[] and sends it directly to your monitoring cluster. endif::[] -//Commenting out this link temporarily until the general monitoring docs can be -//updated. -//To learn about monitoring in general, see -//{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster]. - include::monitoring-internal-collection.asciidoc[] ifndef::serverless[] diff --git a/docs/legacy/copied-from-beats/docs/monitoring/shared-monitor-config.asciidoc b/docs/legacy/copied-from-beats/docs/monitoring/shared-monitor-config.asciidoc index b70d72eed24..71825450dc3 100644 --- a/docs/legacy/copied-from-beats/docs/monitoring/shared-monitor-config.asciidoc +++ b/docs/legacy/copied-from-beats/docs/monitoring/shared-monitor-config.asciidoc @@ -10,7 +10,7 @@ //// Make sure this content appears below a level 2 heading. ////////////////////////////////////////////////////////////////////////// -[role="xpack"] +[float] [[configuration-monitor]] === Settings for internal collection @@ -20,6 +20,7 @@ using {metricbeat} to collect monitoring data. You specify these settings in the X-Pack monitoring section of the +{beatname_lc}.yml+ config file: +[float] ==== `monitoring.enabled` The `monitoring.enabled` config is a boolean setting to enable or disable {monitoring}. @@ -27,21 +28,25 @@ If set to `true`, monitoring is enabled. The default value is `false`. +[float] ==== `monitoring.elasticsearch` The {es} instances that you want to ship your {beatname_uc} metrics to. This configuration option contains the following fields: +[float] ===== `api_key` The detail of the API key to be used to send monitoring information to {es}. See <> for more information. +[float] ===== `bulk_max_size` The maximum number of metrics to bulk in a single {es} bulk API index request. The default is `50`. For more information, see <>. +[float] ===== `backoff.init` The number of seconds to wait before trying to reconnect to {es} after @@ -50,11 +55,13 @@ reconnect. If the attempt fails, the backoff timer is increased exponentially up to `backoff.max`. After a successful connection, the backoff timer is reset. The default is `1s`. +[float] ===== `backoff.max` The maximum number of seconds to wait before attempting to connect to {es} after a network error. The default is `60s`. +[float] ===== `compression_level` The gzip compression level. Setting this value to `0` disables compression. The @@ -62,59 +69,70 @@ compression level must be in the range of `1` (best speed) to `9` (best compression). The default value is `0`. Increasing the compression level reduces the network usage but increases the CPU usage. +[float] ===== `headers` Custom HTTP headers to add to each request. For more information, see <>. +[float] ===== `hosts` The list of {es} nodes to connect to. Monitoring metrics are distributed to these nodes in round robin order. For more information, see <>. +[float] ===== `max_retries` The number of times to retry sending the monitoring metrics after a failure. After the specified number of retries, the metrics are typically dropped. The default value is `3`. For more information, see <>. +[float] ===== `parameters` Dictionary of HTTP parameters to pass within the URL with index operations. +[float] ===== `password` The password that {beatname_uc} uses to authenticate with the {es} instances for shipping monitoring data. +[float] ===== `metrics.period` The time interval (in seconds) when metrics are sent to the {es} cluster. A new snapshot of {beatname_uc} metrics is generated and scheduled for publishing each period. The default value is 10 * time.Second. +[float] ===== `state.period` The time interval (in seconds) when state information are sent to the {es} cluster. A new snapshot of {beatname_uc} state is generated and scheduled for publishing each period. The default value is 60 * time.Second. +[float] ===== `protocol` The name of the protocol to use when connecting to the {es} cluster. The options are: `http` or `https`. The default is `http`. If you specify a URL for `hosts`, however, the value of protocol is overridden by the scheme you specify in the URL. +[float] ===== `proxy_url` The URL of the proxy to use when connecting to the {es} cluster. For more information, see <>. +[float] ===== `timeout` The HTTP request timeout in seconds for the {es} request. The default is `90`. +[float] ===== `ssl` Configuration options for Transport Layer Security (TLS) or Secure Sockets Layer @@ -122,6 +140,7 @@ Configuration options for Transport Layer Security (TLS) or Secure Sockets Layer connections. If the `ssl` section is missing, the host CAs are used for HTTPS connections to {es}. For more information, see <>. +[float] ===== `username` The user ID that {beatname_uc} uses to authenticate with the {es} instances for diff --git a/docs/monitor-apm-server.asciidoc b/docs/monitor-apm-server.asciidoc new file mode 100644 index 00000000000..90629b5e02d --- /dev/null +++ b/docs/monitor-apm-server.asciidoc @@ -0,0 +1,31 @@ +[[monitor-apm]] +== Monitor APM Server + +++++ +Monitor +++++ + +Use the {stack} {monitor-features} to gain insight into the real-time health and performance of APM Server. +Stack monitoring exposes key metrics, like intake response count, intake error rate, output event rate, +output failed event rate, and more. + +Select your deployment method to get started: + +* <> +* <> +* <> + +[float] +[[monitor-apm-cloud]] +=== {ecloud} + +{ecloud} manages the installation and configuration of a monitoring agent for you -- so +all you have to do is flip a switch and watch the data pour in. + +* **{ess}** user? See {ece-ref}/ece-enable-logging-and-monitoring.html[ESS: Enable logging and monitoring]. +* **{ece}** user? See {cloud}/ec-enable-logging-and-monitoring.html[ECE: Enable logging and monitoring]. + + +include::./monitor.asciidoc[] + +include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[leveloffset=+2] \ No newline at end of file diff --git a/docs/monitor.asciidoc b/docs/monitor.asciidoc index 64463e12416..fa74864e8b9 100644 --- a/docs/monitor.asciidoc +++ b/docs/monitor.asciidoc @@ -1,23 +1,9 @@ -[[monitor-apm]] -=== Monitor APM Server - -Use the {stack} {monitor-features} to gain insight into the real-time health and performance of APM Server. -Stack monitoring exposes key metrics, like intake response count, intake error rate, output event rate, -output failed event rate, and more. - -[float] -[[monitor-apm-cloud]] -=== Monitor APM running on {ecloud} - -{ecloud} manages the installation and configuration of a monitoring agent for you -- so -all you have to do is flip a switch and watch the data pour in. - -* **{ess}** user? See {ece-ref}/ece-enable-logging-and-monitoring.html[ESS: Enable logging and monitoring]. -* **{ece}** user? See {cloud}/ec-enable-logging-and-monitoring.html[ECE: Enable logging and monitoring]. - -[float] [[monitor-apm-self-install]] -=== Monitor a self-installation of APM +=== Monitor a Fleet-managed APM Server + +++++ +Fleet-managed +++++ NOTE: This guide assumes you are already ingesting APM data into the {stack}. @@ -54,22 +40,15 @@ agent.monitoring: <3> The port to expose logs/metrics on -- -. Stop {agent} +. Enroll {agent} + -If {agent} is already running, you must stop it. -Use the command that work with your system: +After editing `elastic-agent.yml`, you must re-enroll {agent} for the changes to take effect. + -- -include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/stop-widget.asciidoc[] +include::{ingest-docs-root}/docs/en/ingest-management/commands.asciidoc[tag=enroll] -- -. Start {agent} -+ -Use the command that work with your system: -+ --- -include::{ingest-docs-root}/docs/en/ingest-management/tab-widgets/start-widget.asciidoc[] --- +See the {fleet-guide}/elastic-agent-cmd-options.html[{agent} command reference] for more information on the enroll command. [float] [[install-config-metricbeat]]