Documentation Grafana Alloy Reference Components discovery 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

alloy Copy

discovery.linode "<LABEL>" {
    bearer_token = "<LINODE_API_TOKEN>"
}

Arguments

You can use the following arguments with discovery.linode:

At most, one of the following can be provided:

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

Blocks

You can use the following blocks with 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.

authorization

The authorization block configures generic authorization to the endpoint.

basic_auth

The basic_auth block configures basic authentication to the endpoint.

oauth2

The oauth block configures OAuth 2.0 authentication to the endpoint.

tls_config

The tls_config block configures TLS settings for connecting to the endpoint.

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_backups: The backup service status of the Linode instance.
• __meta_linode_extra_ips: A list of all extra IPv4 addresses assigned to the Linode instance joined by the tag separator.
• __meta_linode_group: The display group a Linode instance is a member of.
• __meta_linode_gpus: The number of GPUs of the Linode instance.
• __meta_linode_hypervisor: The virtualization software powering the Linode instance.
• __meta_linode_image: The slug of the Linode instance’s image.
• __meta_linode_instance_id: The ID of the Linode instance.
• __meta_linode_instance_label: The label of the Linode instance.
• __meta_linode_private_ipv4: The private IPv4 of the Linode instance.
• __meta_linode_private_ipv4_rdns: The reverse DNS for the first private IPv4 of the Linode instance.
• __meta_linode_public_ipv4: The public IPv4 of the Linode instance.
• __meta_linode_public_ipv4_rdns: The reverse DNS for the first public IPv4 of the Linode instance.
• __meta_linode_public_ipv6: The public IPv6 of the Linode instance.
• __meta_linode_public_ipv6_rdns: The reverse DNS for the first public IPv6 of the Linode instance.
• __meta_linode_region: The region 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_transfer_bytes: The amount of network transfer the Linode instance is allotted each month.
• __meta_linode_specs_vcpus: The number of VCPUS this Linode has access to.
• __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_type: The type of the Linode instance.
• __meta_linode_ipv6_ranges: A list of IPv6 ranges with mask 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 doesn’t expose any component-specific debug information.

Debug metrics

discovery.linode doesn’t expose any component-specific debug metrics.

Example

alloy Copy

discovery.linode "example" {
    bearer_token = sys.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.

Use a private IP address

alloy Copy

discovery.linode "example" {
    bearer_token = sys.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>
        }
    }
}

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

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

• Components that consume Targets