Grafana Cloud

Public preview

remotecfg block

Public preview: This is a public preview component. Public preview components are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case.

remotecfg is an optional configuration block that enables Alloy to fetch and load the configuration from a remote endpoint. remotecfg is specified without a label and can only be provided once per configuration file.

The API definition for managing and fetching configuration that the remotecfg block uses is available under the Apache 2.0 license.


remotecfg {
    url = "SERVICE_URL"
    basic_auth {
        username      = "USERNAME"
        password_file = "PASSWORD_FILE"

    id             = constants.hostname
    metadata       = {"cluster" = "dev", "namespace" = "otlp-dev"}
    poll_frequency = "5m"


The following arguments are supported:

urlstringThe address of the API to poll for configuration.""no
idstringA self-reported ID.see belowno
metadatamap(string)A set of self-reported metadata.{}no
poll_frequencydurationHow often to poll the API for new configuration."1m"no

If the url is not set, then the service block is a no-op.

If not set, the self-reported id that Alloy uses is a randomly generated, anonymous unique ID (UUID) that is stored as an alloy_seed.json file in Alloy’s storage path so that it can persist across restarts.

The id and metadata fields are used in the periodic request sent to the remote endpoint so that the API can decide what configuration to serve.


The following blocks are supported inside the definition of remotecfg:

basic_authbasic_authConfigure basic_auth for authenticating to the
authorizationauthorizationConfigure generic authorization to the
oauth2oauth2Configure OAuth2 for authenticating to the
oauth2 > tls_configtls_configConfigure TLS settings for connecting to the
tls_configtls_configConfigure TLS settings for connecting to the

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_filestringFile containing the basic auth
passwordsecretBasic auth
usernamestringBasic auth

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

authorization block

credentials_filestringFile containing the secret
typestringAuthorization type, for example, “Bearer”.no

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

oauth2 block

client_idstringOAuth2 client
client_secret_filestringFile containing the OAuth2 client
client_secretsecretOAuth2 client
endpoint_paramsmap(string)Optional parameters to append to the token
proxy_urlstringHTTP proxy to send requests
no_proxystringComma-separated list of IP addresses, CIDR notations, and domain names to exclude from
proxy_from_environmentboolUse the proxy URL indicated by environment variables.falseno
proxy_connect_headermap(list(secret))Specifies headers to send to proxies during CONNECT
scopeslist(string)List of scopes to authenticate
token_urlstringURL to fetch the token

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

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

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)