prometheus.exporter.memcached
The prometheus.exporter.memcached
component embeds the memcached_exporter
for collecting metrics from a Memcached server.
Usage
prometheus.exporter.memcached "<LABEL>" {
}
Arguments
You can use the following arguments with prometheus.exporter.memcached
:
Blocks
You can use the following block with prometheus.exporter.memcached
:
tls_config
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
When configuring client authentication, both the client certificate (using cert_pem
or cert_file
) and the client key (using key_pem
or key_file
) must be provided.
When min_version
isn’t provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2.
If min_version
is provided, it must be set to one of the following strings:
"TLS10"
(TLS 1.0)"TLS11"
(TLS 1.1)"TLS12"
(TLS 1.2)"TLS13"
(TLS 1.3)
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.memcached
is only reported as unhealthy if given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
prometheus.exporter.memcached
doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.memcached
doesn’t expose any component-specific debug metrics.
Example
The following example uses a prometheus.exporter.memcached
component to collect metrics from a Memcached server running locally, and scrapes the metrics using a prometheus.scrape
component:
prometheus.exporter.memcached "example" {
address = "localhost:13321"
timeout = "5s"
}
prometheus.scrape "example" {
targets = [prometheus.exporter.memcached.example.targets]
forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
endpoint {
url = "<PROMETHEUS_REMOTE_WRITE_URL>"
basic_auth {
username = "<USERNAME>"
password = "<PASSWORD>"
}
}
}
Replace the following:
<PROMETHEUS_REMOTE_WRITE_URL>
: The URL of the Prometheusremote_write
compatible server to send metrics to.<USERNAME>
: The username to use for authentication to theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
prometheus.exporter.memcached
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.