update custom_queries configuration to support optional collection_interval

clickhouse/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

clickhouse/datadog_checks/clickhouse/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

clickhouse/datadog_checks/clickhouse/data/conf.yaml.example

@@ -132,6 +132,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo

datadog_checks_dev/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/db.yaml

@@ -13,3 +13,4 @@
       - query: <QUERY>
         columns: <COLUMNS>
         tags: <TAGS>
+        collection_interval: <COLLECTION_INTERVAL>

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

@@ -59,6 +59,13 @@
                  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.
+        The query will be run at the next check run after the collection interval has passed.
   value:
     type: array
     items:
@@ -74,6 +81,8 @@
           type: array
           items:
             type: string
+        - name: collection_interval
+          type: integer
     example:
       - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
         columns:
@@ -83,3 +92,4 @@
             type: gauge
         tags:
           - test:<INTEGRATION>
+        collection_interval: 30

mysql/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

mysql/datadog_checks/mysql/config_models/instance.py

@@ -51,6 +51,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

mysql/datadog_checks/mysql/data/conf.yaml.example

@@ -148,6 +148,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo

oracle/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

oracle/datadog_checks/oracle/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

oracle/datadog_checks/oracle/data/conf.yaml.example

@@ -18,6 +18,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
     ## @param service - string - optional
     ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
@@ -145,6 +146,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -155,6 +163,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.

sap_hana/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

sap_hana/datadog_checks/sap_hana/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

sap_hana/datadog_checks/sap_hana/data/conf.yaml.example

@@ -17,6 +17,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
     ## @param service - string - optional
     ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
@@ -137,6 +138,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -147,6 +155,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param persist_db_connections - boolean - optional - default: true
     ## Whether or not to persist database connections.

singlestore/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

singlestore/datadog_checks/singlestore/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

singlestore/datadog_checks/singlestore/data/conf.yaml.example

@@ -19,6 +19,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
 ## Every instance is scheduled independently of the others.
 #
@@ -112,6 +113,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -122,6 +130,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param collect_system_metrics - boolean - optional - default: false
     ## Collect additional system metrics from the MV_SYSINFO_* tables. Disabled by default to limit

snowflake/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

snowflake/datadog_checks/snowflake/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

snowflake/datadog_checks/snowflake/data/conf.yaml.example

@@ -12,6 +12,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
     ## @param proxy_host - string - optional
     ## The host of your proxy server.
@@ -245,6 +246,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo

sqlserver/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

sqlserver/datadog_checks/sqlserver/config_models/instance.py

@@ -51,6 +51,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

sqlserver/datadog_checks/sqlserver/data/conf.yaml.example

@@ -22,6 +22,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
     ## @param service - string - optional
     ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
@@ -593,6 +594,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -603,6 +611,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param stored_procedure - string - optional
     ## DEPRECATED - use `custom_queries` instead. For guidance, see:

teradata/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

teradata/datadog_checks/teradata/config_models/instance.py

@@ -26,6 +26,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

teradata/datadog_checks/teradata/data/conf.yaml.example

@@ -19,6 +19,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
 ## Every instance is scheduled independently of the others.
 #
@@ -199,6 +200,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -209,6 +217,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.

vertica/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

vertica/datadog_checks/vertica/config_models/instance.py

@@ -25,6 +25,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

vertica/datadog_checks/vertica/data/conf.yaml.example

@@ -240,6 +240,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT force_outer, table_name FROM v_catalog.tables

voltdb/changelog.d/16957.added

@@ -0,0 +1 @@
+update custom_queries configuration to support optional collection_interval

voltdb/datadog_checks/voltdb/config_models/instance.py

@@ -34,6 +34,7 @@ class CustomQuery(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    collection_interval: Optional[int] = None
     columns: Optional[tuple[MappingProxyType[str, Any], ...]] = None
     query: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None

voltdb/datadog_checks/voltdb/data/conf.yaml.example

@@ -44,6 +44,7 @@ init_config:
     #   - query: <QUERY>
     #     columns: <COLUMNS>
     #     tags: <TAGS>
+    #     collection_interval: <COLLECTION_INTERVAL>
 
     ## @param service - string - optional
     ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
@@ -309,6 +310,13 @@ instances:
     ##              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.
+    ##     The query will be run at the next check run after the collection interval has passed.
     #
     # custom_queries:
     #   - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
@@ -319,6 +327,7 @@ instances:
     #       type: gauge
     #     tags:
     #     - test:<INTEGRATION>
+    #     collection_interval: 30
 
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.