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.digitalocean

discovery.digitalocean

discovery.digitalocean discovers DigitalOcean Droplets and exposes them as targets.

Usage

river Copy

discovery.digitalocean "LABEL" {
    // Use one of:
    // bearer_token      = BEARER_TOKEN
    // bearer_token_file = PATH_TO_BEARER_TOKEN_FILE
}

Arguments

The following arguments are supported:

The DigitalOcean API uses bearer tokens for authentication, see more about it in the DigitalOcean API documentation.

Exactly one of the bearer_token and bearer_token_file arguments must be specified to authenticate against DigitalOcean.

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 discovery.digitalocean 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:

Each target includes the following labels:

• __meta_digitalocean_droplet_id: ID of the Droplet.
• __meta_digitalocean_droplet_name: Name of the Droplet.
• __meta_digitalocean_image: The image slug (unique text identifier of the image) used to create the Droplet.
• __meta_digitalocean_image_name: Name of the image used to create the Droplet.
• __meta_digitalocean_private_ipv4: The private IPv4 address of the Droplet.
• __meta_digitalocean_public_ipv4: The public IPv4 address of the Droplet.
• __meta_digitalocean_public_ipv6: The public IPv6 address of the Droplet.
• __meta_digitalocean_region: The region the Droplet is running in.
• __meta_digitalocean_size: The size of the Droplet.
• __meta_digitalocean_status: The current status of the Droplet.
• __meta_digitalocean_features: Optional properties configured for the Droplet, such as IPV6 networking, private networking, or backups.
• __meta_digitalocean_tags: The tags assigned to the Droplet.
• __meta_digitalocean_vpc: The ID of the VPC where the Droplet is located.

Each discovered Droplet maps to one target.

Component health

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

Debug information

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

Debug metrics

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

Example

This would result in targets with __address__ labels like: 192.0.2.1:8080:

river Copy

discovery.digitalocean "example" {
  port             = 8080
  refresh_interval = "5m"
  bearer_token     = "my-secret-bearer-token"
}

prometheus.scrape "demo" {
  targets    = discovery.digitalocean.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.

Compatible components

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

• Components that consume Targets