elasticsearch/docs/reference/monitoring/pause-export.asciidoc
James Rodewig 07ac8818b6
[DOCS] Remove testenv annotations from doc snippet tests (#80023) (#80458)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
# Conflicts:
#	docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc
#	docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc
#	docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc
#	docs/reference/slm/apis/slm-delete.asciidoc
#	docs/reference/slm/apis/slm-execute-retention.asciidoc
#	docs/reference/slm/apis/slm-execute.asciidoc
#	docs/reference/slm/apis/slm-get-status.asciidoc
#	docs/reference/slm/apis/slm-get.asciidoc
#	docs/reference/slm/apis/slm-start.asciidoc
#	docs/reference/slm/apis/slm-stats.asciidoc
#	docs/reference/slm/apis/slm-stop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc
2021-11-05 19:41:54 -04:00

45 lines
No EOL
1.7 KiB
Text

[role="xpack"]
[[pause-export]]
=== Pausing data collection
To stop generating {monitoring} data in {es}, disable data collection:
[source,yaml]
---------------------------------------------------
xpack.monitoring.collection.enabled: false
---------------------------------------------------
When this setting is `false`, {es} monitoring data is not collected and all
monitoring data from other sources such as {kib}, Beats, and Logstash is ignored.
You can update this setting by using the
{ref}/cluster-update-settings.html[Cluster Update Settings API].
If you want to collect data from sources such as {kib}, Beats, and Logstash but
not collect data about your {es} cluster, you can disable data collection
just for {es}:
[source,yaml]
---------------------------------------------------
xpack.monitoring.collection.enabled: true
xpack.monitoring.elasticsearch.collection.enabled: false
---------------------------------------------------
If you want to separately disable a specific exporter, you can specify the
`enabled` setting (which defaults to `true`) per exporter. For example:
[source,yaml]
---------------------------------------------------
xpack.monitoring.exporters.my_http_exporter:
type: http
host: ["10.1.2.3:9200", "10.1.2.4:9200"]
enabled: false <1>
---------------------------------------------------
<1> Disable the named exporter. If the same name as an existing exporter is not
used, then this will create a completely new exporter that is completely
ignored. This value can be set dynamically by using cluster settings.
NOTE: Defining a disabled exporter prevents the default exporter from being
created.
To re-start data collection, re-enable these settings.