Document new option of OpenMetrics-based integrations

amazon_msk/datadog_checks/amazon_msk/config_models/defaults.py

@@ -288,5 +288,9 @@ def instance_use_openmetrics(field, value):
     return False
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

amazon_msk/datadog_checks/amazon_msk/config_models/instance.py

@@ -128,6 +128,7 @@ class Config:
     use_latest_spec: Optional[bool]
     use_legacy_auth_encoding: Optional[bool]
     use_openmetrics: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

@@ -226,6 +226,14 @@ instances:
     #
     # collect_counters_with_distributions: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param share_labels - mapping - optional
     ## This mapping allows for the sharing of labels across multiple metrics. The keys represent the
     ## exposed metrics from which to share labels, and the values are mappings that configure the

avi_vantage/datadog_checks/avi_vantage/config_models/defaults.py

@@ -264,5 +264,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

avi_vantage/datadog_checks/avi_vantage/config_models/instance.py

@@ -122,6 +122,7 @@ class Config:
     tls_verify: Optional[bool]
     use_latest_spec: Optional[bool]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example

@@ -188,6 +188,14 @@ instances:
     #
     # collect_counters_with_distributions: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param share_labels - mapping - optional
     ## This mapping allows for the sharing of labels across multiple metrics. The keys represent the
     ## exposed metrics from which to share labels, and the values are mappings that configure the

azure_iot_edge/datadog_checks/azure_iot_edge/config_models/defaults.py

@@ -252,5 +252,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

azure_iot_edge/datadog_checks/azure_iot_edge/config_models/instance.py

@@ -117,6 +117,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

azure_iot_edge/datadog_checks/azure_iot_edge/data/conf.yaml.example

@@ -123,6 +123,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

cilium/datadog_checks/cilium/config_models/defaults.py

@@ -256,5 +256,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

cilium/datadog_checks/cilium/config_models/instance.py

@@ -117,6 +117,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

cilium/datadog_checks/cilium/data/conf.yaml.example

@@ -126,6 +126,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

cockroachdb/datadog_checks/cockroachdb/config_models/defaults.py

@@ -248,5 +248,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

cockroachdb/datadog_checks/cockroachdb/config_models/instance.py

@@ -115,6 +115,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example

@@ -118,6 +118,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

coredns/datadog_checks/coredns/config_models/defaults.py

@@ -248,5 +248,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

coredns/datadog_checks/coredns/config_models/instance.py

@@ -115,6 +115,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

coredns/datadog_checks/coredns/data/conf.yaml.example

@@ -137,6 +137,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

crio/datadog_checks/crio/config_models/defaults.py

@@ -248,5 +248,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

crio/datadog_checks/crio/config_models/instance.py

@@ -115,6 +115,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

crio/datadog_checks/crio/data/conf.yaml.example

@@ -118,6 +118,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml

@@ -227,6 +227,15 @@
   value:
     example: false
     type: boolean
+- name: use_process_start_time
+  description: |
+    Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    response is received.
+  value:
+    example: false
+    type: boolean
 - name: share_labels
   description: |
     This mapping allows for the sharing of labels across multiple metrics. The keys represent the

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics_legacy_base.yaml

@@ -117,6 +117,15 @@
   value:
     example: false
     type: boolean
+- name: use_process_start_time
+  description: |
+    Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    response is received.
+  value:
+    example: false
+    type: boolean
 - name: exclude_labels
   description: A list of labels to be excluded
   value:
@@ -177,4 +186,4 @@
     example:
       - <FULL:TAG>
       - <TAG_PREFIX:.*>
-      - <TAG_SUFFIX$>
+      - <TAG_SUFFIX$>

datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/defaults.py

@@ -248,5 +248,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

datadog_cluster_agent/datadog_checks/datadog_cluster_agent/config_models/instance.py

@@ -115,6 +115,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/auto_conf.yaml

@@ -126,6 +126,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

datadog_cluster_agent/datadog_checks/datadog_cluster_agent/data/conf.yaml.example

@@ -118,6 +118,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

etcd/datadog_checks/etcd/config_models/defaults.py

@@ -260,5 +260,9 @@ def instance_use_preview(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

etcd/datadog_checks/etcd/config_models/instance.py

@@ -118,6 +118,7 @@ class Config:
     url: Optional[str]
     use_legacy_auth_encoding: Optional[bool]
     use_preview: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

etcd/datadog_checks/etcd/data/conf.yaml.example

@@ -124,6 +124,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

external_dns/datadog_checks/external_dns/config_models/defaults.py

@@ -248,5 +248,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)

external_dns/datadog_checks/external_dns/config_models/instance.py

@@ -115,6 +115,7 @@ class Config:
     tls_verify: Optional[bool]
     type_overrides: Optional[Mapping[str, Any]]
     use_legacy_auth_encoding: Optional[bool]
+    use_process_start_time: Optional[bool]
     username: Optional[str]
 
     @root_validator(pre=True)

external_dns/datadog_checks/external_dns/data/conf.yaml.example

@@ -118,6 +118,14 @@ instances:
     #
     # send_distribution_sums_as_monotonic: false
 
+    ## @param use_process_start_time - boolean - optional - default: false
+    ## Whether to enable a heuristic for reporting counter values on the first scrape. When true,
+    ## the first time an endpoint is scraped, check `process_start_time_seconds` to decide whether zero
+    ## initial value can be assumed for counters. This requires keeping metrics in memory until the entire
+    ## response is received.
+    #
+    # use_process_start_time: false
+
     ## @param exclude_labels - list of strings - optional
     ## A list of labels to be excluded
     #

gitlab/datadog_checks/gitlab/config_models/defaults.py

@@ -260,5 +260,9 @@ def instance_use_legacy_auth_encoding(field, value):
     return True
 
 
+def instance_use_process_start_time(field, value):
+    return False
+
+
 def instance_username(field, value):
     return get_default_field_value(field, value)