Documentation Grafana Agent Flow mode Reference Components reference discovery.serverset

discovery.serverset

discovery.serverset discovers Serversets stored in Zookeeper and exposes them as targets. Serversets are commonly used by Finagle and Aurora.

Usage

river Copy

discovery.serverset "LABEL" {
	servers = SERVERS_LIST
	paths   = ZOOKEEPER_PATHS_LIST
}

Serverset data stored in Zookeeper must be in JSON format. The Thrift format is not supported.

Arguments

The following arguments are supported:

Exported fields

The following fields are exported and can be referenced by other components:

The following metadata labels are available on targets during relabeling:

• __meta_serverset_path: the full path to the serverset member node in Zookeeper
• __meta_serverset_endpoint_host: the host of the default endpoint
• __meta_serverset_endpoint_port: the port of the default endpoint
• __meta_serverset_endpoint_host_<endpoint>: the host of the given endpoint
• __meta_serverset_endpoint_port_<endpoint>: the port of the given endpoint
• __meta_serverset_shard: the shard number of the member
• __meta_serverset_status: the status of the member

Component health

discovery.serverset is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.serverset does not expose any component-specific debug information.

Debug metrics

discovery.serverset does not expose any component-specific debug metrics.

Example

The configuration below will connect to one of the Zookeeper servers (either zk1, zk2, or zk3) and discover JSON Serversets at paths /path/to/znode1 and /path/to/znode2. The discovered targets are scraped by the prometheus.scrape.default component and forwarded to the prometheus.remote_write.default component, which will send the samples to specified remote_write URL.

river Copy

discovery.serverset "zookeeper" {
	servers = ["zk1", "zk2", "zk3"]
	paths   = ["/path/to/znode1", "/path/to/znode2"]
	timeout = "30s"
}

prometheus.scrape "default" {
	targets    = discovery.serverset.zookeeper.targets
	forward_to = [prometheus.remote_write.default.receiver]
}

prometheus.remote_write "default" {
	endpoint {
		url = "http://remote-write-url1"
	}
}

Compatible components

discovery.serverset has exports that can be consumed by the following components:

• Components that consume Targets