Menu

This is documentation for the next version of Agent. For the latest stable release, go to the latest version.

Open source

discovery.nerve

discovery.nerve discovers airbnb/nerve targets stored in Zookeeper.

Usage

river
discovery.nerve "LABEL" {
	servers = [SERVER_1, SERVER_2]
	paths   = [PATH_1, PATH_2]
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
serverslist(string)The Zookeeper servers.yes
pathslist(string)The paths to look for targets at.yes
timeoutdurationThe timeout to use."10s"no

Each element in the path list can either point to a single service, or to the root of a tree of services.

Blocks

The discovery.nerve component does not support any blocks, and is configured fully through arguments.

Exported fields

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

NameTypeDescription
targetslist(map(string))The set of targets discovered from Nerve’s API.

The following meta labels are available on targets and can be used by the discovery.relabel component

  • __meta_nerve_path: the full path to the endpoint node in Zookeeper
  • __meta_nerve_endpoint_host: the host of the endpoint
  • __meta_nerve_endpoint_port: the port of the endpoint
  • __meta_nerve_endpoint_name: the name of the endpoint

Component health

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

Debug information

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

Debug metrics

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

Example

river
discovery.nerve "example" {
	servers = ["localhost"]
	paths   = ["/monitoring"]
	timeout = "1m"
}
prometheus.scrape "demo" {
	targets    = discovery.nerve.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 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.