Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Agent Flow mode Reference Components reference discovery.linode

discovery.linode

discovery.linode allows you to retrieve scrape targets from Linode’s Linode APIv4. This service discovery uses the public IPv4 address by default, but that can be changed with relabeling.

Usage

river Copy

discovery.linode "LABEL" {
	bearer_token = LINODE_API_TOKEN
}

Arguments

The following arguments are supported:

At most, one of the following can be provided:

• bearer_token argument.
• bearer_token_file argument.
• basic_auth block.
• authorization block.
• oauth2 block.

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

Blocks

The following blocks are supported inside the definition of discovery.linode:

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

basic_auth block

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

client_secret and client_secret_file are mutually exclusive, and only one can be provided inside an oauth2 block.

The oauth2 block may also contain a separate tls_config sub-block.

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

tls_config block

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

• ca_pem and ca_file
• cert_pem and cert_file
• key_pem and key_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 is not 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:

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

• __meta_linode_instance_id: the id of the Linode instance
• __meta_linode_instance_label: the label of the Linode instance
• __meta_linode_image: the slug of the Linode instance’s image
• __meta_linode_private_ipv4: the private IPv4 of the Linode instance
• __meta_linode_public_ipv4: the public IPv4 of the Linode instance
• __meta_linode_public_ipv6: the public IPv6 of the Linode instance
• __meta_linode_region: the region of the Linode instance
• __meta_linode_type: the type of the Linode instance
• __meta_linode_status: the status of the Linode instance
• __meta_linode_tags: a list of tags of the Linode instance joined by the tag separator
• __meta_linode_group: the display group a Linode instance is a member of
• __meta_linode_hypervisor: the virtualization software powering the Linode instance
• __meta_linode_backups: the backup service status of the Linode instance
• __meta_linode_specs_disk_bytes: the amount of storage space the Linode instance has access to
• __meta_linode_specs_memory_bytes: the amount of RAM the Linode instance has access to
• __meta_linode_specs_vcpus: the number of VCPUS this Linode has access to
• __meta_linode_specs_transfer_bytes: the amount of network transfer the Linode instance is allotted each month
• __meta_linode_extra_ips: a list of all extra IPv4 addresses assigned to the Linode instance joined by the tag separator

Component health

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

Debug information

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

Debug metrics

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

Example

river Copy

discovery.linode "example" {
    bearer_token = env("LINODE_TOKEN")
    port = 8876
}
prometheus.scrape "demo" {
	targets    = discovery.linode.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.

Using private IP address:

Copy

discovery.linode "example" {
    bearer_token = env("LINODE_TOKEN")
    port = 8876
}
discovery.relabel "private_ips" {
	targets = discovery.linode.example.targets
	rule {
    	source_labels = ["__meta_linode_private_ipv4"]
    	replacement     = "[$1]:8876"
    	target_label  = "__address__"
  	}
}
prometheus.scrape "demo" {
	targets    = discovery.relabel.private_ips.targets
	forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
	endpoint {
		url = PROMETHEUS_REMOTE_WRITE_URL
		basic_auth {
			username = USERNAME
			password = PASSWORD
		}
	}
}

Compatible components

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

• Components that consume Targets