prometheus.exporter.elasticsearch
The prometheus.exporter.elasticsearch
component embeds
elasticsearch_exporter for
the collection of metrics from ElasticSearch servers.
Note
Currently, Alloy can only collect metrics from a single ElasticSearch server. However, the exporter can collect the metrics from all nodes through that server configured.
We strongly recommend that you configure a separate user for Alloy, and give it only the strictly mandatory security privileges necessary for monitoring your node, as per the official documentation.
Usage
prometheus.exporter.elasticsearch "LABEL" {
address = "ELASTICSEARCH_ADDRESS"
}
Arguments
You can use the following arguments to configure the exporter’s behavior. Omitted fields take their default values.
Blocks
The following blocks are supported inside the definition of
prometheus.exporter.elasticsearch
:
basic_auth block
password
and password_file
are mutually exclusive, and only one can be provided inside a basic_auth
block.
Exported fields
The following fields are exported and can be referenced by other components.
For example, the targets
can either be passed to a discovery.relabel
component to rewrite the targets’ label sets or to a prometheus.scrape
component that collects the exposed metrics.
The exported targets use the configured in-memory traffic address specified by the run command.
Component health
prometheus.exporter.elasticsearch
is only reported as unhealthy if given
an invalid configuration. In those cases, exported fields retain their last
healthy values.
Debug information
prometheus.exporter.elasticsearch
does not expose any component-specific
debug information.
Debug metrics
prometheus.exporter.elasticsearch
does not expose any component-specific
debug metrics.
Example
This example uses a prometheus.scrape
component to collect metrics
from prometheus.exporter.elasticsearch
:
Replace the following:
PROMETHEUS_REMOTE_WRITE_URL
: The URL of the Prometheus remote_write-compatible server to send metrics to.USERNAME
: The username to use for authentication to the remote_write API.PASSWORD
: The password to use for authentication to the remote_write API.
Compatible components
prometheus.exporter.elasticsearch
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.