···
mkDefOpt = type: defaultStr: description: mkOpt type (description + ''
+
Defaults to ````${defaultStr}```` in prometheus
mkOpt = type: description: mkOption {
type = types.nullOr type;
+
description = lib.mdDoc description;
mkSdConfigModule = extraOptions: types.submodule {
···
credentials = mkOpt types.str ''
+
Sets the credentials. It is mutually exclusive with `credentials_file`.
credentials_file = mkOpt types.str ''
Sets the credentials to the credentials read from the configured file.
+
It is mutually exclusive with `credentials`.
+
Optional `Authorization` header configuration.
oauth2 = mkOpt promtypes.oauth2 ''
···
client_secret_file = mkOpt types.str ''
+
Read the client secret from a file. It is mutually exclusive with `client_secret`.
scopes = mkOpt (types.listOf types.str) ''
···
If honor_labels is set to "false", label conflicts are
resolved by renaming conflicting labels in the scraped data
+
to "exported_\<original-label\>" (for example
"exported_instance", "exported_job") and then attaching
server-side labels. This is useful for use cases such as
federation, where all labels specified in the target should
···
honor_timestamps controls whether Prometheus respects the timestamps present
+
If honor_timestamps is set to `true`, the timestamps of the metrics exposed
by the target will be used.
+
If honor_timestamps is set to `false`, the timestamps of the metrics exposed
by the target will be ignored.
···
basic_auth = mkOpt promTypes.basic_auth ''
+
Sets the `Authorization` header on every scrape request with the
configured username and password.
password and password_file are mutually exclusive.
bearer_token = mkOpt types.str ''
+
Sets the `Authorization` header on every scrape request with
the configured bearer token. It is mutually exclusive with
+
{option}`bearer_token_file`.
bearer_token_file = mkOpt types.str ''
+
Sets the `Authorization` header on every scrape request with
the bearer token read from the configured file. It is mutually
+
exclusive with {option}`bearer_token`.
tls_config = mkOpt promTypes.tls_config ''
···
gce_sd_configs = mkOpt (types.listOf promTypes.gce_sd_config) ''
List of Google Compute Engine service discovery configurations.
+
See [the relevant Prometheus configuration docs](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config)
···
allow_stale = mkOpt types.bool ''
Allow stale Consul results
+
(see <https://www.consul.io/api/index.html#consistency-modes>).
Will reduce load on Consul.
···
port = mkDefOpt types.int "80" ''
+
The port to scrape metrics from, when `role` is nodes, and for discovered
tasks and services that don't have published ports.
···
+
description = lib.mdDoc ''
Name of the filter. The available filters are listed in the upstream documentation:
+
Services: <https://docs.docker.com/engine/api/v1.40/#operation/ServiceList>
+
Tasks: <https://docs.docker.com/engine/api/v1.40/#operation/TaskList>
+
Nodes: <https://docs.docker.com/engine/api/v1.40/#operation/NodeList>
+
description = lib.mdDoc ''
···
access_key = mkOpt types.str ''
The AWS API key id. If blank, the environment variable
+
`AWS_ACCESS_KEY_ID` is used.
secret_key = mkOpt types.str ''
The AWS API key secret. If blank, the environment variable
+
`AWS_SECRET_ACCESS_KEY` is used.
profile = mkOpt types.str ''
···
+
description = lib.mdDoc ''
+
See [this list](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
for the available filters.
···
type = types.listOf types.str;
+
description = lib.mdDoc ''
···
filter = mkOpt types.str ''
Filter can be used optionally to filter the instance list by other
criteria Syntax of this filter string is described here in the filter
+
query parameter section: <https://cloud.google.com/compute/docs/reference/latest/instances/list>.
refresh_interval = mkDefOpt types.str "60s" ''
···
The tag separator used to separate concatenated GCE instance network tags.
See the GCP documentation on network tags for more information:
+
<https://cloud.google.com/vpc/docs/add-remove-network-tags>
···
+
description = lib.mdDoc ''
···
access_key = mkOpt types.str ''
+
The AWS API keys. If blank, the environment variable `AWS_ACCESS_KEY_ID` is used.
secret_key = mkOpt types.str ''
+
The AWS API keys. If blank, the environment variable `AWS_SECRET_ACCESS_KEY` is used.
profile = mkOpt types.str ''
···
auth_token = mkOpt types.str ''
Optional authentication information for token-based authentication:
+
<https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token>
+
It is mutually exclusive with `auth_token_file` and other authentication mechanisms.
auth_token_file = mkOpt types.str ''
Optional authentication information for token-based authentication:
+
<https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token>
+
It is mutually exclusive with `auth_token` and other authentication mechanisms.
···
secret_key = mkOpt types.str ''
Secret key to use when listing targets. https://console.scaleway.com/project/credentials
+
It is mutually exclusive with `secret_key_file`.
secret_key_file = mkOpt types.str ''
Sets the secret key with the credentials read from the configured file.
+
It is mutually exclusive with `secret_key`.
···
groups = mkOpt (types.listOf types.str) ''
+
A list of groups for which targets are retrieved, only supported when targeting the `container` role.
If omitted all containers owned by the requesting account are scraped.
···
basic_auth = mkOpt promTypes.basic_auth ''
+
Sets the `Authorization` header on every remote write request with the
configured username and password.
password and password_file are mutually exclusive.
bearer_token = mkOpt types.str ''
+
Sets the `Authorization` header on every remote write request with
+
the configured bearer token. It is mutually exclusive with `bearer_token_file`.
bearer_token_file = mkOpt types.str ''
+
Sets the `Authorization` header on every remote write request with the bearer token
+
read from the configured file. It is mutually exclusive with `bearer_token`.
tls_config = mkOpt promTypes.tls_config ''
Configures the remote write request's TLS settings.
···
the local storage should have complete data for.
basic_auth = mkOpt promTypes.basic_auth ''
+
Sets the `Authorization` header on every remote read request with the
configured username and password.
password and password_file are mutually exclusive.
bearer_token = mkOpt types.str ''
+
Sets the `Authorization` header on every remote read request with
+
the configured bearer token. It is mutually exclusive with `bearer_token_file`.
bearer_token_file = mkOpt types.str ''
+
Sets the `Authorization` header on every remote read request with the bearer token
+
read from the configured file. It is mutually exclusive with `bearer_token`.
tls_config = mkOpt promTypes.tls_config ''
Configures the remote read request's TLS settings.
pyrox.dev