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.
discovery.marathon
discovery.marathon allows you to retrieve scrape targets from Marathon’s Service API.
Usage
discovery.marathon "LABEL" {
servers = [MARATHON_SERVER1, MARATHON_SERVER2...]
}Arguments
The following arguments are supported:
At most, one of the following can be provided:
auth_tokenargument.auth_token_fileargument.bearer_token_fileargument.bearer_tokenargument.basic_authblock.authorizationblock.oauth2block.
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.marathon:
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 and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.
authorization block
credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.
oauth2 block
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
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pemandca_filecert_pemandcert_filekey_pemandkey_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:
Each target includes the following labels:
__meta_marathon_app: the name of the app (with slashes replaced by dashes).__meta_marathon_image: the name of the Docker image used (if available).__meta_marathon_task: the ID of the Mesos task.__meta_marathon_app_label_<labelname>: any Marathon labels attached to the app.__meta_marathon_port_definition_label_<labelname>: the port definition labels.__meta_marathon_port_mapping_label_<labelname>: the port mapping labels.__meta_marathon_port_index: the port index number (e.g. 1 for PORT1).
Component health
discovery.marathon is only reported as unhealthy when given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
discovery.marathon does not expose any component-specific debug information.
Debug metrics
discovery.marathon does not expose any component-specific debug metrics.
Example
This example discovers targets from a Marathon server:
discovery.marathon "example" {
servers = ["localhost:8500"]
}
prometheus.scrape "demo" {
targets = discovery.marathon.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.marathon has exports that can be consumed by the following components:
- Components that consume Targets
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.



