Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs][Elasticsearch] Specify metricsets list behaviour with xpack mode enabled #39612

Merged
merged 1 commit into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions metricbeat/docs/modules/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `met
from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and
`metricbeat modules enable elasticsearch-xpack`.

When xpack mode is enabled, all the legacy metricsets are automatically enabled by default.
This means that you do not need to manually enable them, and there will be no conflicts or issues because Metricbeat merges the user-defined metricsets with the ones that xpack mode forces to enable.
As a result, you can seamlessly collect comprehensive metrics without worrying about dataset overlap or duplication.

[source,yaml]
----
metricbeat.modules:
- module: elasticsearch
xpack.enabled: true
metricsets:
- ingest_pipeline
period: 10s
----

NOTE: When this module is used for {stack} Monitoring, it sends metrics to the
monitoring index instead of the default index typically used by {metricbeat}.
For more details about the monitoring index, see
Expand Down
14 changes: 14 additions & 0 deletions metricbeat/module/elasticsearch/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `met
from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and
`metricbeat modules enable elasticsearch-xpack`.

When xpack mode is enabled, all the legacy metricsets are automatically enabled by default.
This means that you do not need to manually enable them, and there will be no conflicts or issues because Metricbeat merges the user-defined metricsets with the ones that xpack mode forces to enable.
As a result, you can seamlessly collect comprehensive metrics without worrying about dataset overlap or duplication.

[source,yaml]
----
metricbeat.modules:
- module: elasticsearch
xpack.enabled: true
metricsets:
- ingest_pipeline
period: 10s
----

NOTE: When this module is used for {stack} Monitoring, it sends metrics to the
monitoring index instead of the default index typically used by {metricbeat}.
For more details about the monitoring index, see
Expand Down
Loading