From 9848cc81facf9b0075e7e1dbcb85e80140521d94 Mon Sep 17 00:00:00 2001 From: Yann Armelin Date: Tue, 29 Jul 2025 17:17:13 +0200 Subject: [PATCH 1/3] docs(json-specs): improve descriptions and examples --- .../templates/configuration/instances/db.yaml | 79 +++++++++---------- .../configuration/instances/http.yaml | 4 +- .../configuration/instances/openmetrics.yaml | 75 +++++++++++------- elastic/assets/configuration/spec.yaml | 21 +++-- zk/assets/configuration/spec.yaml | 3 + 5 files changed, 99 insertions(+), 83 deletions(-) diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/db.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/db.yaml index 740acb624b51f..acac301a3097d 100644 --- a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/db.yaml +++ b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/db.yaml @@ -20,51 +20,48 @@ Each query must have 2 fields, and can have a third optional field: 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - Use the pipe `|` if you require a multi-line script. + Use the pipe `|` if you require a multi-line script. 2. columns - The list representing each column, ordered sequentially from left to right. - The number of columns must equal the number of columns returned in the query. - There are 2 required pieces of data: - a. name - The suffix to append to `.` to form - the full metric name. If `type` is a `tag` type, this column is - considered a tag and applied to every - metric collected by this particular query. - b. type - The submission method (gauge, monotonic_count, etc.). - This can also be set to the following `tag` types to - tag each metric in the row with the name and value - of the item in this column: - i. tag - This is the default tag type - ii. tag_list - This allows multiple values to be attached - to the tag name. For example: - - query = { - "name": "example", - "query": "...", - "columns": [ - {"name": "server_tag", "type": "tag_list"}, - {"name": "foo", "type": "gauge"}, - ] - } - - May result in: - gauge("foo", tags=[ - "server_tag:us", - "server_tag:primary", - "server_tag:default" - ]) - gauge("foo", tags=["server_tag:eu"]) - gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - iii. tag_not_null - This only sets tags in the metric if the value is not null - You can use the `count` type to perform aggregation - for queries that return multiple rows with the same or no tags. - Columns without a name are ignored. To skip a column, enter: - - {} + The number of columns must equal the number of columns returned in the query. + There are 2 required pieces of data: + 1. name - The suffix to append to `.` to form + the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + to every metric collected by this particular query. + 2. type - The submission method (gauge, monotonic_count, etc.). + This can also be set to the following `tag` types to tag each metric in the row with the name + and value of the item in this column: + 1. tag - This is the default tag type + 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ``` + query = { + "name": "example", + "query": "...", + "columns": [ + {"name": "server_tag", "type": "tag_list"}, + {"name": "foo", "type": "gauge"}, + ] + } + ``` + May result in: + ``` + gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + gauge("foo", tags=["server_tag:eu"]) + gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ``` + 3. tag_not_null - This only sets tags in the metric if the value is not null + You can use the `count` type to perform aggregation for queries that return multiple rows with + the same or no tags. + Columns without a name are ignored. To skip a column, enter: + ``` + - {} + ``` 3. tags (optional) - A list of tags to apply to each metric. 4. collection_interval (optional) - The frequency at which to collect the metrics. If collection_interval is not set, the query will be run every check run. - If the collection interval is less than check collection interval, - the query will be run every check run. - If the collection interval is greater than check collection interval, - the query will NOT BE RUN exactly at the collection interval. + If the collection interval is less than check collection interval, the query will be run every check + run. + If the collection interval is greater than check collection interval, the query will NOT BE RUN + exactly at the collection interval. The query will be run at the next check run after the collection interval has passed. 5. metric_prefix (optional) - The prefix to apply to each metric. value: diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml index 60486df0e76ed..a83f6eb521027 100644 --- a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml +++ b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/http.yaml @@ -46,7 +46,7 @@ type: string description: | The type of authentication to use. The available types (and related options) are: - + ``` - basic |__ username |__ password @@ -69,7 +69,7 @@ |__ aws_region |__ aws_host |__ aws_service - + ``` The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. /noqa Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials /noqa diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml index b53c0bd7f37a1..376b03310721c 100644 --- a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml +++ b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml @@ -28,22 +28,24 @@ 1. If the item is a string, then it represents the exposed metric name, and the sent metric name is identical. For example: - + ``` metrics: - - + ``` 2. If the item is a mapping, then the keys represent the exposed metric names. - a. If a value is a string, then it represents the sent metric name. For example: - + 1. If a value is a string, then it represents the sent metric name. For example: + ``` metrics: - : - : - b. If a value is a mapping, then it must have a `name` and, optionally, a `type` key. + ``` + 2. If a value is a mapping, then it must have a `name` and, optionally, a `type` key. The `name` represents the sent metric name, and the `type` represents how the metric should be handled, overriding any type information the endpoint may provide. For example: - + ``` metrics: - : name: @@ -51,7 +53,7 @@ - : name: type: - + ``` The supported native types are `gauge`, `counter`, `histogram`, and `summary`. Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -61,12 +63,19 @@ https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes Regular expressions may be used to match the exposed metric names, for example: - + ``` metrics: - ^network_(ingress|egress)_.+ - .+: type: gauge + ```` value: + example: + - + - : + - : + name: + type: type: array items: anyOf: @@ -92,22 +101,24 @@ 1. If the item is a string, then it represents the exposed metric name, and the sent metric name will be identical. For example: - + ``` extra_metrics: - - + ``` 2. If the item is a mapping, then the keys represent the exposed metric names. - a. If a value is a string, then it represents the sent metric name. For example: - + 1. If a value is a string, then it represents the sent metric name. For example: + ``` extra_metrics: - : - : - b. If a value is a mapping, then it must have a `name` and/or `type` key. + ``` + 2. If a value is a mapping, then it must have a `name` and/or `type` key. The `name` represents the sent metric name, and the `type` represents how the metric should be handled, overriding any type information the endpoint may provide. For example: - + ``` extra_metrics: - : name: @@ -115,7 +126,7 @@ - : name: type: - + ``` The supported native types are `gauge`, `counter`, `histogram`, and `summary`. Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -125,12 +136,19 @@ https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes Regular expressions may be used to match the exposed metric names, for example: - + ``` extra_metrics: - ^network_(ingress|egress)_.+ - .+: type: gauge + ``` value: + example: + - + - : + - : + name: + type: type: array items: anyOf: @@ -286,9 +304,9 @@ exposed metrics from which to share labels, and the values are mappings that configure the sharing behavior. Each mapping must have at least one of the following keys: - labels - This is a list of labels to share. All labels are shared if this is not set. - match - This is a list of labels to match on other metrics as a condition for sharing. - values - This is a list of allowed values as a condition for sharing. + - labels - This is a list of labels to share. All labels are shared if this is not set. + - match - This is a list of labels to match on other metrics as a condition for sharing. + - values - This is a list of allowed values as a condition for sharing. To unconditionally share all labels of a metric, set it to `true`. @@ -296,19 +314,18 @@ to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` to all other metrics if their value is equal to `23` or `42`. - - share_labels: - metric_a: true - metric_b: - labels: - - node - match: - - pod - metric_c: - values: - - 23 - - 42 value: + example: + metric_a: true + metric_b: + labels: + - node + match: + - pod + metric_c: + values: + - 23 + - 42 type: object additionalProperties: anyOf: diff --git a/elastic/assets/configuration/spec.yaml b/elastic/assets/configuration/spec.yaml index e89548516085a..99ed704f17fc8 100644 --- a/elastic/assets/configuration/spec.yaml +++ b/elastic/assets/configuration/spec.yaml @@ -136,21 +136,21 @@ files: 3. columns - The list representing the data to be collected from the JSON query. There are two required pieces of data: - a. value_path - This is the JSON path from the `data_path` to the metric. This path may include - string keys as well as list indices. For example, if querying for size of parent - circuit breaker, the `value_path` is `estimated_size_in_bytes`. - b. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a - tag and applied to every metric collected by this particular query. - - c. type (optional) - An optional parameter to designates the type of data sent. Possible values - for `type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with - `gauge` being the default. + 1. value_path - This is the JSON path from the `data_path` to the metric. This path may include string + keys as well as list indices. For example, if querying for size of parent circuit + breaker, the `value_path` is `estimated_size_in_bytes`. + 2. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a tag and + applied to every metric collected by this particular query. + 3. type (optional) - An optional parameter to designates the type of data sent. Possible values for + `type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with `gauge` being + the default. 4. payload (optional) - An optional payload can be included when querying the endpoint. This turns the GET request into a POST request, so a read-only user should be used when writing custom queries with a payload. Use YAML formatting when including a payload. - Example: + value: + example: - endpoint: /_search data_path: aggregations.genres.buckets payload: @@ -166,7 +166,6 @@ files: name: elasticsearch.doc_count tags: - custom_tag:1 - value: type: array items: type: object diff --git a/zk/assets/configuration/spec.yaml b/zk/assets/configuration/spec.yaml index 6a704a4fdd50e..860d20d261df2 100644 --- a/zk/assets/configuration/spec.yaml +++ b/zk/assets/configuration/spec.yaml @@ -36,6 +36,9 @@ files: Available options are: `leader`, `follower`, `standalone` or an array of one or more of these. value: + example: + - leader + - follower anyOf: - type: string - type: array From 409d46966cb4335d1eb95058dca91825dd18e655 Mon Sep 17 00:00:00 2001 From: Yann Armelin Date: Tue, 29 Jul 2025 17:40:28 +0200 Subject: [PATCH 2/3] docs(json-specs): regenerate examples --- .../activemq_xml/data/conf.yaml.example | 4 +- .../aerospike/data/conf.yaml.example | 58 ++++++++------ .../airflow/data/conf.yaml.example | 4 +- .../amazon_msk/data/conf.yaml.example | 58 ++++++++------ .../ambari/data/conf.yaml.example | 4 +- .../apache/data/conf.yaml.example | 4 +- .../appgate_sdp/data/conf.yaml.example | 58 ++++++++------ .../arangodb/data/conf.yaml.example | 58 ++++++++------ .../argo_rollouts/data/conf.yaml.example | 58 ++++++++------ .../argo_workflows/data/conf.yaml.example | 58 ++++++++------ .../argocd/data/conf.yaml.example | 58 ++++++++------ .../avi_vantage/data/conf.yaml.example | 58 ++++++++------ .../aws_neuron/data/conf.yaml.example | 58 ++++++++------ .../azure_iot_edge/data/conf.yaml.example | 4 +- .../boundary/data/conf.yaml.example | 58 ++++++++------ .../calico/data/conf.yaml.example | 58 ++++++++------ .../celery/data/conf.yaml.example | 58 ++++++++------ .../cert_manager/data/conf.yaml.example | 58 ++++++++------ .../cilium/data/conf.yaml.example | 58 ++++++++------ .../citrix_hypervisor/data/conf.yaml.example | 4 +- .../clickhouse/data/conf.yaml.example | 79 +++++++++---------- .../cockroachdb/data/conf.yaml.example | 58 ++++++++------ .../consul/data/conf.yaml.example | 4 +- .../coredns/data/conf.yaml.example | 51 ++++++------ .../couch/data/conf.yaml.example | 4 +- .../couchbase/data/conf.yaml.example | 4 +- .../crio/data/conf.yaml.example | 4 +- .../datadog_cluster_agent/data/auto_conf.yaml | 4 +- .../data/conf.yaml.example | 4 +- .../dcgm/data/conf.yaml.example | 58 ++++++++------ .../druid/data/conf.yaml.example | 4 +- .../ecs_fargate/data/conf.yaml.default | 4 +- .../ecs_fargate/data/conf.yaml.example | 4 +- .../eks_fargate/data/conf.yaml.default | 4 +- .../eks_fargate/data/conf.yaml.example | 4 +- .../elastic/data/conf.yaml.example | 57 +++++++------ .../envoy/data/conf.yaml.example | 58 ++++++++------ etcd/datadog_checks/etcd/data/auto_conf.yaml | 4 +- .../etcd/data/conf.yaml.example | 4 +- .../external_dns/data/conf.yaml.example | 4 +- .../falco/data/conf.yaml.example | 58 ++++++++------ .../fluentd/data/conf.yaml.example | 4 +- .../fluxcd/data/conf.yaml.example | 58 ++++++++------ .../fly_io/data/conf.yaml.example | 58 ++++++++------ .../gitlab/data/conf.yaml.example | 58 ++++++++------ .../gitlab_runner/data/conf.yaml.example | 4 +- .../go_expvar/data/conf.yaml.example | 4 +- .../haproxy/data/conf.yaml.example | 58 ++++++++------ .../harbor/data/conf.yaml.example | 4 +- .../hazelcast/data/conf.yaml.example | 4 +- .../hdfs_datanode/data/conf.yaml.example | 4 +- .../hdfs_namenode/data/conf.yaml.example | 4 +- .../http_check/data/conf.yaml.example | 4 +- .../ibm_was/data/conf.yaml.example | 4 +- .../impala/data/conf.yaml.example | 58 ++++++++------ .../istio/data/conf.yaml.example | 58 ++++++++------ .../karpenter/data/conf.yaml.example | 58 ++++++++------ .../keda/data/conf.yaml.example | 58 ++++++++------ .../kong/data/conf.yaml.example | 51 ++++++------ .../krakend/data/conf.yaml.example | 58 ++++++++------ .../data/conf.yaml.example | 4 +- .../data/conf.yaml.example | 4 +- .../kube_dns/data/conf.yaml.example | 4 +- .../data/conf.yaml.example | 4 +- .../kube_proxy/data/conf.yaml.example | 4 +- .../kube_scheduler/data/conf.yaml.example | 4 +- .../kubeflow/data/conf.yaml.example | 58 ++++++++------ .../kubelet/data/conf.yaml.default | 4 +- .../kubelet/data/conf.yaml.example | 4 +- .../data/conf.yaml.example | 58 ++++++++------ .../kubernetes_state/data/conf.yaml.example | 4 +- .../kubevirt_api/data/conf.yaml.example | 58 ++++++++------ .../data/conf.yaml.example | 58 ++++++++------ .../kubevirt_handler/data/conf.yaml.example | 58 ++++++++------ .../kuma/data/conf.yaml.example | 58 ++++++++------ .../kyototycoon/data/conf.yaml.example | 4 +- .../kyverno/data/conf.yaml.example | 58 ++++++++------ .../lighttpd/data/conf.yaml.example | 4 +- .../linkerd/data/conf.yaml.example | 58 ++++++++------ .../litellm/data/conf.yaml.example | 58 ++++++++------ .../mapreduce/data/conf.yaml.example | 4 +- .../marathon/data/conf.yaml.example | 4 +- .../marklogic/data/conf.yaml.example | 4 +- .../mesos_master/data/conf.yaml.example | 4 +- .../mesos_slave/data/conf.yaml.example | 4 +- .../milvus/data/conf.yaml.example | 58 ++++++++------ .../mysql/data/conf.yaml.example | 79 +++++++++---------- .../nginx/data/conf.yaml.example | 4 +- .../data/conf.yaml.example | 4 +- .../nvidia_nim/data/conf.yaml.example | 58 ++++++++------ .../nvidia_triton/data/conf.yaml.example | 58 ++++++++------ .../octopus_deploy/data/conf.yaml.example | 4 +- .../openmetrics/data/conf.yaml.example | 58 ++++++++------ .../oracle/data/conf.yaml.example | 79 +++++++++---------- .../php_fpm/data/conf.yaml.example | 4 +- .../postgres/data/conf.yaml.example | 79 +++++++++---------- .../powerdns_recursor/data/conf.yaml.example | 4 +- .../proxmox/data/conf.yaml.example | 4 +- .../pulsar/data/conf.yaml.example | 58 ++++++++------ .../quarkus/data/conf.yaml.example | 58 ++++++++------ .../rabbitmq/data/conf.yaml.example | 58 ++++++++------ ray/datadog_checks/ray/data/conf.yaml.example | 58 ++++++++------ .../riak/data/conf.yaml.example | 4 +- .../sap_hana/data/conf.yaml.example | 79 +++++++++---------- .../scylla/data/conf.yaml.example | 58 ++++++++------ .../silk/data/conf.yaml.example | 4 +- .../singlestore/data/conf.yaml.example | 79 +++++++++---------- .../snowflake/data/conf.yaml.example | 79 +++++++++---------- .../sonarqube/data/conf.yaml.example | 4 +- .../spark/data/conf.yaml.example | 4 +- .../sqlserver/data/conf.yaml.example | 79 +++++++++---------- .../squid/data/conf.yaml.example | 4 +- .../strimzi/data/conf.yaml.example | 58 ++++++++------ .../supabase/data/conf.yaml.example | 58 ++++++++------ .../teamcity/data/conf.yaml.example | 58 ++++++++------ .../tekton/data/conf.yaml.example | 58 ++++++++------ .../teleport/data/conf.yaml.example | 58 ++++++++------ .../temporal/data/conf.yaml.example | 58 ++++++++------ .../teradata/data/conf.yaml.example | 79 +++++++++---------- .../torchserve/data/conf.yaml.example | 66 +++++++++------- .../traefik_mesh/data/conf.yaml.example | 58 ++++++++------ .../traffic_server/data/conf.yaml.example | 4 +- .../twistlock/data/conf.yaml.example | 4 +- .../vault/data/conf.yaml.example | 58 ++++++++------ .../velero/data/conf.yaml.example | 58 ++++++++------ .../vertica/data/conf.yaml.example | 79 +++++++++---------- .../vllm/data/conf.yaml.example | 58 ++++++++------ .../voltdb/data/conf.yaml.example | 79 +++++++++---------- .../vsphere/data/conf.yaml.example | 4 +- .../weaviate/data/conf.yaml.example | 58 ++++++++------ .../yarn/data/conf.yaml.example | 4 +- zk/datadog_checks/zk/data/conf.yaml.example | 4 +- 132 files changed, 2448 insertions(+), 2138 deletions(-) diff --git a/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example b/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example index 92203ba6fdfcf..1bb49224736e0 100644 --- a/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example +++ b/activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example @@ -112,7 +112,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -135,7 +135,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/aerospike/datadog_checks/aerospike/data/conf.yaml.example b/aerospike/datadog_checks/aerospike/data/conf.yaml.example index 591bc0b793b71..81aa64b77893f 100644 --- a/aerospike/datadog_checks/aerospike/data/conf.yaml.example +++ b/aerospike/datadog_checks/aerospike/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/airflow/datadog_checks/airflow/data/conf.yaml.example b/airflow/datadog_checks/airflow/data/conf.yaml.example index ccd532b122ee2..c079a0ece319a 100644 --- a/airflow/datadog_checks/airflow/data/conf.yaml.example +++ b/airflow/datadog_checks/airflow/data/conf.yaml.example @@ -88,7 +88,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -111,7 +111,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example b/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example index 0bb9a12a68095..45f4a4026a07b 100644 --- a/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example +++ b/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example @@ -114,22 +114,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -137,7 +139,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -147,13 +149,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -266,9 +274,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -276,20 +284,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -357,7 +363,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -380,7 +386,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/ambari/datadog_checks/ambari/data/conf.yaml.example b/ambari/datadog_checks/ambari/data/conf.yaml.example index 3e68078051eb8..9d3f0863b6365 100644 --- a/ambari/datadog_checks/ambari/data/conf.yaml.example +++ b/ambari/datadog_checks/ambari/data/conf.yaml.example @@ -91,7 +91,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -114,7 +114,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/apache/datadog_checks/apache/data/conf.yaml.example b/apache/datadog_checks/apache/data/conf.yaml.example index 8cd00fea4e6c3..2fae3f67bfa26 100644 --- a/apache/datadog_checks/apache/data/conf.yaml.example +++ b/apache/datadog_checks/apache/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/appgate_sdp/datadog_checks/appgate_sdp/data/conf.yaml.example b/appgate_sdp/datadog_checks/appgate_sdp/data/conf.yaml.example index d252b504f3c05..a183bc4615c0f 100644 --- a/appgate_sdp/datadog_checks/appgate_sdp/data/conf.yaml.example +++ b/appgate_sdp/datadog_checks/appgate_sdp/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/arangodb/datadog_checks/arangodb/data/conf.yaml.example b/arangodb/datadog_checks/arangodb/data/conf.yaml.example index 1bac9c127833e..fadb06a675172 100644 --- a/arangodb/datadog_checks/arangodb/data/conf.yaml.example +++ b/arangodb/datadog_checks/arangodb/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/argo_rollouts/datadog_checks/argo_rollouts/data/conf.yaml.example b/argo_rollouts/datadog_checks/argo_rollouts/data/conf.yaml.example index 7245a529f9ae9..d893d84d05243 100644 --- a/argo_rollouts/datadog_checks/argo_rollouts/data/conf.yaml.example +++ b/argo_rollouts/datadog_checks/argo_rollouts/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/argo_workflows/datadog_checks/argo_workflows/data/conf.yaml.example b/argo_workflows/datadog_checks/argo_workflows/data/conf.yaml.example index b80799286b842..0a7abfd132322 100644 --- a/argo_workflows/datadog_checks/argo_workflows/data/conf.yaml.example +++ b/argo_workflows/datadog_checks/argo_workflows/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/argocd/datadog_checks/argocd/data/conf.yaml.example b/argocd/datadog_checks/argocd/data/conf.yaml.example index 1edb696a28ede..5e4638e94a2d9 100644 --- a/argocd/datadog_checks/argocd/data/conf.yaml.example +++ b/argocd/datadog_checks/argocd/data/conf.yaml.example @@ -89,22 +89,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -112,7 +114,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -122,13 +124,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -241,9 +249,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -251,20 +259,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -332,7 +338,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -355,7 +361,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example b/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example index cdcbc582c7b15..c4ea2478c23ba 100644 --- a/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example +++ b/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example @@ -82,22 +82,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -105,7 +107,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -115,13 +117,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -234,9 +242,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -244,20 +252,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -325,7 +331,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -348,7 +354,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/aws_neuron/datadog_checks/aws_neuron/data/conf.yaml.example b/aws_neuron/datadog_checks/aws_neuron/data/conf.yaml.example index 068d4a55ac35b..c1ef47a5d77b1 100644 --- a/aws_neuron/datadog_checks/aws_neuron/data/conf.yaml.example +++ b/aws_neuron/datadog_checks/aws_neuron/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example b/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example index 8eb002536178d..08b674bd56c84 100644 --- a/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example +++ b/azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example @@ -223,7 +223,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -246,7 +246,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/boundary/datadog_checks/boundary/data/conf.yaml.example b/boundary/datadog_checks/boundary/data/conf.yaml.example index 91823a532802c..dfbc6995c339e 100644 --- a/boundary/datadog_checks/boundary/data/conf.yaml.example +++ b/boundary/datadog_checks/boundary/data/conf.yaml.example @@ -68,22 +68,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -91,7 +93,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -101,13 +103,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -220,9 +228,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -230,20 +238,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -311,7 +317,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -334,7 +340,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/calico/datadog_checks/calico/data/conf.yaml.example b/calico/datadog_checks/calico/data/conf.yaml.example index 8ad7f8e08367d..d3cf86326c12d 100644 --- a/calico/datadog_checks/calico/data/conf.yaml.example +++ b/calico/datadog_checks/calico/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/celery/datadog_checks/celery/data/conf.yaml.example b/celery/datadog_checks/celery/data/conf.yaml.example index 2b8d1ea8413b9..2557838c7f575 100644 --- a/celery/datadog_checks/celery/data/conf.yaml.example +++ b/celery/datadog_checks/celery/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/cert_manager/datadog_checks/cert_manager/data/conf.yaml.example b/cert_manager/datadog_checks/cert_manager/data/conf.yaml.example index 8ad7f8e08367d..d3cf86326c12d 100644 --- a/cert_manager/datadog_checks/cert_manager/data/conf.yaml.example +++ b/cert_manager/datadog_checks/cert_manager/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/cilium/datadog_checks/cilium/data/conf.yaml.example b/cilium/datadog_checks/cilium/data/conf.yaml.example index cfb749a58995c..6dbf920cd9758 100644 --- a/cilium/datadog_checks/cilium/data/conf.yaml.example +++ b/cilium/datadog_checks/cilium/data/conf.yaml.example @@ -79,22 +79,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -102,7 +104,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -112,13 +114,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -231,9 +239,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -241,20 +249,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -322,7 +328,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -345,7 +351,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example b/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example index 71c0b1c23a65d..112cdf6214a04 100644 --- a/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example +++ b/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/clickhouse/datadog_checks/clickhouse/data/conf.yaml.example b/clickhouse/datadog_checks/clickhouse/data/conf.yaml.example index 1ec572d1839bf..ec9f9b4b531bf 100644 --- a/clickhouse/datadog_checks/clickhouse/data/conf.yaml.example +++ b/clickhouse/datadog_checks/clickhouse/data/conf.yaml.example @@ -103,51 +103,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example b/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example index 2ae4e4c7eecd3..439917ee790eb 100644 --- a/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example +++ b/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/consul/datadog_checks/consul/data/conf.yaml.example b/consul/datadog_checks/consul/data/conf.yaml.example index 0139b7ad7c501..30f3dfb39a956 100644 --- a/consul/datadog_checks/consul/data/conf.yaml.example +++ b/consul/datadog_checks/consul/data/conf.yaml.example @@ -181,7 +181,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -204,7 +204,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/coredns/datadog_checks/coredns/data/conf.yaml.example b/coredns/datadog_checks/coredns/data/conf.yaml.example index 7e1ddc049ae49..f02f16eb804c1 100644 --- a/coredns/datadog_checks/coredns/data/conf.yaml.example +++ b/coredns/datadog_checks/coredns/data/conf.yaml.example @@ -71,22 +71,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -94,7 +96,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -104,11 +106,12 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # # extra_metrics: # - coredns_template_matches_total: template_matches_count @@ -226,9 +229,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -236,20 +239,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -317,7 +318,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -340,7 +341,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/couch/datadog_checks/couch/data/conf.yaml.example b/couch/datadog_checks/couch/data/conf.yaml.example index c1aac80f50ced..92c0b94f8c7f1 100644 --- a/couch/datadog_checks/couch/data/conf.yaml.example +++ b/couch/datadog_checks/couch/data/conf.yaml.example @@ -182,7 +182,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -205,7 +205,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/couchbase/datadog_checks/couchbase/data/conf.yaml.example b/couchbase/datadog_checks/couchbase/data/conf.yaml.example index 3bf49ff8cfb89..0ed35c75084d5 100644 --- a/couchbase/datadog_checks/couchbase/data/conf.yaml.example +++ b/couchbase/datadog_checks/couchbase/data/conf.yaml.example @@ -101,7 +101,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -124,7 +124,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/crio/datadog_checks/crio/data/conf.yaml.example b/crio/datadog_checks/crio/data/conf.yaml.example index 7dd31f63d9b66..034f8de1ebe9b 100644 --- a/crio/datadog_checks/crio/data/conf.yaml.example +++ b/crio/datadog_checks/crio/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml index 36199549c37c3..44226d2a02033 100644 --- a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml +++ b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml @@ -226,7 +226,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -249,7 +249,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example index 3522212a65e32..191bd4ac0b670 100644 --- a/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example +++ b/datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/dcgm/datadog_checks/dcgm/data/conf.yaml.example b/dcgm/datadog_checks/dcgm/data/conf.yaml.example index 6fe1c0dbd99d9..842f9cb3e0afe 100644 --- a/dcgm/datadog_checks/dcgm/data/conf.yaml.example +++ b/dcgm/datadog_checks/dcgm/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/druid/datadog_checks/druid/data/conf.yaml.example b/druid/datadog_checks/druid/data/conf.yaml.example index 05644218ac13d..6949d85fa2d6c 100644 --- a/druid/datadog_checks/druid/data/conf.yaml.example +++ b/druid/datadog_checks/druid/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.default b/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.default index 3e99a0cecc3e3..c8a5d89f1d685 100644 --- a/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.default +++ b/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.default @@ -87,7 +87,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -110,7 +110,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.example b/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.example index 078d80f027aeb..11b40e8f03524 100644 --- a/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.example +++ b/ecs_fargate/datadog_checks/ecs_fargate/data/conf.yaml.example @@ -79,7 +79,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -102,7 +102,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.default b/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.default index 0f5dffce6934c..bb5bb55f3a087 100644 --- a/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.default +++ b/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.default @@ -87,7 +87,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -110,7 +110,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.example b/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.example index 0e912143fa197..931a5736a24d0 100644 --- a/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.example +++ b/eks_fargate/datadog_checks/eks_fargate/data/conf.yaml.example @@ -79,7 +79,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -102,7 +102,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/elastic/datadog_checks/elastic/data/conf.yaml.example b/elastic/datadog_checks/elastic/data/conf.yaml.example index 4cc22e531acab..46abf851f2e97 100644 --- a/elastic/datadog_checks/elastic/data/conf.yaml.example +++ b/elastic/datadog_checks/elastic/data/conf.yaml.example @@ -156,38 +156,35 @@ instances: ## ## 3. columns - The list representing the data to be collected from the JSON query. There are two required pieces ## of data: - ## a. value_path - This is the JSON path from the `data_path` to the metric. This path may include - ## string keys as well as list indices. For example, if querying for size of parent - ## circuit breaker, the `value_path` is `estimated_size_in_bytes`. - ## b. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a - ## tag and applied to every metric collected by this particular query. - ## - ## c. type (optional) - An optional parameter to designates the type of data sent. Possible values - ## for `type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with - ## `gauge` being the default. + ## 1. value_path - This is the JSON path from the `data_path` to the metric. This path may include string + ## keys as well as list indices. For example, if querying for size of parent circuit + ## breaker, the `value_path` is `estimated_size_in_bytes`. + ## 2. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a tag and + ## applied to every metric collected by this particular query. + ## 3. type (optional) - An optional parameter to designates the type of data sent. Possible values for + ## `type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with `gauge` being + ## the default. ## ## 4. payload (optional) - An optional payload can be included when querying the endpoint. This turns the GET ## request into a POST request, so a read-only user should be used when writing ## custom queries with a payload. Use YAML formatting when including a payload. - ## - ## Example: - ## - endpoint: /_search - ## data_path: aggregations.genres.buckets - ## payload: - ## aggs: - ## genres: - ## terms: - ## field: "id" - ## columns: - ## - value_path: key - ## name: id - ## type: tag - ## - value_path: doc_count - ## name: elasticsearch.doc_count - ## tags: - ## - custom_tag:1 - # - # custom_queries: [] + # + # custom_queries: + # - endpoint: /_search + # data_path: aggregations.genres.buckets + # payload: + # aggs: + # genres: + # terms: + # field: id + # columns: + # - value_path: key + # name: id + # type: tag + # - value_path: doc_count + # name: elasticsearch.doc_count + # tags: + # - custom_tag:1 ## @param submit_events - boolean - optional - default: true ## By default we submit events to Datadog if the cluster starts unhealthy or anytime its health changes. @@ -269,7 +266,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -292,7 +289,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/envoy/datadog_checks/envoy/data/conf.yaml.example b/envoy/datadog_checks/envoy/data/conf.yaml.example index 878036efb0dfb..4cd19ae1d3770 100644 --- a/envoy/datadog_checks/envoy/data/conf.yaml.example +++ b/envoy/datadog_checks/envoy/data/conf.yaml.example @@ -75,22 +75,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -98,7 +100,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -108,13 +110,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -227,9 +235,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -237,20 +245,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -318,7 +324,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -341,7 +347,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/etcd/datadog_checks/etcd/data/auto_conf.yaml b/etcd/datadog_checks/etcd/data/auto_conf.yaml index 38ee35fa9c23f..c2f883ef8383f 100644 --- a/etcd/datadog_checks/etcd/data/auto_conf.yaml +++ b/etcd/datadog_checks/etcd/data/auto_conf.yaml @@ -188,7 +188,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -211,7 +211,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/etcd/datadog_checks/etcd/data/conf.yaml.example b/etcd/datadog_checks/etcd/data/conf.yaml.example index 25a9c5171c50f..1fb5e1724a0f0 100644 --- a/etcd/datadog_checks/etcd/data/conf.yaml.example +++ b/etcd/datadog_checks/etcd/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/external_dns/datadog_checks/external_dns/data/conf.yaml.example b/external_dns/datadog_checks/external_dns/data/conf.yaml.example index c897381b3a81c..2332182464c54 100644 --- a/external_dns/datadog_checks/external_dns/data/conf.yaml.example +++ b/external_dns/datadog_checks/external_dns/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/falco/datadog_checks/falco/data/conf.yaml.example b/falco/datadog_checks/falco/data/conf.yaml.example index 8ad7f8e08367d..d3cf86326c12d 100644 --- a/falco/datadog_checks/falco/data/conf.yaml.example +++ b/falco/datadog_checks/falco/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/fluentd/datadog_checks/fluentd/data/conf.yaml.example b/fluentd/datadog_checks/fluentd/data/conf.yaml.example index 3739874117077..d7a77da005cb3 100644 --- a/fluentd/datadog_checks/fluentd/data/conf.yaml.example +++ b/fluentd/datadog_checks/fluentd/data/conf.yaml.example @@ -147,7 +147,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -170,7 +170,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/fluxcd/datadog_checks/fluxcd/data/conf.yaml.example b/fluxcd/datadog_checks/fluxcd/data/conf.yaml.example index 8ad7f8e08367d..d3cf86326c12d 100644 --- a/fluxcd/datadog_checks/fluxcd/data/conf.yaml.example +++ b/fluxcd/datadog_checks/fluxcd/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/fly_io/datadog_checks/fly_io/data/conf.yaml.example b/fly_io/datadog_checks/fly_io/data/conf.yaml.example index 5cf47c1c1efde..3e4b112030e3b 100644 --- a/fly_io/datadog_checks/fly_io/data/conf.yaml.example +++ b/fly_io/datadog_checks/fly_io/data/conf.yaml.example @@ -137,22 +137,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -160,7 +162,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -170,13 +172,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -289,9 +297,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -299,20 +307,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -380,7 +386,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -403,7 +409,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/gitlab/datadog_checks/gitlab/data/conf.yaml.example b/gitlab/datadog_checks/gitlab/data/conf.yaml.example index d6b2745b6394b..cd49fc001b1eb 100644 --- a/gitlab/datadog_checks/gitlab/data/conf.yaml.example +++ b/gitlab/datadog_checks/gitlab/data/conf.yaml.example @@ -90,22 +90,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -113,7 +115,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -123,13 +125,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -242,9 +250,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -252,20 +260,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -333,7 +339,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -356,7 +362,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example b/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example index e1ad376ae0831..b6cb86149828d 100644 --- a/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example +++ b/gitlab_runner/datadog_checks/gitlab_runner/data/conf.yaml.example @@ -272,7 +272,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -295,7 +295,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/go_expvar/datadog_checks/go_expvar/data/conf.yaml.example b/go_expvar/datadog_checks/go_expvar/data/conf.yaml.example index a28fa58f69548..5be92f0756fb9 100644 --- a/go_expvar/datadog_checks/go_expvar/data/conf.yaml.example +++ b/go_expvar/datadog_checks/go_expvar/data/conf.yaml.example @@ -122,7 +122,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -145,7 +145,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/haproxy/datadog_checks/haproxy/data/conf.yaml.example b/haproxy/datadog_checks/haproxy/data/conf.yaml.example index e76e16c7d4bb1..809fe81d17763 100644 --- a/haproxy/datadog_checks/haproxy/data/conf.yaml.example +++ b/haproxy/datadog_checks/haproxy/data/conf.yaml.example @@ -75,22 +75,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -98,7 +100,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -108,13 +110,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -227,9 +235,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -237,20 +245,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -318,7 +324,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -341,7 +347,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/harbor/datadog_checks/harbor/data/conf.yaml.example b/harbor/datadog_checks/harbor/data/conf.yaml.example index 822bd1acea511..d6d052b7f51fd 100644 --- a/harbor/datadog_checks/harbor/data/conf.yaml.example +++ b/harbor/datadog_checks/harbor/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example b/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example index 194b1958f315e..7da7e69c2b5cd 100644 --- a/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example +++ b/hazelcast/datadog_checks/hazelcast/data/conf.yaml.example @@ -262,7 +262,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -285,7 +285,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/hdfs_datanode/datadog_checks/hdfs_datanode/data/conf.yaml.example b/hdfs_datanode/datadog_checks/hdfs_datanode/data/conf.yaml.example index d0aa80af81f7d..ae94f716e1105 100644 --- a/hdfs_datanode/datadog_checks/hdfs_datanode/data/conf.yaml.example +++ b/hdfs_datanode/datadog_checks/hdfs_datanode/data/conf.yaml.example @@ -89,7 +89,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -112,7 +112,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/hdfs_namenode/datadog_checks/hdfs_namenode/data/conf.yaml.example b/hdfs_namenode/datadog_checks/hdfs_namenode/data/conf.yaml.example index e7131dba6647d..d2f2f57b76d14 100644 --- a/hdfs_namenode/datadog_checks/hdfs_namenode/data/conf.yaml.example +++ b/hdfs_namenode/datadog_checks/hdfs_namenode/data/conf.yaml.example @@ -89,7 +89,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -112,7 +112,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/http_check/datadog_checks/http_check/data/conf.yaml.example b/http_check/datadog_checks/http_check/data/conf.yaml.example index f326d622e7e3c..80c295b94aba7 100644 --- a/http_check/datadog_checks/http_check/data/conf.yaml.example +++ b/http_check/datadog_checks/http_check/data/conf.yaml.example @@ -267,7 +267,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -290,7 +290,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/ibm_was/datadog_checks/ibm_was/data/conf.yaml.example b/ibm_was/datadog_checks/ibm_was/data/conf.yaml.example index 52903a6ab7dfc..d607ac964470b 100644 --- a/ibm_was/datadog_checks/ibm_was/data/conf.yaml.example +++ b/ibm_was/datadog_checks/ibm_was/data/conf.yaml.example @@ -84,7 +84,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -107,7 +107,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/impala/datadog_checks/impala/data/conf.yaml.example b/impala/datadog_checks/impala/data/conf.yaml.example index 8d8e5e1565606..09b0a1b303198 100644 --- a/impala/datadog_checks/impala/data/conf.yaml.example +++ b/impala/datadog_checks/impala/data/conf.yaml.example @@ -73,22 +73,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -96,7 +98,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -106,13 +108,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -225,9 +233,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -235,20 +243,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -316,7 +322,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -339,7 +345,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/istio/datadog_checks/istio/data/conf.yaml.example b/istio/datadog_checks/istio/data/conf.yaml.example index b64395fb22319..f9d09eb9faa57 100644 --- a/istio/datadog_checks/istio/data/conf.yaml.example +++ b/istio/datadog_checks/istio/data/conf.yaml.example @@ -82,22 +82,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -105,7 +107,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -115,13 +117,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -255,9 +263,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -265,20 +273,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -346,7 +352,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -369,7 +375,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/karpenter/datadog_checks/karpenter/data/conf.yaml.example b/karpenter/datadog_checks/karpenter/data/conf.yaml.example index e13c90209b9e2..4747a82490c4f 100644 --- a/karpenter/datadog_checks/karpenter/data/conf.yaml.example +++ b/karpenter/datadog_checks/karpenter/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/keda/datadog_checks/keda/data/conf.yaml.example b/keda/datadog_checks/keda/data/conf.yaml.example index 6babfeaf70277..6a9b96e87b64f 100644 --- a/keda/datadog_checks/keda/data/conf.yaml.example +++ b/keda/datadog_checks/keda/data/conf.yaml.example @@ -32,22 +32,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -55,7 +57,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -65,13 +67,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -184,9 +192,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -194,20 +202,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -275,7 +281,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -298,7 +304,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kong/datadog_checks/kong/data/conf.yaml.example b/kong/datadog_checks/kong/data/conf.yaml.example index 33455f9c5db2b..844461d98abb3 100644 --- a/kong/datadog_checks/kong/data/conf.yaml.example +++ b/kong/datadog_checks/kong/data/conf.yaml.example @@ -73,22 +73,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -96,7 +98,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -106,11 +108,12 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # # extra_metrics: # - kong_memory_workers_lua_vms_bytes: memory.workers.lua.vms.bytes @@ -226,9 +229,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -236,20 +239,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -317,7 +318,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -340,7 +341,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/krakend/datadog_checks/krakend/data/conf.yaml.example b/krakend/datadog_checks/krakend/data/conf.yaml.example index bd72502128e4c..c744cf9d3029a 100644 --- a/krakend/datadog_checks/krakend/data/conf.yaml.example +++ b/krakend/datadog_checks/krakend/data/conf.yaml.example @@ -83,22 +83,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -106,7 +108,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -116,13 +118,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -235,9 +243,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -245,20 +253,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -326,7 +332,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -349,7 +355,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_apiserver_metrics/datadog_checks/kube_apiserver_metrics/data/conf.yaml.example b/kube_apiserver_metrics/datadog_checks/kube_apiserver_metrics/data/conf.yaml.example index 8d50071ec2969..934d5dbb1aa8a 100644 --- a/kube_apiserver_metrics/datadog_checks/kube_apiserver_metrics/data/conf.yaml.example +++ b/kube_apiserver_metrics/datadog_checks/kube_apiserver_metrics/data/conf.yaml.example @@ -225,7 +225,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -248,7 +248,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_controller_manager/datadog_checks/kube_controller_manager/data/conf.yaml.example b/kube_controller_manager/datadog_checks/kube_controller_manager/data/conf.yaml.example index a73c2148bd034..a53682e69a1b0 100644 --- a/kube_controller_manager/datadog_checks/kube_controller_manager/data/conf.yaml.example +++ b/kube_controller_manager/datadog_checks/kube_controller_manager/data/conf.yaml.example @@ -260,7 +260,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -283,7 +283,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_dns/datadog_checks/kube_dns/data/conf.yaml.example b/kube_dns/datadog_checks/kube_dns/data/conf.yaml.example index 190ec947c2027..f0dc5582dbe36 100644 --- a/kube_dns/datadog_checks/kube_dns/data/conf.yaml.example +++ b/kube_dns/datadog_checks/kube_dns/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_metrics_server/datadog_checks/kube_metrics_server/data/conf.yaml.example b/kube_metrics_server/datadog_checks/kube_metrics_server/data/conf.yaml.example index 3eea7a6a64f35..db3ea425f1e6d 100644 --- a/kube_metrics_server/datadog_checks/kube_metrics_server/data/conf.yaml.example +++ b/kube_metrics_server/datadog_checks/kube_metrics_server/data/conf.yaml.example @@ -225,7 +225,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -248,7 +248,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_proxy/datadog_checks/kube_proxy/data/conf.yaml.example b/kube_proxy/datadog_checks/kube_proxy/data/conf.yaml.example index ca943dacbd358..27c55c8dfa58c 100644 --- a/kube_proxy/datadog_checks/kube_proxy/data/conf.yaml.example +++ b/kube_proxy/datadog_checks/kube_proxy/data/conf.yaml.example @@ -218,7 +218,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -241,7 +241,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kube_scheduler/datadog_checks/kube_scheduler/data/conf.yaml.example b/kube_scheduler/datadog_checks/kube_scheduler/data/conf.yaml.example index 1a033ed758b56..b2a399e094ab6 100644 --- a/kube_scheduler/datadog_checks/kube_scheduler/data/conf.yaml.example +++ b/kube_scheduler/datadog_checks/kube_scheduler/data/conf.yaml.example @@ -239,7 +239,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -262,7 +262,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubeflow/datadog_checks/kubeflow/data/conf.yaml.example b/kubeflow/datadog_checks/kubeflow/data/conf.yaml.example index c981f006261f5..78feb6becaaaf 100644 --- a/kubeflow/datadog_checks/kubeflow/data/conf.yaml.example +++ b/kubeflow/datadog_checks/kubeflow/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubelet/datadog_checks/kubelet/data/conf.yaml.default b/kubelet/datadog_checks/kubelet/data/conf.yaml.default index 4892c5f9f4150..9a03767fb29d9 100644 --- a/kubelet/datadog_checks/kubelet/data/conf.yaml.default +++ b/kubelet/datadog_checks/kubelet/data/conf.yaml.default @@ -260,7 +260,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -283,7 +283,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubelet/datadog_checks/kubelet/data/conf.yaml.example b/kubelet/datadog_checks/kubelet/data/conf.yaml.example index 140f960731475..eae08331d2afe 100644 --- a/kubelet/datadog_checks/kubelet/data/conf.yaml.example +++ b/kubelet/datadog_checks/kubelet/data/conf.yaml.example @@ -252,7 +252,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -275,7 +275,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubernetes_cluster_autoscaler/datadog_checks/kubernetes_cluster_autoscaler/data/conf.yaml.example b/kubernetes_cluster_autoscaler/datadog_checks/kubernetes_cluster_autoscaler/data/conf.yaml.example index 5fb74a35b0125..285b18c97d073 100644 --- a/kubernetes_cluster_autoscaler/datadog_checks/kubernetes_cluster_autoscaler/data/conf.yaml.example +++ b/kubernetes_cluster_autoscaler/datadog_checks/kubernetes_cluster_autoscaler/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubernetes_state/datadog_checks/kubernetes_state/data/conf.yaml.example b/kubernetes_state/datadog_checks/kubernetes_state/data/conf.yaml.example index 2557ebaa928cf..c3b2e61685206 100644 --- a/kubernetes_state/datadog_checks/kubernetes_state/data/conf.yaml.example +++ b/kubernetes_state/datadog_checks/kubernetes_state/data/conf.yaml.example @@ -232,7 +232,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -255,7 +255,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubevirt_api/datadog_checks/kubevirt_api/data/conf.yaml.example b/kubevirt_api/datadog_checks/kubevirt_api/data/conf.yaml.example index 8c4a6301182bc..e83246ba4a071 100644 --- a/kubevirt_api/datadog_checks/kubevirt_api/data/conf.yaml.example +++ b/kubevirt_api/datadog_checks/kubevirt_api/data/conf.yaml.example @@ -79,22 +79,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -102,7 +104,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -112,13 +114,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -231,9 +239,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -241,20 +249,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -322,7 +328,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -345,7 +351,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubevirt_controller/datadog_checks/kubevirt_controller/data/conf.yaml.example b/kubevirt_controller/datadog_checks/kubevirt_controller/data/conf.yaml.example index f6cd7aa72674b..107c7dbc95218 100644 --- a/kubevirt_controller/datadog_checks/kubevirt_controller/data/conf.yaml.example +++ b/kubevirt_controller/datadog_checks/kubevirt_controller/data/conf.yaml.example @@ -79,22 +79,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -102,7 +104,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -112,13 +114,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -231,9 +239,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -241,20 +249,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -322,7 +328,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -345,7 +351,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kubevirt_handler/datadog_checks/kubevirt_handler/data/conf.yaml.example b/kubevirt_handler/datadog_checks/kubevirt_handler/data/conf.yaml.example index 21d2e3bd75945..88526b3e1c356 100644 --- a/kubevirt_handler/datadog_checks/kubevirt_handler/data/conf.yaml.example +++ b/kubevirt_handler/datadog_checks/kubevirt_handler/data/conf.yaml.example @@ -79,22 +79,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -102,7 +104,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -112,13 +114,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -231,9 +239,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -241,20 +249,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -322,7 +328,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -345,7 +351,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kuma/datadog_checks/kuma/data/conf.yaml.example b/kuma/datadog_checks/kuma/data/conf.yaml.example index c1528025f4621..df05d6862b2ba 100644 --- a/kuma/datadog_checks/kuma/data/conf.yaml.example +++ b/kuma/datadog_checks/kuma/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example b/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example index e6385ed3a21c0..74edc08d329f3 100644 --- a/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example +++ b/kyototycoon/datadog_checks/kyototycoon/data/conf.yaml.example @@ -88,7 +88,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -111,7 +111,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/kyverno/datadog_checks/kyverno/data/conf.yaml.example b/kyverno/datadog_checks/kyverno/data/conf.yaml.example index 24f971f21d5a0..916acb5606786 100644 --- a/kyverno/datadog_checks/kyverno/data/conf.yaml.example +++ b/kyverno/datadog_checks/kyverno/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/lighttpd/datadog_checks/lighttpd/data/conf.yaml.example b/lighttpd/datadog_checks/lighttpd/data/conf.yaml.example index ca9b1f98244d7..97f7f84b01fa9 100644 --- a/lighttpd/datadog_checks/lighttpd/data/conf.yaml.example +++ b/lighttpd/datadog_checks/lighttpd/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/linkerd/datadog_checks/linkerd/data/conf.yaml.example b/linkerd/datadog_checks/linkerd/data/conf.yaml.example index 7dec800da6fcd..4576df54bb4e2 100644 --- a/linkerd/datadog_checks/linkerd/data/conf.yaml.example +++ b/linkerd/datadog_checks/linkerd/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -222,9 +230,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -232,20 +240,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -313,7 +319,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -336,7 +342,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/litellm/datadog_checks/litellm/data/conf.yaml.example b/litellm/datadog_checks/litellm/data/conf.yaml.example index ec8fae0b3dae9..2ff7fbabaa461 100644 --- a/litellm/datadog_checks/litellm/data/conf.yaml.example +++ b/litellm/datadog_checks/litellm/data/conf.yaml.example @@ -70,22 +70,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -93,7 +95,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -103,13 +105,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -222,9 +230,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -232,20 +240,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -313,7 +319,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -336,7 +342,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/mapreduce/datadog_checks/mapreduce/data/conf.yaml.example b/mapreduce/datadog_checks/mapreduce/data/conf.yaml.example index 66d09f32f141d..56ffaa70b1f8c 100644 --- a/mapreduce/datadog_checks/mapreduce/data/conf.yaml.example +++ b/mapreduce/datadog_checks/mapreduce/data/conf.yaml.example @@ -145,7 +145,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -168,7 +168,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/marathon/datadog_checks/marathon/data/conf.yaml.example b/marathon/datadog_checks/marathon/data/conf.yaml.example index d74bb104a2aef..02992fb2bff47 100644 --- a/marathon/datadog_checks/marathon/data/conf.yaml.example +++ b/marathon/datadog_checks/marathon/data/conf.yaml.example @@ -139,7 +139,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -162,7 +162,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/marklogic/datadog_checks/marklogic/data/conf.yaml.example b/marklogic/datadog_checks/marklogic/data/conf.yaml.example index 3dce4140570f1..554061895b90a 100644 --- a/marklogic/datadog_checks/marklogic/data/conf.yaml.example +++ b/marklogic/datadog_checks/marklogic/data/conf.yaml.example @@ -107,7 +107,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -130,7 +130,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/mesos_master/datadog_checks/mesos_master/data/conf.yaml.example b/mesos_master/datadog_checks/mesos_master/data/conf.yaml.example index 3b077012ca06a..ebebd047b44cb 100644 --- a/mesos_master/datadog_checks/mesos_master/data/conf.yaml.example +++ b/mesos_master/datadog_checks/mesos_master/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/mesos_slave/datadog_checks/mesos_slave/data/conf.yaml.example b/mesos_slave/datadog_checks/mesos_slave/data/conf.yaml.example index 750f7d47afc8f..ca655a2df4241 100644 --- a/mesos_slave/datadog_checks/mesos_slave/data/conf.yaml.example +++ b/mesos_slave/datadog_checks/mesos_slave/data/conf.yaml.example @@ -100,7 +100,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -123,7 +123,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/milvus/datadog_checks/milvus/data/conf.yaml.example b/milvus/datadog_checks/milvus/data/conf.yaml.example index 9d13f75f52d46..b838d15aded00 100644 --- a/milvus/datadog_checks/milvus/data/conf.yaml.example +++ b/milvus/datadog_checks/milvus/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/mysql/datadog_checks/mysql/data/conf.yaml.example b/mysql/datadog_checks/mysql/data/conf.yaml.example index e1cb650f5742c..e953fff0e4f81 100644 --- a/mysql/datadog_checks/mysql/data/conf.yaml.example +++ b/mysql/datadog_checks/mysql/data/conf.yaml.example @@ -153,51 +153,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/nginx/datadog_checks/nginx/data/conf.yaml.example b/nginx/datadog_checks/nginx/data/conf.yaml.example index 6844da98a9138..994bbb301cad8 100644 --- a/nginx/datadog_checks/nginx/data/conf.yaml.example +++ b/nginx/datadog_checks/nginx/data/conf.yaml.example @@ -127,7 +127,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -150,7 +150,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/nginx_ingress_controller/datadog_checks/nginx_ingress_controller/data/conf.yaml.example b/nginx_ingress_controller/datadog_checks/nginx_ingress_controller/data/conf.yaml.example index 27661b39f929f..16cb63f808a48 100644 --- a/nginx_ingress_controller/datadog_checks/nginx_ingress_controller/data/conf.yaml.example +++ b/nginx_ingress_controller/datadog_checks/nginx_ingress_controller/data/conf.yaml.example @@ -226,7 +226,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -249,7 +249,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/nvidia_nim/datadog_checks/nvidia_nim/data/conf.yaml.example b/nvidia_nim/datadog_checks/nvidia_nim/data/conf.yaml.example index 685db51c05749..b88a85b242358 100644 --- a/nvidia_nim/datadog_checks/nvidia_nim/data/conf.yaml.example +++ b/nvidia_nim/datadog_checks/nvidia_nim/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/nvidia_triton/datadog_checks/nvidia_triton/data/conf.yaml.example b/nvidia_triton/datadog_checks/nvidia_triton/data/conf.yaml.example index 73d7f5887937b..0777bb4f83439 100644 --- a/nvidia_triton/datadog_checks/nvidia_triton/data/conf.yaml.example +++ b/nvidia_triton/datadog_checks/nvidia_triton/data/conf.yaml.example @@ -38,22 +38,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -61,7 +63,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -71,13 +73,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -190,9 +198,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -200,20 +208,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -281,7 +287,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -304,7 +310,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example b/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example index 5375b43c33795..4b26011432803 100644 --- a/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example +++ b/octopus_deploy/datadog_checks/octopus_deploy/data/conf.yaml.example @@ -327,7 +327,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -350,7 +350,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example b/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example index 5dafd4c9e489f..db16b668bfcdc 100644 --- a/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example +++ b/openmetrics/datadog_checks/openmetrics/data/conf.yaml.example @@ -68,22 +68,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name is identical. For example: - ## + ## ``` ## metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and, optionally, a `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and, optionally, a `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## metrics: ## - : ## name: @@ -91,7 +93,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -101,13 +103,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ```` # - metrics: [] + metrics: + - + - : + - : + name: + type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -225,9 +233,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -235,20 +243,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -316,7 +322,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -339,7 +345,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/oracle/datadog_checks/oracle/data/conf.yaml.example b/oracle/datadog_checks/oracle/data/conf.yaml.example index 2482c8e71519e..9694ce7a7d555 100644 --- a/oracle/datadog_checks/oracle/data/conf.yaml.example +++ b/oracle/datadog_checks/oracle/data/conf.yaml.example @@ -107,51 +107,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/php_fpm/datadog_checks/php_fpm/data/conf.yaml.example b/php_fpm/datadog_checks/php_fpm/data/conf.yaml.example index 760920e81a622..526a449705f91 100644 --- a/php_fpm/datadog_checks/php_fpm/data/conf.yaml.example +++ b/php_fpm/datadog_checks/php_fpm/data/conf.yaml.example @@ -119,7 +119,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -142,7 +142,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/postgres/datadog_checks/postgres/data/conf.yaml.example b/postgres/datadog_checks/postgres/data/conf.yaml.example index 8ad46b1bbda1f..f601634f95732 100644 --- a/postgres/datadog_checks/postgres/data/conf.yaml.example +++ b/postgres/datadog_checks/postgres/data/conf.yaml.example @@ -306,51 +306,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/powerdns_recursor/datadog_checks/powerdns_recursor/data/conf.yaml.example b/powerdns_recursor/datadog_checks/powerdns_recursor/data/conf.yaml.example index 594842701eeff..ef0f313f02746 100644 --- a/powerdns_recursor/datadog_checks/powerdns_recursor/data/conf.yaml.example +++ b/powerdns_recursor/datadog_checks/powerdns_recursor/data/conf.yaml.example @@ -108,7 +108,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -131,7 +131,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/proxmox/datadog_checks/proxmox/data/conf.yaml.example b/proxmox/datadog_checks/proxmox/data/conf.yaml.example index be985a63189bf..a7a21428d861f 100644 --- a/proxmox/datadog_checks/proxmox/data/conf.yaml.example +++ b/proxmox/datadog_checks/proxmox/data/conf.yaml.example @@ -171,7 +171,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -194,7 +194,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/pulsar/datadog_checks/pulsar/data/conf.yaml.example b/pulsar/datadog_checks/pulsar/data/conf.yaml.example index 7c3f3fcdce4fc..4a3c88090809b 100644 --- a/pulsar/datadog_checks/pulsar/data/conf.yaml.example +++ b/pulsar/datadog_checks/pulsar/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/quarkus/datadog_checks/quarkus/data/conf.yaml.example b/quarkus/datadog_checks/quarkus/data/conf.yaml.example index 34b25af8dacf9..e1d2a30861ae2 100644 --- a/quarkus/datadog_checks/quarkus/data/conf.yaml.example +++ b/quarkus/datadog_checks/quarkus/data/conf.yaml.example @@ -31,22 +31,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -54,7 +56,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -64,13 +66,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -183,9 +191,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -193,20 +201,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -274,7 +280,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -297,7 +303,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/rabbitmq/datadog_checks/rabbitmq/data/conf.yaml.example b/rabbitmq/datadog_checks/rabbitmq/data/conf.yaml.example index d38649b5e78f8..bf5efb7edca3a 100644 --- a/rabbitmq/datadog_checks/rabbitmq/data/conf.yaml.example +++ b/rabbitmq/datadog_checks/rabbitmq/data/conf.yaml.example @@ -99,22 +99,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -122,7 +124,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -132,13 +134,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -251,9 +259,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -261,20 +269,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -342,7 +348,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -365,7 +371,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/ray/datadog_checks/ray/data/conf.yaml.example b/ray/datadog_checks/ray/data/conf.yaml.example index f936fffa18dbd..663d6ff909a42 100644 --- a/ray/datadog_checks/ray/data/conf.yaml.example +++ b/ray/datadog_checks/ray/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/riak/datadog_checks/riak/data/conf.yaml.example b/riak/datadog_checks/riak/data/conf.yaml.example index 2eefd1d6bb59f..95760fe63aae5 100644 --- a/riak/datadog_checks/riak/data/conf.yaml.example +++ b/riak/datadog_checks/riak/data/conf.yaml.example @@ -83,7 +83,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -106,7 +106,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/sap_hana/datadog_checks/sap_hana/data/conf.yaml.example b/sap_hana/datadog_checks/sap_hana/data/conf.yaml.example index 07eb5f7dcf407..1bfbf6e19052a 100644 --- a/sap_hana/datadog_checks/sap_hana/data/conf.yaml.example +++ b/sap_hana/datadog_checks/sap_hana/data/conf.yaml.example @@ -99,51 +99,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/scylla/datadog_checks/scylla/data/conf.yaml.example b/scylla/datadog_checks/scylla/data/conf.yaml.example index c214d5107313a..11c11c89b2a21 100644 --- a/scylla/datadog_checks/scylla/data/conf.yaml.example +++ b/scylla/datadog_checks/scylla/data/conf.yaml.example @@ -94,22 +94,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -117,7 +119,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -127,13 +129,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -246,9 +254,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -256,20 +264,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -337,7 +343,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -360,7 +366,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/silk/datadog_checks/silk/data/conf.yaml.example b/silk/datadog_checks/silk/data/conf.yaml.example index 76657cf6cbd5f..20087210dd754 100644 --- a/silk/datadog_checks/silk/data/conf.yaml.example +++ b/silk/datadog_checks/silk/data/conf.yaml.example @@ -93,7 +93,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -116,7 +116,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/singlestore/datadog_checks/singlestore/data/conf.yaml.example b/singlestore/datadog_checks/singlestore/data/conf.yaml.example index 5077c527947f7..c3f86753fc62d 100644 --- a/singlestore/datadog_checks/singlestore/data/conf.yaml.example +++ b/singlestore/datadog_checks/singlestore/data/conf.yaml.example @@ -74,51 +74,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/snowflake/datadog_checks/snowflake/data/conf.yaml.example b/snowflake/datadog_checks/snowflake/data/conf.yaml.example index 71c302d2da7c6..f5d7c15a4cc1d 100644 --- a/snowflake/datadog_checks/snowflake/data/conf.yaml.example +++ b/snowflake/datadog_checks/snowflake/data/conf.yaml.example @@ -207,51 +207,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example b/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example index d02316b93327a..d0ba8b7c47119 100644 --- a/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example +++ b/sonarqube/datadog_checks/sonarqube/data/conf.yaml.example @@ -242,7 +242,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -265,7 +265,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/spark/datadog_checks/spark/data/conf.yaml.example b/spark/datadog_checks/spark/data/conf.yaml.example index d815cd8637801..006e51c95fec1 100644 --- a/spark/datadog_checks/spark/data/conf.yaml.example +++ b/spark/datadog_checks/spark/data/conf.yaml.example @@ -188,7 +188,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -211,7 +211,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example b/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example index aed71d0c02c1a..cb942c2ca7767 100644 --- a/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example +++ b/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example @@ -699,51 +699,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/squid/datadog_checks/squid/data/conf.yaml.example b/squid/datadog_checks/squid/data/conf.yaml.example index 649f0b535c71e..3bf5fe065f962 100644 --- a/squid/datadog_checks/squid/data/conf.yaml.example +++ b/squid/datadog_checks/squid/data/conf.yaml.example @@ -133,7 +133,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -156,7 +156,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/strimzi/datadog_checks/strimzi/data/conf.yaml.example b/strimzi/datadog_checks/strimzi/data/conf.yaml.example index 6bc117af776a3..5106f00a66d2d 100644 --- a/strimzi/datadog_checks/strimzi/data/conf.yaml.example +++ b/strimzi/datadog_checks/strimzi/data/conf.yaml.example @@ -74,22 +74,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -97,7 +99,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -107,13 +109,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -226,9 +234,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -236,20 +244,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -317,7 +323,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -340,7 +346,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/supabase/datadog_checks/supabase/data/conf.yaml.example b/supabase/datadog_checks/supabase/data/conf.yaml.example index a24370f890b64..718c737cfd639 100644 --- a/supabase/datadog_checks/supabase/data/conf.yaml.example +++ b/supabase/datadog_checks/supabase/data/conf.yaml.example @@ -38,22 +38,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -61,7 +63,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -71,13 +73,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -190,9 +198,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -200,20 +208,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -281,7 +287,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -304,7 +310,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/teamcity/datadog_checks/teamcity/data/conf.yaml.example b/teamcity/datadog_checks/teamcity/data/conf.yaml.example index 84337334bfd00..56329f8839ef0 100644 --- a/teamcity/datadog_checks/teamcity/data/conf.yaml.example +++ b/teamcity/datadog_checks/teamcity/data/conf.yaml.example @@ -62,22 +62,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -85,7 +87,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -95,13 +97,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -214,9 +222,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -224,20 +232,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -305,7 +311,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -328,7 +334,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/tekton/datadog_checks/tekton/data/conf.yaml.example b/tekton/datadog_checks/tekton/data/conf.yaml.example index df51d705b7378..2322a1ecdb102 100644 --- a/tekton/datadog_checks/tekton/data/conf.yaml.example +++ b/tekton/datadog_checks/tekton/data/conf.yaml.example @@ -69,22 +69,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -92,7 +94,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -102,13 +104,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -221,9 +229,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -231,20 +239,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -312,7 +318,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -335,7 +341,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/teleport/datadog_checks/teleport/data/conf.yaml.example b/teleport/datadog_checks/teleport/data/conf.yaml.example index 474319d55e264..51a2ef38734fb 100644 --- a/teleport/datadog_checks/teleport/data/conf.yaml.example +++ b/teleport/datadog_checks/teleport/data/conf.yaml.example @@ -68,22 +68,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -91,7 +93,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -101,13 +103,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -220,9 +228,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -230,20 +238,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -311,7 +317,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -334,7 +340,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/temporal/datadog_checks/temporal/data/conf.yaml.example b/temporal/datadog_checks/temporal/data/conf.yaml.example index a6e9ef7445188..06fda4386c904 100644 --- a/temporal/datadog_checks/temporal/data/conf.yaml.example +++ b/temporal/datadog_checks/temporal/data/conf.yaml.example @@ -66,22 +66,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -89,7 +91,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -99,13 +101,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -218,9 +226,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -228,20 +236,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -309,7 +315,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -332,7 +338,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/teradata/datadog_checks/teradata/data/conf.yaml.example b/teradata/datadog_checks/teradata/data/conf.yaml.example index ff3adfb6c6f35..0daf02e279f5b 100644 --- a/teradata/datadog_checks/teradata/data/conf.yaml.example +++ b/teradata/datadog_checks/teradata/data/conf.yaml.example @@ -161,51 +161,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/torchserve/datadog_checks/torchserve/data/conf.yaml.example b/torchserve/datadog_checks/torchserve/data/conf.yaml.example index 95e623523714f..1d344c66cac59 100644 --- a/torchserve/datadog_checks/torchserve/data/conf.yaml.example +++ b/torchserve/datadog_checks/torchserve/data/conf.yaml.example @@ -65,22 +65,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -88,7 +90,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -98,13 +100,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -220,9 +228,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -230,20 +238,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected @@ -312,7 +318,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -335,7 +341,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # @@ -680,7 +686,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -703,7 +709,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # @@ -1075,7 +1081,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -1098,7 +1104,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/traefik_mesh/datadog_checks/traefik_mesh/data/conf.yaml.example b/traefik_mesh/datadog_checks/traefik_mesh/data/conf.yaml.example index 5d3b025527f00..fc3a3e7905712 100644 --- a/traefik_mesh/datadog_checks/traefik_mesh/data/conf.yaml.example +++ b/traefik_mesh/datadog_checks/traefik_mesh/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/traffic_server/datadog_checks/traffic_server/data/conf.yaml.example b/traffic_server/datadog_checks/traffic_server/data/conf.yaml.example index 5243970769256..c80cd360dd338 100644 --- a/traffic_server/datadog_checks/traffic_server/data/conf.yaml.example +++ b/traffic_server/datadog_checks/traffic_server/data/conf.yaml.example @@ -109,7 +109,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -132,7 +132,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/twistlock/datadog_checks/twistlock/data/conf.yaml.example b/twistlock/datadog_checks/twistlock/data/conf.yaml.example index c4b56fcc43e04..01075351dfd58 100644 --- a/twistlock/datadog_checks/twistlock/data/conf.yaml.example +++ b/twistlock/datadog_checks/twistlock/data/conf.yaml.example @@ -89,7 +89,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -112,7 +112,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/vault/datadog_checks/vault/data/conf.yaml.example b/vault/datadog_checks/vault/data/conf.yaml.example index c091296f61131..e9899b2b2f098 100644 --- a/vault/datadog_checks/vault/data/conf.yaml.example +++ b/vault/datadog_checks/vault/data/conf.yaml.example @@ -102,22 +102,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -125,7 +127,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -135,13 +137,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -254,9 +262,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -264,20 +272,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -345,7 +351,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -368,7 +374,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/velero/datadog_checks/velero/data/conf.yaml.example b/velero/datadog_checks/velero/data/conf.yaml.example index d5d9ff65e72c8..75c915cdd13a6 100644 --- a/velero/datadog_checks/velero/data/conf.yaml.example +++ b/velero/datadog_checks/velero/data/conf.yaml.example @@ -63,22 +63,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -86,7 +88,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -96,13 +98,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -215,9 +223,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -225,20 +233,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -306,7 +312,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -329,7 +335,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/vertica/datadog_checks/vertica/data/conf.yaml.example b/vertica/datadog_checks/vertica/data/conf.yaml.example index cc3e778e414e0..a2e30d1f398e8 100644 --- a/vertica/datadog_checks/vertica/data/conf.yaml.example +++ b/vertica/datadog_checks/vertica/data/conf.yaml.example @@ -211,51 +211,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/vllm/datadog_checks/vllm/data/conf.yaml.example b/vllm/datadog_checks/vllm/data/conf.yaml.example index 838ab38c84e71..9e106b28135bb 100644 --- a/vllm/datadog_checks/vllm/data/conf.yaml.example +++ b/vllm/datadog_checks/vllm/data/conf.yaml.example @@ -64,22 +64,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -87,7 +89,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -97,13 +99,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -216,9 +224,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -226,20 +234,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -307,7 +313,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -330,7 +336,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/voltdb/datadog_checks/voltdb/data/conf.yaml.example b/voltdb/datadog_checks/voltdb/data/conf.yaml.example index 3c3ff4c1b0cbd..0332aa68ecde1 100644 --- a/voltdb/datadog_checks/voltdb/data/conf.yaml.example +++ b/voltdb/datadog_checks/voltdb/data/conf.yaml.example @@ -281,51 +281,48 @@ instances: ## Each query must have 2 fields, and can have a third optional field: ## ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script. - ## Use the pipe `|` if you require a multi-line script. + ## Use the pipe `|` if you require a multi-line script. ## 2. columns - The list representing each column, ordered sequentially from left to right. - ## The number of columns must equal the number of columns returned in the query. - ## There are 2 required pieces of data: - ## a. name - The suffix to append to `.` to form - ## the full metric name. If `type` is a `tag` type, this column is - ## considered a tag and applied to every - ## metric collected by this particular query. - ## b. type - The submission method (gauge, monotonic_count, etc.). - ## This can also be set to the following `tag` types to - ## tag each metric in the row with the name and value - ## of the item in this column: - ## i. tag - This is the default tag type - ## ii. tag_list - This allows multiple values to be attached - ## to the tag name. For example: - ## - ## query = { - ## "name": "example", - ## "query": "...", - ## "columns": [ - ## {"name": "server_tag", "type": "tag_list"}, - ## {"name": "foo", "type": "gauge"}, - ## ] - ## } - ## - ## May result in: - ## gauge("foo", tags=[ - ## "server_tag:us", - ## "server_tag:primary", - ## "server_tag:default" - ## ]) - ## gauge("foo", tags=["server_tag:eu"]) - ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) - ## iii. tag_not_null - This only sets tags in the metric if the value is not null - ## You can use the `count` type to perform aggregation - ## for queries that return multiple rows with the same or no tags. - ## Columns without a name are ignored. To skip a column, enter: - ## - {} + ## The number of columns must equal the number of columns returned in the query. + ## There are 2 required pieces of data: + ## 1. name - The suffix to append to `.` to form + ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied + ## to every metric collected by this particular query. + ## 2. type - The submission method (gauge, monotonic_count, etc.). + ## This can also be set to the following `tag` types to tag each metric in the row with the name + ## and value of the item in this column: + ## 1. tag - This is the default tag type + ## 2. tag_list - This allows multiple values to be attached to the tag name. For example: + ## ``` + ## query = { + ## "name": "example", + ## "query": "...", + ## "columns": [ + ## {"name": "server_tag", "type": "tag_list"}, + ## {"name": "foo", "type": "gauge"}, + ## ] + ## } + ## ``` + ## May result in: + ## ``` + ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"]) + ## gauge("foo", tags=["server_tag:eu"]) + ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"]) + ## ``` + ## 3. tag_not_null - This only sets tags in the metric if the value is not null + ## You can use the `count` type to perform aggregation for queries that return multiple rows with + ## the same or no tags. + ## Columns without a name are ignored. To skip a column, enter: + ## ``` + ## - {} + ## ``` ## 3. tags (optional) - A list of tags to apply to each metric. ## 4. collection_interval (optional) - The frequency at which to collect the metrics. ## If collection_interval is not set, the query will be run every check run. - ## If the collection interval is less than check collection interval, - ## the query will be run every check run. - ## If the collection interval is greater than check collection interval, - ## the query will NOT BE RUN exactly at the collection interval. + ## If the collection interval is less than check collection interval, the query will be run every check + ## run. + ## If the collection interval is greater than check collection interval, the query will NOT BE RUN + ## exactly at the collection interval. ## The query will be run at the next check run after the collection interval has passed. ## 5. metric_prefix (optional) - The prefix to apply to each metric. # diff --git a/vsphere/datadog_checks/vsphere/data/conf.yaml.example b/vsphere/datadog_checks/vsphere/data/conf.yaml.example index 598198872115e..ed4b30316e37b 100644 --- a/vsphere/datadog_checks/vsphere/data/conf.yaml.example +++ b/vsphere/datadog_checks/vsphere/data/conf.yaml.example @@ -503,7 +503,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -526,7 +526,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/weaviate/datadog_checks/weaviate/data/conf.yaml.example b/weaviate/datadog_checks/weaviate/data/conf.yaml.example index 20a8fccdcaf05..8b7586b6aa592 100644 --- a/weaviate/datadog_checks/weaviate/data/conf.yaml.example +++ b/weaviate/datadog_checks/weaviate/data/conf.yaml.example @@ -69,22 +69,24 @@ instances: ## ## 1. If the item is a string, then it represents the exposed metric name, and ## the sent metric name will be identical. For example: - ## + ## ``` ## extra_metrics: ## - ## - + ## ``` ## 2. If the item is a mapping, then the keys represent the exposed metric names. ## - ## a. If a value is a string, then it represents the sent metric name. For example: - ## + ## 1. If a value is a string, then it represents the sent metric name. For example: + ## ``` ## extra_metrics: ## - : ## - : - ## b. If a value is a mapping, then it must have a `name` and/or `type` key. + ## ``` + ## 2. If a value is a mapping, then it must have a `name` and/or `type` key. ## The `name` represents the sent metric name, and the `type` represents how ## the metric should be handled, overriding any type information the endpoint ## may provide. For example: - ## + ## ``` ## extra_metrics: ## - : ## name: @@ -92,7 +94,7 @@ instances: ## - : ## name: ## type: - ## + ## ``` ## The supported native types are `gauge`, `counter`, `histogram`, and `summary`. ## ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total` @@ -102,13 +104,19 @@ instances: ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes ## ## Regular expressions may be used to match the exposed metric names, for example: - ## + ## ``` ## extra_metrics: ## - ^network_(ingress|egress)_.+ ## - .+: ## type: gauge + ## ``` # - # extra_metrics: [] + # extra_metrics: + # - + # - : + # - : + # name: + # type: ## @param exclude_metrics - list of strings - optional ## A list of metrics to exclude, with each entry being either @@ -221,9 +229,9 @@ instances: ## exposed metrics from which to share labels, and the values are mappings that configure the ## sharing behavior. Each mapping must have at least one of the following keys: ## - ## labels - This is a list of labels to share. All labels are shared if this is not set. - ## match - This is a list of labels to match on other metrics as a condition for sharing. - ## values - This is a list of allowed values as a condition for sharing. + ## - labels - This is a list of labels to share. All labels are shared if this is not set. + ## - match - This is a list of labels to match on other metrics as a condition for sharing. + ## - values - This is a list of allowed values as a condition for sharing. ## ## To unconditionally share all labels of a metric, set it to `true`. ## @@ -231,20 +239,18 @@ instances: ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod` ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c` ## to all other metrics if their value is equal to `23` or `42`. - ## - ## share_labels: - ## metric_a: true - ## metric_b: - ## labels: - ## - node - ## match: - ## - pod - ## metric_c: - ## values: - ## - 23 - ## - 42 # - # share_labels: {} + # share_labels: + # metric_a: true + # metric_b: + # labels: + # - node + # match: + # - pod + # metric_c: + # values: + # - 23 + # - 42 ## @param cache_shared_labels - boolean - optional - default: true ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload @@ -312,7 +318,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -335,7 +341,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/yarn/datadog_checks/yarn/data/conf.yaml.example b/yarn/datadog_checks/yarn/data/conf.yaml.example index 89d39a2146134..aa8acda32ba62 100644 --- a/yarn/datadog_checks/yarn/data/conf.yaml.example +++ b/yarn/datadog_checks/yarn/data/conf.yaml.example @@ -217,7 +217,7 @@ instances: ## @param auth_type - string - optional - default: basic ## The type of authentication to use. The available types (and related options) are: - ## + ## ``` ## - basic ## |__ username ## |__ password @@ -240,7 +240,7 @@ instances: ## |__ aws_region ## |__ aws_host ## |__ aws_service - ## + ## ``` ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`. ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials # diff --git a/zk/datadog_checks/zk/data/conf.yaml.example b/zk/datadog_checks/zk/data/conf.yaml.example index 22496003231ee..d2241d9a4803d 100644 --- a/zk/datadog_checks/zk/data/conf.yaml.example +++ b/zk/datadog_checks/zk/data/conf.yaml.example @@ -34,7 +34,9 @@ instances: ## ## Available options are: `leader`, `follower`, `standalone` or an array of one or more of these. # - # expected_mode: + # expected_mode: + # - leader + # - follower ## @param report_instance_mode - boolean - optional - default: true ## Whether to report the current instance mode as a 0/1 gauge. From b8c45c22c32d462f7c92c1f743d0e8576245fc51 Mon Sep 17 00:00:00 2001 From: Yann Armelin Date: Tue, 29 Jul 2025 17:59:32 +0200 Subject: [PATCH 3/3] docs(json-specs): add changelogs --- activemq_xml/changelog.d/20878.fixed | 1 + aerospike/changelog.d/20878.fixed | 1 + airflow/changelog.d/20878.fixed | 1 + amazon_msk/changelog.d/20878.fixed | 1 + ambari/changelog.d/20878.fixed | 1 + apache/changelog.d/20878.fixed | 1 + appgate_sdp/changelog.d/20878.fixed | 1 + arangodb/changelog.d/20878.fixed | 1 + argo_rollouts/changelog.d/20878.fixed | 1 + argo_workflows/changelog.d/20878.fixed | 1 + argocd/changelog.d/20878.fixed | 1 + avi_vantage/changelog.d/20878.fixed | 1 + aws_neuron/changelog.d/20878.fixed | 1 + azure_iot_edge/changelog.d/20878.fixed | 1 + boundary/changelog.d/20878.fixed | 1 + calico/changelog.d/20878.fixed | 1 + celery/changelog.d/20878.fixed | 1 + cert_manager/changelog.d/20878.fixed | 1 + cilium/changelog.d/20878.fixed | 1 + citrix_hypervisor/changelog.d/20878.fixed | 1 + clickhouse/changelog.d/20878.fixed | 1 + cockroachdb/changelog.d/20878.fixed | 1 + consul/changelog.d/20878.fixed | 1 + coredns/changelog.d/20878.fixed | 1 + couch/changelog.d/20878.fixed | 1 + couchbase/changelog.d/20878.fixed | 1 + crio/changelog.d/20878.fixed | 1 + datadog_checks_dev/changelog.d/20878.fixed | 1 + datadog_cluster_agent/changelog.d/20878.fixed | 1 + dcgm/changelog.d/20878.fixed | 1 + druid/changelog.d/20878.fixed | 1 + ecs_fargate/changelog.d/20878.fixed | 1 + eks_fargate/changelog.d/20878.fixed | 1 + elastic/changelog.d/20878.fixed | 1 + envoy/changelog.d/20878.fixed | 1 + etcd/changelog.d/20878.fixed | 1 + external_dns/changelog.d/20878.fixed | 1 + falco/changelog.d/20878.fixed | 1 + fluentd/changelog.d/20878.fixed | 1 + fluxcd/changelog.d/20878.fixed | 1 + fly_io/changelog.d/20878.fixed | 1 + gitlab/changelog.d/20878.fixed | 1 + gitlab_runner/changelog.d/20878.fixed | 1 + go_expvar/changelog.d/20878.fixed | 1 + haproxy/changelog.d/20878.fixed | 1 + harbor/changelog.d/20878.fixed | 1 + hazelcast/changelog.d/20878.fixed | 1 + hdfs_datanode/changelog.d/20878.fixed | 1 + hdfs_namenode/changelog.d/20878.fixed | 1 + http_check/changelog.d/20878.fixed | 1 + ibm_was/changelog.d/20878.fixed | 1 + impala/changelog.d/20878.fixed | 1 + istio/changelog.d/20878.fixed | 1 + karpenter/changelog.d/20878.fixed | 1 + keda/changelog.d/20878.fixed | 1 + kong/changelog.d/20878.fixed | 1 + krakend/changelog.d/20878.fixed | 1 + kube_apiserver_metrics/changelog.d/20878.fixed | 1 + kube_controller_manager/changelog.d/20878.fixed | 1 + kube_dns/changelog.d/20878.fixed | 1 + kube_metrics_server/changelog.d/20878.fixed | 1 + kube_proxy/changelog.d/20878.fixed | 1 + kube_scheduler/changelog.d/20878.fixed | 1 + kubeflow/changelog.d/20878.fixed | 1 + kubelet/changelog.d/20878.fixed | 1 + kubernetes_cluster_autoscaler/changelog.d/20878.fixed | 1 + kubernetes_state/changelog.d/20878.fixed | 1 + kubevirt_api/changelog.d/20878.fixed | 1 + kubevirt_controller/changelog.d/20878.fixed | 1 + kubevirt_handler/changelog.d/20878.fixed | 1 + kuma/changelog.d/20878.fixed | 1 + kyototycoon/changelog.d/20878.fixed | 1 + kyverno/changelog.d/20878.fixed | 1 + lighttpd/changelog.d/20878.fixed | 1 + linkerd/changelog.d/20878.fixed | 1 + litellm/changelog.d/20878.fixed | 1 + mapreduce/changelog.d/20878.fixed | 1 + marathon/changelog.d/20878.fixed | 1 + marklogic/changelog.d/20878.fixed | 1 + mesos_master/changelog.d/20878.fixed | 1 + mesos_slave/changelog.d/20878.fixed | 1 + milvus/changelog.d/20878.fixed | 1 + mysql/changelog.d/20878.fixed | 1 + nginx/changelog.d/20878.fixed | 1 + nginx_ingress_controller/changelog.d/20878.fixed | 1 + nvidia_nim/changelog.d/20878.fixed | 1 + nvidia_triton/changelog.d/20878.fixed | 1 + octopus_deploy/changelog.d/20878.fixed | 1 + openmetrics/changelog.d/20878.fixed | 1 + oracle/changelog.d/20878.fixed | 1 + php_fpm/changelog.d/20878.fixed | 1 + postgres/changelog.d/20878.fixed | 1 + powerdns_recursor/changelog.d/20878.fixed | 1 + proxmox/changelog.d/20878.fixed | 1 + pulsar/changelog.d/20878.fixed | 1 + quarkus/changelog.d/20878.fixed | 1 + rabbitmq/changelog.d/20878.fixed | 1 + ray/changelog.d/20878.fixed | 1 + riak/changelog.d/20878.fixed | 1 + sap_hana/changelog.d/20878.fixed | 1 + scylla/changelog.d/20878.fixed | 1 + silk/changelog.d/20878.fixed | 1 + singlestore/changelog.d/20878.fixed | 1 + snowflake/changelog.d/20878.fixed | 1 + sonarqube/changelog.d/20878.fixed | 1 + spark/changelog.d/20878.fixed | 1 + sqlserver/changelog.d/20878.fixed | 1 + squid/changelog.d/20878.fixed | 1 + strimzi/changelog.d/20878.fixed | 1 + supabase/changelog.d/20878.fixed | 1 + teamcity/changelog.d/20878.fixed | 1 + tekton/changelog.d/20878.fixed | 1 + teleport/changelog.d/20878.fixed | 1 + temporal/changelog.d/20878.fixed | 1 + teradata/changelog.d/20878.fixed | 1 + torchserve/changelog.d/20878.fixed | 1 + traefik_mesh/changelog.d/20878.fixed | 1 + traffic_server/changelog.d/20878.fixed | 1 + twistlock/changelog.d/20878.fixed | 1 + vault/changelog.d/20878.fixed | 1 + velero/changelog.d/20878.fixed | 1 + vertica/changelog.d/20878.fixed | 1 + vllm/changelog.d/20878.fixed | 1 + voltdb/changelog.d/20878.fixed | 1 + vsphere/changelog.d/20878.fixed | 1 + weaviate/changelog.d/20878.fixed | 1 + yarn/changelog.d/20878.fixed | 1 + zk/changelog.d/20878.fixed | 1 + 128 files changed, 128 insertions(+) create mode 100644 activemq_xml/changelog.d/20878.fixed create mode 100644 aerospike/changelog.d/20878.fixed create mode 100644 airflow/changelog.d/20878.fixed create mode 100644 amazon_msk/changelog.d/20878.fixed create mode 100644 ambari/changelog.d/20878.fixed create mode 100644 apache/changelog.d/20878.fixed create mode 100644 appgate_sdp/changelog.d/20878.fixed create mode 100644 arangodb/changelog.d/20878.fixed create mode 100644 argo_rollouts/changelog.d/20878.fixed create mode 100644 argo_workflows/changelog.d/20878.fixed create mode 100644 argocd/changelog.d/20878.fixed create mode 100644 avi_vantage/changelog.d/20878.fixed create mode 100644 aws_neuron/changelog.d/20878.fixed create mode 100644 azure_iot_edge/changelog.d/20878.fixed create mode 100644 boundary/changelog.d/20878.fixed create mode 100644 calico/changelog.d/20878.fixed create mode 100644 celery/changelog.d/20878.fixed create mode 100644 cert_manager/changelog.d/20878.fixed create mode 100644 cilium/changelog.d/20878.fixed create mode 100644 citrix_hypervisor/changelog.d/20878.fixed create mode 100644 clickhouse/changelog.d/20878.fixed create mode 100644 cockroachdb/changelog.d/20878.fixed create mode 100644 consul/changelog.d/20878.fixed create mode 100644 coredns/changelog.d/20878.fixed create mode 100644 couch/changelog.d/20878.fixed create mode 100644 couchbase/changelog.d/20878.fixed create mode 100644 crio/changelog.d/20878.fixed create mode 100644 datadog_checks_dev/changelog.d/20878.fixed create mode 100644 datadog_cluster_agent/changelog.d/20878.fixed create mode 100644 dcgm/changelog.d/20878.fixed create mode 100644 druid/changelog.d/20878.fixed create mode 100644 ecs_fargate/changelog.d/20878.fixed create mode 100644 eks_fargate/changelog.d/20878.fixed create mode 100644 elastic/changelog.d/20878.fixed create mode 100644 envoy/changelog.d/20878.fixed create mode 100644 etcd/changelog.d/20878.fixed create mode 100644 external_dns/changelog.d/20878.fixed create mode 100644 falco/changelog.d/20878.fixed create mode 100644 fluentd/changelog.d/20878.fixed create mode 100644 fluxcd/changelog.d/20878.fixed create mode 100644 fly_io/changelog.d/20878.fixed create mode 100644 gitlab/changelog.d/20878.fixed create mode 100644 gitlab_runner/changelog.d/20878.fixed create mode 100644 go_expvar/changelog.d/20878.fixed create mode 100644 haproxy/changelog.d/20878.fixed create mode 100644 harbor/changelog.d/20878.fixed create mode 100644 hazelcast/changelog.d/20878.fixed create mode 100644 hdfs_datanode/changelog.d/20878.fixed create mode 100644 hdfs_namenode/changelog.d/20878.fixed create mode 100644 http_check/changelog.d/20878.fixed create mode 100644 ibm_was/changelog.d/20878.fixed create mode 100644 impala/changelog.d/20878.fixed create mode 100644 istio/changelog.d/20878.fixed create mode 100644 karpenter/changelog.d/20878.fixed create mode 100644 keda/changelog.d/20878.fixed create mode 100644 kong/changelog.d/20878.fixed create mode 100644 krakend/changelog.d/20878.fixed create mode 100644 kube_apiserver_metrics/changelog.d/20878.fixed create mode 100644 kube_controller_manager/changelog.d/20878.fixed create mode 100644 kube_dns/changelog.d/20878.fixed create mode 100644 kube_metrics_server/changelog.d/20878.fixed create mode 100644 kube_proxy/changelog.d/20878.fixed create mode 100644 kube_scheduler/changelog.d/20878.fixed create mode 100644 kubeflow/changelog.d/20878.fixed create mode 100644 kubelet/changelog.d/20878.fixed create mode 100644 kubernetes_cluster_autoscaler/changelog.d/20878.fixed create mode 100644 kubernetes_state/changelog.d/20878.fixed create mode 100644 kubevirt_api/changelog.d/20878.fixed create mode 100644 kubevirt_controller/changelog.d/20878.fixed create mode 100644 kubevirt_handler/changelog.d/20878.fixed create mode 100644 kuma/changelog.d/20878.fixed create mode 100644 kyototycoon/changelog.d/20878.fixed create mode 100644 kyverno/changelog.d/20878.fixed create mode 100644 lighttpd/changelog.d/20878.fixed create mode 100644 linkerd/changelog.d/20878.fixed create mode 100644 litellm/changelog.d/20878.fixed create mode 100644 mapreduce/changelog.d/20878.fixed create mode 100644 marathon/changelog.d/20878.fixed create mode 100644 marklogic/changelog.d/20878.fixed create mode 100644 mesos_master/changelog.d/20878.fixed create mode 100644 mesos_slave/changelog.d/20878.fixed create mode 100644 milvus/changelog.d/20878.fixed create mode 100644 mysql/changelog.d/20878.fixed create mode 100644 nginx/changelog.d/20878.fixed create mode 100644 nginx_ingress_controller/changelog.d/20878.fixed create mode 100644 nvidia_nim/changelog.d/20878.fixed create mode 100644 nvidia_triton/changelog.d/20878.fixed create mode 100644 octopus_deploy/changelog.d/20878.fixed create mode 100644 openmetrics/changelog.d/20878.fixed create mode 100644 oracle/changelog.d/20878.fixed create mode 100644 php_fpm/changelog.d/20878.fixed create mode 100644 postgres/changelog.d/20878.fixed create mode 100644 powerdns_recursor/changelog.d/20878.fixed create mode 100644 proxmox/changelog.d/20878.fixed create mode 100644 pulsar/changelog.d/20878.fixed create mode 100644 quarkus/changelog.d/20878.fixed create mode 100644 rabbitmq/changelog.d/20878.fixed create mode 100644 ray/changelog.d/20878.fixed create mode 100644 riak/changelog.d/20878.fixed create mode 100644 sap_hana/changelog.d/20878.fixed create mode 100644 scylla/changelog.d/20878.fixed create mode 100644 silk/changelog.d/20878.fixed create mode 100644 singlestore/changelog.d/20878.fixed create mode 100644 snowflake/changelog.d/20878.fixed create mode 100644 sonarqube/changelog.d/20878.fixed create mode 100644 spark/changelog.d/20878.fixed create mode 100644 sqlserver/changelog.d/20878.fixed create mode 100644 squid/changelog.d/20878.fixed create mode 100644 strimzi/changelog.d/20878.fixed create mode 100644 supabase/changelog.d/20878.fixed create mode 100644 teamcity/changelog.d/20878.fixed create mode 100644 tekton/changelog.d/20878.fixed create mode 100644 teleport/changelog.d/20878.fixed create mode 100644 temporal/changelog.d/20878.fixed create mode 100644 teradata/changelog.d/20878.fixed create mode 100644 torchserve/changelog.d/20878.fixed create mode 100644 traefik_mesh/changelog.d/20878.fixed create mode 100644 traffic_server/changelog.d/20878.fixed create mode 100644 twistlock/changelog.d/20878.fixed create mode 100644 vault/changelog.d/20878.fixed create mode 100644 velero/changelog.d/20878.fixed create mode 100644 vertica/changelog.d/20878.fixed create mode 100644 vllm/changelog.d/20878.fixed create mode 100644 voltdb/changelog.d/20878.fixed create mode 100644 vsphere/changelog.d/20878.fixed create mode 100644 weaviate/changelog.d/20878.fixed create mode 100644 yarn/changelog.d/20878.fixed create mode 100644 zk/changelog.d/20878.fixed diff --git a/activemq_xml/changelog.d/20878.fixed b/activemq_xml/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/activemq_xml/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/aerospike/changelog.d/20878.fixed b/aerospike/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/aerospike/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/airflow/changelog.d/20878.fixed b/airflow/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/airflow/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/amazon_msk/changelog.d/20878.fixed b/amazon_msk/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/amazon_msk/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/ambari/changelog.d/20878.fixed b/ambari/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/ambari/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/apache/changelog.d/20878.fixed b/apache/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/apache/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/appgate_sdp/changelog.d/20878.fixed b/appgate_sdp/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/appgate_sdp/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/arangodb/changelog.d/20878.fixed b/arangodb/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/arangodb/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/argo_rollouts/changelog.d/20878.fixed b/argo_rollouts/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/argo_rollouts/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/argo_workflows/changelog.d/20878.fixed b/argo_workflows/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/argo_workflows/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/argocd/changelog.d/20878.fixed b/argocd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/argocd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/avi_vantage/changelog.d/20878.fixed b/avi_vantage/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/avi_vantage/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/aws_neuron/changelog.d/20878.fixed b/aws_neuron/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/aws_neuron/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/azure_iot_edge/changelog.d/20878.fixed b/azure_iot_edge/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/azure_iot_edge/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/boundary/changelog.d/20878.fixed b/boundary/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/boundary/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/calico/changelog.d/20878.fixed b/calico/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/calico/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/celery/changelog.d/20878.fixed b/celery/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/celery/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/cert_manager/changelog.d/20878.fixed b/cert_manager/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/cert_manager/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/cilium/changelog.d/20878.fixed b/cilium/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/cilium/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/citrix_hypervisor/changelog.d/20878.fixed b/citrix_hypervisor/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/citrix_hypervisor/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/clickhouse/changelog.d/20878.fixed b/clickhouse/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/clickhouse/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/cockroachdb/changelog.d/20878.fixed b/cockroachdb/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/cockroachdb/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/consul/changelog.d/20878.fixed b/consul/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/consul/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/coredns/changelog.d/20878.fixed b/coredns/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/coredns/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/couch/changelog.d/20878.fixed b/couch/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/couch/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/couchbase/changelog.d/20878.fixed b/couchbase/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/couchbase/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/crio/changelog.d/20878.fixed b/crio/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/crio/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/datadog_checks_dev/changelog.d/20878.fixed b/datadog_checks_dev/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/datadog_checks_dev/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/datadog_cluster_agent/changelog.d/20878.fixed b/datadog_cluster_agent/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/datadog_cluster_agent/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/dcgm/changelog.d/20878.fixed b/dcgm/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/dcgm/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/druid/changelog.d/20878.fixed b/druid/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/druid/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/ecs_fargate/changelog.d/20878.fixed b/ecs_fargate/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/ecs_fargate/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/eks_fargate/changelog.d/20878.fixed b/eks_fargate/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/eks_fargate/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/elastic/changelog.d/20878.fixed b/elastic/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/elastic/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/envoy/changelog.d/20878.fixed b/envoy/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/envoy/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/etcd/changelog.d/20878.fixed b/etcd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/etcd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/external_dns/changelog.d/20878.fixed b/external_dns/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/external_dns/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/falco/changelog.d/20878.fixed b/falco/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/falco/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/fluentd/changelog.d/20878.fixed b/fluentd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/fluentd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/fluxcd/changelog.d/20878.fixed b/fluxcd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/fluxcd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/fly_io/changelog.d/20878.fixed b/fly_io/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/fly_io/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/gitlab/changelog.d/20878.fixed b/gitlab/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/gitlab/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/gitlab_runner/changelog.d/20878.fixed b/gitlab_runner/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/gitlab_runner/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/go_expvar/changelog.d/20878.fixed b/go_expvar/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/go_expvar/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/haproxy/changelog.d/20878.fixed b/haproxy/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/haproxy/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/harbor/changelog.d/20878.fixed b/harbor/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/harbor/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/hazelcast/changelog.d/20878.fixed b/hazelcast/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/hazelcast/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/hdfs_datanode/changelog.d/20878.fixed b/hdfs_datanode/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/hdfs_datanode/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/hdfs_namenode/changelog.d/20878.fixed b/hdfs_namenode/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/hdfs_namenode/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/http_check/changelog.d/20878.fixed b/http_check/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/http_check/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/ibm_was/changelog.d/20878.fixed b/ibm_was/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/ibm_was/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/impala/changelog.d/20878.fixed b/impala/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/impala/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/istio/changelog.d/20878.fixed b/istio/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/istio/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/karpenter/changelog.d/20878.fixed b/karpenter/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/karpenter/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/keda/changelog.d/20878.fixed b/keda/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/keda/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kong/changelog.d/20878.fixed b/kong/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kong/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/krakend/changelog.d/20878.fixed b/krakend/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/krakend/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_apiserver_metrics/changelog.d/20878.fixed b/kube_apiserver_metrics/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_apiserver_metrics/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_controller_manager/changelog.d/20878.fixed b/kube_controller_manager/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_controller_manager/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_dns/changelog.d/20878.fixed b/kube_dns/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_dns/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_metrics_server/changelog.d/20878.fixed b/kube_metrics_server/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_metrics_server/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_proxy/changelog.d/20878.fixed b/kube_proxy/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_proxy/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kube_scheduler/changelog.d/20878.fixed b/kube_scheduler/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kube_scheduler/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubeflow/changelog.d/20878.fixed b/kubeflow/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubeflow/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubelet/changelog.d/20878.fixed b/kubelet/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubelet/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubernetes_cluster_autoscaler/changelog.d/20878.fixed b/kubernetes_cluster_autoscaler/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubernetes_cluster_autoscaler/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubernetes_state/changelog.d/20878.fixed b/kubernetes_state/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubernetes_state/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubevirt_api/changelog.d/20878.fixed b/kubevirt_api/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubevirt_api/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubevirt_controller/changelog.d/20878.fixed b/kubevirt_controller/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubevirt_controller/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kubevirt_handler/changelog.d/20878.fixed b/kubevirt_handler/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kubevirt_handler/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kuma/changelog.d/20878.fixed b/kuma/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kuma/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kyototycoon/changelog.d/20878.fixed b/kyototycoon/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kyototycoon/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/kyverno/changelog.d/20878.fixed b/kyverno/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/kyverno/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/lighttpd/changelog.d/20878.fixed b/lighttpd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/lighttpd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/linkerd/changelog.d/20878.fixed b/linkerd/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/linkerd/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/litellm/changelog.d/20878.fixed b/litellm/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/litellm/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/mapreduce/changelog.d/20878.fixed b/mapreduce/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/mapreduce/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/marathon/changelog.d/20878.fixed b/marathon/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/marathon/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/marklogic/changelog.d/20878.fixed b/marklogic/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/marklogic/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/mesos_master/changelog.d/20878.fixed b/mesos_master/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/mesos_master/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/mesos_slave/changelog.d/20878.fixed b/mesos_slave/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/mesos_slave/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/milvus/changelog.d/20878.fixed b/milvus/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/milvus/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/mysql/changelog.d/20878.fixed b/mysql/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/mysql/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/nginx/changelog.d/20878.fixed b/nginx/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/nginx/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/nginx_ingress_controller/changelog.d/20878.fixed b/nginx_ingress_controller/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/nginx_ingress_controller/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/nvidia_nim/changelog.d/20878.fixed b/nvidia_nim/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/nvidia_nim/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/nvidia_triton/changelog.d/20878.fixed b/nvidia_triton/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/nvidia_triton/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/octopus_deploy/changelog.d/20878.fixed b/octopus_deploy/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/octopus_deploy/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/openmetrics/changelog.d/20878.fixed b/openmetrics/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/openmetrics/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/oracle/changelog.d/20878.fixed b/oracle/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/oracle/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/php_fpm/changelog.d/20878.fixed b/php_fpm/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/php_fpm/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/postgres/changelog.d/20878.fixed b/postgres/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/postgres/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/powerdns_recursor/changelog.d/20878.fixed b/powerdns_recursor/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/powerdns_recursor/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/proxmox/changelog.d/20878.fixed b/proxmox/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/proxmox/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/pulsar/changelog.d/20878.fixed b/pulsar/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/pulsar/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/quarkus/changelog.d/20878.fixed b/quarkus/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/quarkus/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/rabbitmq/changelog.d/20878.fixed b/rabbitmq/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/rabbitmq/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/ray/changelog.d/20878.fixed b/ray/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/ray/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/riak/changelog.d/20878.fixed b/riak/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/riak/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/sap_hana/changelog.d/20878.fixed b/sap_hana/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/sap_hana/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/scylla/changelog.d/20878.fixed b/scylla/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/scylla/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/silk/changelog.d/20878.fixed b/silk/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/silk/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/singlestore/changelog.d/20878.fixed b/singlestore/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/singlestore/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/snowflake/changelog.d/20878.fixed b/snowflake/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/snowflake/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/sonarqube/changelog.d/20878.fixed b/sonarqube/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/sonarqube/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/spark/changelog.d/20878.fixed b/spark/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/spark/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/sqlserver/changelog.d/20878.fixed b/sqlserver/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/sqlserver/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/squid/changelog.d/20878.fixed b/squid/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/squid/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/strimzi/changelog.d/20878.fixed b/strimzi/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/strimzi/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/supabase/changelog.d/20878.fixed b/supabase/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/supabase/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/teamcity/changelog.d/20878.fixed b/teamcity/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/teamcity/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/tekton/changelog.d/20878.fixed b/tekton/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/tekton/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/teleport/changelog.d/20878.fixed b/teleport/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/teleport/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/temporal/changelog.d/20878.fixed b/temporal/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/temporal/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/teradata/changelog.d/20878.fixed b/teradata/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/teradata/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/torchserve/changelog.d/20878.fixed b/torchserve/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/torchserve/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/traefik_mesh/changelog.d/20878.fixed b/traefik_mesh/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/traefik_mesh/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/traffic_server/changelog.d/20878.fixed b/traffic_server/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/traffic_server/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/twistlock/changelog.d/20878.fixed b/twistlock/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/twistlock/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/vault/changelog.d/20878.fixed b/vault/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/vault/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/velero/changelog.d/20878.fixed b/velero/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/velero/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/vertica/changelog.d/20878.fixed b/vertica/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/vertica/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/vllm/changelog.d/20878.fixed b/vllm/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/vllm/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/voltdb/changelog.d/20878.fixed b/voltdb/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/voltdb/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/vsphere/changelog.d/20878.fixed b/vsphere/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/vsphere/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/weaviate/changelog.d/20878.fixed b/weaviate/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/weaviate/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/yarn/changelog.d/20878.fixed b/yarn/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/yarn/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples diff --git a/zk/changelog.d/20878.fixed b/zk/changelog.d/20878.fixed new file mode 100644 index 0000000000000..7dc4df083df33 --- /dev/null +++ b/zk/changelog.d/20878.fixed @@ -0,0 +1 @@ +Improve descriptions and examples