diff --git a/docs/reference/metricbeat/metricbeat-module-elasticsearch.md b/docs/reference/metricbeat/metricbeat-module-elasticsearch.md index c3dc90c6393d..284d22458b2c 100644 --- a/docs/reference/metricbeat/metricbeat-module-elasticsearch.md +++ b/docs/reference/metricbeat/metricbeat-module-elasticsearch.md @@ -26,7 +26,6 @@ The `elasticsearch` module collects metrics about {{es}}. The `elasticsearch` module works with {{es}} 6.7.0 and later. - ## Usage for {{stack}} Monitoring [_usage_for_stack_monitoring_2] The `elasticsearch` module can be used to collect metrics shown in our {{stack-monitor-app}} UI in {{kib}}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` from the module’s configuration. Alternatively, run `metricbeat modules disable elasticsearch` and `metricbeat modules enable elasticsearch-xpack`. @@ -55,6 +54,13 @@ Like other Metricbeat modules, the `elasticsearch` module accepts a `hosts` conf * If `scope` is set to `node` (default), each entry in the `hosts` list indicates a distinct node in an {{es}} cluster. * If `scope` is set to `cluster`, each entry in the `hosts` list indicates a single endpoint for a distinct {{es}} cluster (for example, a load-balancing proxy fronting the cluster). +Also like some other modules, the `elasticsearch` module accepts either a `username`/`password` pair of settings or a single `api_key` setting. You cannot specify the `username`/`password` settings _and_ `api_key` at the same time. + +When used, the `api_key` configuration can be specified as: + +* {applies_to}`stack: ga 9.1.4` The unencoded `id:api_key` format (`api_key: "foo:bar"`) or the Base64-encoded `id:api_key` format (`api_key: "Zm9vOmJhcgo="`). +* All earlier releases can only use the unencoded `id:api_key` format (`api_key: "foo:bar"`)/ + ## Example configuration [_example_configuration] diff --git a/metricbeat/module/elasticsearch/_meta/docs.md b/metricbeat/module/elasticsearch/_meta/docs.md index 505c87dda447..6a52d74c22dc 100644 --- a/metricbeat/module/elasticsearch/_meta/docs.md +++ b/metricbeat/module/elasticsearch/_meta/docs.md @@ -17,7 +17,6 @@ The `elasticsearch` module collects metrics about {{es}}. The `elasticsearch` module works with {{es}} 6.7.0 and later. - ## Usage for {{stack}} Monitoring [_usage_for_stack_monitoring_2] The `elasticsearch` module can be used to collect metrics shown in our {{stack-monitor-app}} UI in {{kib}}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` from the module’s configuration. Alternatively, run `metricbeat modules disable elasticsearch` and `metricbeat modules enable elasticsearch-xpack`. @@ -45,3 +44,10 @@ Like other Metricbeat modules, the `elasticsearch` module accepts a `hosts` conf * If `scope` is set to `node` (default), each entry in the `hosts` list indicates a distinct node in an {{es}} cluster. * If `scope` is set to `cluster`, each entry in the `hosts` list indicates a single endpoint for a distinct {{es}} cluster (for example, a load-balancing proxy fronting the cluster). + +Also like some other modules, the `elasticsearch` module accepts either a `username`/`password` pair of settings or a single `api_key` setting. You cannot specify the `username`/`password` settings _and_ `api_key` at the same time. + +When used, the `api_key` configuration can be specified as: + +* {applies_to}`stack: ga 9.1.4` The unencoded `id:api_key` format (`api_key: "foo:bar"`) or the Base64-encoded `id:api_key` format (`api_key: "Zm9vOmJhcgo="`). +* All earlier releases can only use the unencoded `id:api_key` format (`api_key: "foo:bar"`)/