Menu
Open source

discovery.azure

discovery.azure discovers Azure Virtual Machines and exposes them as targets.

Usage

river
discovery.azure "LABEL" {
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
environmentstringAzure environment."AzurePublicCloud"no
portnumberPort to be appended to the __address__ label for each target.80no
subscription_idstringAzure subscription ID.no
refresh_intervaldurationInterval at which to refresh the list of targets.5mno
proxy_urlstringHTTP proxy to send requests through.no
no_proxystringComma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying.no
proxy_from_environmentboolUse the proxy URL indicated by environment variables.falseno
proxy_connect_headermap(list(secret))Specifies headers to send to proxies during CONNECT requests.no
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http2boolWhether HTTP2 is supported for requests.trueno

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.azure:

HierarchyBlockDescriptionRequired
oauthoauthOAuth configuration for Azure API.no
managed_identitymanaged_identityManaged Identity configuration for Azure API.no
tls_configtls_configTLS configuration for requests to the Azure API.no

Exactly one of the oauth or managed_identity blocks must be specified.

oauth block

The oauth block configures OAuth authentication for the Azure API.

NameTypeDescriptionDefaultRequired
client_idstringOAuth client ID.yes
client_secretstringOAuth client secret.yes
tenant_idstringOAuth tenant ID.yes

managed_identity block

The managed_identity block configures Managed Identity authentication for the Azure API.

NameTypeDescriptionDefaultRequired
client_idstringManaged Identity client ID.yes

tls_config block

NameTypeDescriptionDefaultRequired
ca_pemstringCA PEM-encoded text to validate the server with.no
ca_filestringCA certificate to validate the server with.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
cert_filestringCertificate file for client authentication.no
insecure_skip_verifyboolDisables validation of the server certificate.no
key_filestringKey file for client authentication.no
key_pemsecretKey PEM-encoded text for client authentication.no
min_versionstringMinimum acceptable TLS version.no
server_namestringServerName extension to indicate the name of the server.no

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:

NameTypeDescription
targetslist(map(string))The set of targets discovered from the Azure API.

Each target includes the following labels:

  • __meta_azure_subscription_id: The Azure subscription ID.
  • __meta_azure_tenant_id: The Azure tenant ID.
  • __meta_azure_machine_id: The UUID of the Azure VM.
  • __meta_azure_machine_resource_group: The name of the resource group the VM is in.
  • __meta_azure_machine_name: The name of the VM.
  • __meta_azure_machine_computer_name: The host OS name of the VM.
  • __meta_azure_machine_os_type: The OS the VM is running (either Linux or Windows).
  • __meta_azure_machine_location: The region the VM is in.
  • __meta_azure_machine_private_ip: The private IP address of the VM.
  • __meta_azure_machine_public_ip: The public IP address of the VM.
  • __meta_azure_machine_tag_*: A tag on the VM. There will be one label per tag.
  • __meta_azure_machine_scale_set: The name of the scale set the VM is in.
  • __meta_azure_machine_size: The size of the VM.

Each discovered VM maps to a single target. The __address__ label is set to the private_ip:port ([private_ip]:port if the private IP is an IPv6 address) of the VM.

Component health

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

Debug information

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

Debug metrics

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

Example

river
discovery.azure "example" {
  port = 80
  subscription_id = AZURE_SUBSCRIPTION_ID
  oauth {
      client_id = AZURE_CLIENT_ID
      client_secret = AZURE_CLIENT_SECRET
      tenant_id = AZURE_TENANT_ID
  }
}

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

  • AZURE_SUBSCRIPTION_ID: Your Azure subscription ID.
  • AZURE_CLIENT_ID: Your Azure client ID.
  • AZURE_CLIENT_SECRET: Your Azure client secret.
  • AZURE_TENANT_ID: Your Azure tenant ID.
  • 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.azure has exports that can be consumed by the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.