···
mkDefOpt = type: defaultStr: description: mkOpt type (description + ''
102
-
Defaults to <literal>${defaultStr}</literal> in prometheus
103
-
when set to <literal>null</literal>.
102
+
Defaults to ````${defaultStr}```` in prometheus
103
+
when set to `null`.
mkOpt = type: description: mkOption {
type = types.nullOr type;
109
-
inherit description;
109
+
description = lib.mdDoc description;
mkSdConfigModule = extraOptions: types.submodule {
···
credentials = mkOpt types.str ''
126
-
Sets the credentials. It is mutually exclusive with <literal>credentials_file</literal>.
126
+
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.
131
-
It is mutually exclusive with <literal>credentials</literal>.
131
+
It is mutually exclusive with `credentials`.
135
-
Optional <literal>Authorization</literal> header configuration.
135
+
Optional `Authorization` header configuration.
oauth2 = mkOpt promtypes.oauth2 ''
···
client_secret_file = mkOpt types.str ''
232
-
Read the client secret from a file. It is mutually exclusive with <literal>client_secret</literal>.
232
+
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
291
-
to "exported_<original-label>" (for example
291
+
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
302
-
If honor_timestamps is set to <literal>true</literal>, the timestamps of the metrics exposed
302
+
If honor_timestamps is set to `true`, the timestamps of the metrics exposed
by the target will be used.
305
-
If honor_timestamps is set to <literal>false</literal>, the timestamps of the metrics exposed
305
+
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 ''
318
-
Sets the <literal>Authorization</literal> header on every scrape request with the
318
+
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 ''
324
-
Sets the <literal>Authorization</literal> header on every scrape request with
324
+
Sets the `Authorization` header on every scrape request with
the configured bearer token. It is mutually exclusive with
326
-
<option>bearer_token_file</option>.
326
+
{option}`bearer_token_file`.
bearer_token_file = mkOpt types.str ''
330
-
Sets the <literal>Authorization</literal> header on every scrape request with
330
+
Sets the `Authorization` header on every scrape request with
the bearer token read from the configured file. It is mutually
332
-
exclusive with <option>bearer_token</option>.
332
+
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.
382
-
See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config">the relevant Prometheus configuration docs</link>
382
+
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
594
-
(see <link xlink:href="https://www.consul.io/api/index.html#consistency-modes"/>).
594
+
(see <https://www.consul.io/api/index.html#consistency-modes>).
Will reduce load on Consul.
···
port = mkDefOpt types.int "80" ''
626
-
The port to scrape metrics from, when <literal>role</literal> is nodes, and for discovered
626
+
The port to scrape metrics from, when `role` is nodes, and for discovered
tasks and services that don't have published ports.
···
635
+
description = lib.mdDoc ''
Name of the filter. The available filters are listed in the upstream documentation:
637
-
Services: <link xlink:href="https://docs.docker.com/engine/api/v1.40/#operation/ServiceList"/>
638
-
Tasks: <link xlink:href="https://docs.docker.com/engine/api/v1.40/#operation/TaskList"/>
639
-
Nodes: <link xlink:href="https://docs.docker.com/engine/api/v1.40/#operation/NodeList"/>
637
+
Services: <https://docs.docker.com/engine/api/v1.40/#operation/ServiceList>
638
+
Tasks: <https://docs.docker.com/engine/api/v1.40/#operation/TaskList>
639
+
Nodes: <https://docs.docker.com/engine/api/v1.40/#operation/NodeList>
644
+
description = lib.mdDoc ''
···
access_key = mkOpt types.str ''
The AWS API key id. If blank, the environment variable
710
-
<literal>AWS_ACCESS_KEY_ID</literal> is used.
710
+
`AWS_ACCESS_KEY_ID` is used.
secret_key = mkOpt types.str ''
The AWS API key secret. If blank, the environment variable
715
-
<literal>AWS_SECRET_ACCESS_KEY</literal> is used.
715
+
`AWS_SECRET_ACCESS_KEY` is used.
profile = mkOpt types.str ''
···
742
-
See <link xlink:href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">this list</link>
741
+
description = lib.mdDoc ''
742
+
See [this list](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
for the available filters.
···
type = types.listOf types.str;
750
+
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
809
-
query parameter section: <link xlink:href="https://cloud.google.com/compute/docs/reference/latest/instances/list"/>.
809
+
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:
825
-
<link xlink:href="https://cloud.google.com/vpc/docs/add-remove-network-tags"/>
825
+
<https://cloud.google.com/vpc/docs/add-remove-network-tags>
···
920
+
description = lib.mdDoc ''
···
access_key = mkOpt types.str ''
979
-
The AWS API keys. If blank, the environment variable <literal>AWS_ACCESS_KEY_ID</literal> is used.
979
+
The AWS API keys. If blank, the environment variable `AWS_ACCESS_KEY_ID` is used.
secret_key = mkOpt types.str ''
983
-
The AWS API keys. If blank, the environment variable <literal>AWS_SECRET_ACCESS_KEY</literal> is used.
983
+
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:
1033
-
<link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/>
1034
-
It is mutually exclusive with <literal>auth_token_file</literal> and other authentication mechanisms.
1033
+
<https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token>
1034
+
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:
1039
-
<link xlink:href="https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token"/>
1040
-
It is mutually exclusive with <literal>auth_token</literal> and other authentication mechanisms.
1039
+
<https://docs.mesosphere.com/1.11/security/ent/iam-api/#passing-an-authentication-token>
1040
+
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
1208
-
It is mutually exclusive with <literal>secret_key_file</literal>.
1208
+
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.
1213
-
It is mutually exclusive with <literal>secret_key</literal>.
1213
+
It is mutually exclusive with `secret_key`.
···
groups = mkOpt (types.listOf types.str) ''
1302
-
A list of groups for which targets are retrieved, only supported when targeting the <literal>container</literal> role.
1302
+
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 ''
1443
-
Sets the <literal>Authorization</literal> header on every remote write request with the
1443
+
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 ''
1448
-
Sets the <literal>Authorization</literal> header on every remote write request with
1449
-
the configured bearer token. It is mutually exclusive with <literal>bearer_token_file</literal>.
1448
+
Sets the `Authorization` header on every remote write request with
1449
+
the configured bearer token. It is mutually exclusive with `bearer_token_file`.
bearer_token_file = mkOpt types.str ''
1452
-
Sets the <literal>Authorization</literal> header on every remote write request with the bearer token
1453
-
read from the configured file. It is mutually exclusive with <literal>bearer_token</literal>.
1452
+
Sets the `Authorization` header on every remote write request with the bearer token
1453
+
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 ''
1534
-
Sets the <literal>Authorization</literal> header on every remote read request with the
1534
+
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 ''
1539
-
Sets the <literal>Authorization</literal> header on every remote read request with
1540
-
the configured bearer token. It is mutually exclusive with <literal>bearer_token_file</literal>.
1539
+
Sets the `Authorization` header on every remote read request with
1540
+
the configured bearer token. It is mutually exclusive with `bearer_token_file`.
bearer_token_file = mkOpt types.str ''
1543
-
Sets the <literal>Authorization</literal> header on every remote read request with the bearer token
1544
-
read from the configured file. It is mutually exclusive with <literal>bearer_token</literal>.
1543
+
Sets the `Authorization` header on every remote read request with the bearer token
1544
+
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