General availability (GA) Open source

import.http

import.http retrieves a module from an HTTP server.

Use import.http to load Alloy configuration from a remote HTTP server. The remote file must define configuration inside a declare block. Alloy evaluates imported modules as reusable components, so the remote file must not include top-level global configuration blocks such as logging or remotecfg. Global configuration belongs in the local configuration file that imports the module. You must configure command-line flags outside the module. Alloy periodically polls the URL to detect and apply configuration changes.

Refer to Load configuration from remote sources for more information.

Usage

Alloy
import.http "<LABEL>" {
  url = <URL>
}

Arguments

You can use the following arguments with import.http:

NameTypeDescriptionDefaultRequired
urlstringURL to poll.yes
headersmap(string)Custom headers for the request.{}no
methodstringHTTP method for the request."GET"no
poll_frequencydurationFrequency to poll the URL."1m"no
poll_timeoutdurationTimeout when polling the URL."10s"no

Blocks

You can use the following blocks with import.http:

BlockDescriptionRequired
clientHTTP client settings when connecting to the endpoint.no
client > authorizationConfigure generic authorization to the endpoint.no
client > basic_authConfigure basic_auth for authenticating to the endpoint.no
client > oauth2Configure OAuth 2.0 for authenticating to the endpoint.no
client > oauth2 > tls_configConfigure TLS settings for connecting to the endpoint.no
client > tls_configConfigure TLS settings for connecting to the endpoint.no

The > symbol indicates deeper levels of nesting. For example, client > basic_auth refers to a basic_auth block defined inside a client block.

client

The client block configures settings for connecting to the HTTP server.

NameTypeDescriptionDefaultRequired
bearer_token_filestringFile containing a bearer token to authenticate with.no
bearer_tokensecretBearer token to authenticate with.no
enable_http2boolWhether HTTP2 is supported for requests.trueno
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
http_headersmap(list(secret))Custom HTTP headers to be sent along with each request. The map key is the header name.no
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

bearer_token, bearer_token_file, basic_auth, authorization, and oauth2 are mutually exclusive, and only one can be provided inside of a http_client_config 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.

authorization

The authorization block configures custom authorization for polling the configured URL.

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

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

Warning

Using credentials_file causes the file to be read on every outgoing request. Use the local.file component with the credentials attribute instead to avoid unnecessary reads.

basic_auth

The basic_auth block configures basic authentication for polling the configured URL.

NameTypeDescriptionDefaultRequired
password_filestringFile containing the basic auth password.no
passwordsecretBasic auth password.no
usernamestringBasic auth username.no

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

Warning

Using password_file causes the file to be read on every outgoing request. Use the local.file component with the password attribute instead to avoid unnecessary reads.

oauth2

The oauth2 block configures OAuth 2.0 authorization for polling the configured URL.

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

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

Warning

Using client_secret_file causes the file to be read on every outgoing request. Use the local.file component with the client_secret attribute instead to avoid unnecessary reads.

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

The tls_config block configures TLS settings for connecting to HTTPS servers.

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 isn’t 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)

Behavior when the remote server is unavailable

  • Initial evaluation in this process: A failed fetch means the configuration that imports the remote module fails to evaluate, so nothing that only the remote module would define runs.
  • After at least one successful fetch in this process: A failed poll keeps the running configuration on the last successfully loaded module in memory; Alloy retries at each poll_frequency interval.

The first evaluation happens when Alloy evaluates import.http during startup or when it reapplies configuration after a change. If that fetch fails, there’s no remote module content from this process to fall back on.

Remote module contents aren’t persisted across process restarts. On a cold start or restart, Alloy must again successfully complete the initial fetch. If the remote server is unavailable at that time, evaluation of the configuration that uses import.http fails.

Alloy writes configuration retrieval errors to the logs in all of these cases, which you can use for troubleshooting and alerting.

Monitor configuration fetch failures

To detect configuration update problems early, monitor for repeated fetch failures:

  • Check collector logs for repeated HTTP errors when retrieving remote modules.
  • Investigate persistent 4xx errors, which indicate authentication or URL configuration issues.
  • Investigate persistent 5xx errors, which indicate remote server problems.
  • Verify network connectivity and proxy configuration if requests time out.

If configuration updates are critical for your deployment, consider adding alerting based on log monitoring or collector health checks.

Example

This example imports custom components from an HTTP response and instantiates a custom component for adding two numbers.

Create a module file and host it on your HTTP server:

Alloy
declare "add" {
  argument "a" {}
  argument "b" {}

  export "sum" {
    value = argument.a.value + argument.b.value
  }
}

In your local configuration file, import the remote module and use the declared component:

Alloy
import.http "math" {
  url = <SERVER_URL>
}

math.add "default" {
  a = 15
  b = 45
}

Load configuration from a remote HTTP server

You can use import.http to load an Alloy configuration containing standard components from a remote HTTP server.

The following example shows how to load a Prometheus scrape configuration from a remote server.

Create a module file and host it on your HTTP server:

Alloy
declare "scrape" {
  argument "targets" {}
  argument "forward_to" {}

  prometheus.scrape "default" {
    targets    = argument.targets.value
    forward_to = argument.forward_to.value
  }
}

In your local configuration file, import the remote module and use the declared component:

Alloy
import.http "remote" {
  url            = "http://config-server.example.com/prometheus_scrape.alloy"
  poll_frequency = "5m"
}

prometheus.remote_write "default" {
  endpoint {
    url = "http://mimir:9009/api/v1/push"
  }
}

remote.scrape "app" {
  targets    = [{"__address__" = "localhost:8080"}]
  forward_to = [prometheus.remote_write.default.receiver]
}