Skip to content

[9.1](backport #46359) [Docs] Add Support for Base64 encoded api_key in Elasticsearch #46374

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.

Sign up for GitHub

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

Merged
pickypg merged 1 commit into from
Sep 4, 2025
Merged

[9.1](backport #46359) [Docs] Add Support for Base64 encoded api_key in Elasticsearch #46374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion docs/reference/metricbeat/metricbeat-module-elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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]

Expand Down
8 changes: 7 additions & 1 deletion metricbeat/module/elasticsearch/_meta/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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"`)/
Loading