@@ -52,80 +52,11 @@ instances:
5252 #
5353 password: <PASSWORD>
5454
55- ## @param tags - list of strings - optional
56- ## A list of tags to attach to every metric and service check emitted by this instance.
57- ##
58- ## Learn more about tagging at https://docs.datadoghq.com/tagging
59- #
60- # tags:
61- # - <KEY_1>:<VALUE_1>
62- # - <KEY_2>:<VALUE_2>
63-
6455 ## @param dbm - boolean - optional - default: false
6556 ## Set to `true` to enable Database Monitoring.
6657 #
6758 # dbm: false
6859
69- ## @param custom_queries - list of mappings - optional
70- ## Each query must have 2 fields, and can have a third optional field:
71- ##
72- ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script.
73- ## Use the pipe `|` if you require a multi-line script.
74- ## 2. columns - The list representing each column, ordered sequentially from left to right.
75- ## The number of columns must equal the number of columns returned in the query.
76- ## There are 2 required pieces of data:
77- ## 1. name - The suffix to append to `<INTEGRATION>.` to form
78- ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied
79- ## to every metric collected by this particular query.
80- ## 2. type - The submission method (gauge, monotonic_count, etc.).
81- ## This can also be set to the following `tag` types to tag each metric in the row with the name
82- ## and value of the item in this column:
83- ## 1. tag - This is the default tag type
84- ## 2. tag_list - This allows multiple values to be attached to the tag name. For example:
85- ## ```
86- ## query = {
87- ## "name": "example",
88- ## "query": "...",
89- ## "columns": [
90- ## {"name": "server_tag", "type": "tag_list"},
91- ## {"name": "foo", "type": "gauge"},
92- ## ]
93- ## }
94- ## ```
95- ## May result in:
96- ## ```
97- ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"])
98- ## gauge("foo", tags=["server_tag:eu"])
99- ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"])
100- ## ```
101- ## 3. tag_not_null - This only sets tags in the metric if the value is not null
102- ## You can use the `count` type to perform aggregation for queries that return multiple rows with
103- ## the same or no tags.
104- ## Columns without a name are ignored. To skip a column, enter:
105- ## ```
106- ## - {}
107- ## ```
108- ## 3. tags (optional) - A list of tags to apply to each metric.
109- ## 4. collection_interval (optional) - The frequency at which to collect the metrics.
110- ## If collection_interval is not set, the query will be run every check run.
111- ## If the collection interval is less than check collection interval, the query will be run every check
112- ## run.
113- ## If the collection interval is greater than check collection interval, the query will NOT BE RUN
114- ## exactly at the collection interval.
115- ## The query will be run at the next check run after the collection interval has passed.
116- ## 5. metric_prefix (optional) - The prefix to apply to each metric.
117- #
118- # custom_queries:
119- # - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
120- # columns:
121- # - name: foo
122- # type: tag
123- # - name: event.total
124- # type: gauge
125- # tags:
126- # - test:mysql
127- # metric_prefix: mysql
128-
12960 ## @param propagate_agent_tags - boolean - optional - default: false
13061 ## Set to `true` to propagate the tags from `datadog.yaml` to the check.
13162 ## When set to `true`, the tags from `datadog.yaml` are added to the check's tags for all instances.
@@ -784,6 +715,75 @@ instances:
784715 #
785716 # use_global_custom_queries: 'true'
786717
718+ ## @param custom_queries - list of mappings - optional
719+ ## Each query must have 2 fields, and can have a third optional field:
720+ ##
721+ ## 1. query - The SQL to execute. It can be a simple statement or a multi-line script.
722+ ## Use the pipe `|` if you require a multi-line script.
723+ ## 2. columns - The list representing each column, ordered sequentially from left to right.
724+ ## The number of columns must equal the number of columns returned in the query.
725+ ## There are 2 required pieces of data:
726+ ## 1. name - The suffix to append to `<INTEGRATION>.` to form
727+ ## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied
728+ ## to every metric collected by this particular query.
729+ ## 2. type - The submission method (gauge, monotonic_count, etc.).
730+ ## This can also be set to the following `tag` types to tag each metric in the row with the name
731+ ## and value of the item in this column:
732+ ## 1. tag - This is the default tag type
733+ ## 2. tag_list - This allows multiple values to be attached to the tag name. For example:
734+ ## ```
735+ ## query = {
736+ ## "name": "example",
737+ ## "query": "...",
738+ ## "columns": [
739+ ## {"name": "server_tag", "type": "tag_list"},
740+ ## {"name": "foo", "type": "gauge"},
741+ ## ]
742+ ## }
743+ ## ```
744+ ## May result in:
745+ ## ```
746+ ## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"])
747+ ## gauge("foo", tags=["server_tag:eu"])
748+ ## gauge("foo", tags=["server_tag:eu", "server_tag:primary"])
749+ ## ```
750+ ## 3. tag_not_null - This only sets tags in the metric if the value is not null
751+ ## You can use the `count` type to perform aggregation for queries that return multiple rows with
752+ ## the same or no tags.
753+ ## Columns without a name are ignored. To skip a column, enter:
754+ ## ```
755+ ## - {}
756+ ## ```
757+ ## 3. tags (optional) - A list of tags to apply to each metric.
758+ ## 4. collection_interval (optional) - The frequency at which to collect the metrics.
759+ ## If collection_interval is not set, the query will be run every check run.
760+ ## If the collection interval is less than check collection interval, the query will be run every check
761+ ## run.
762+ ## If the collection interval is greater than check collection interval, the query will NOT BE RUN
763+ ## exactly at the collection interval.
764+ ## The query will be run at the next check run after the collection interval has passed.
765+ ## 5. metric_prefix (optional) - The prefix to apply to each metric.
766+ #
767+ # custom_queries:
768+ # - query: SELECT foo, COUNT(*) FROM table.events GROUP BY foo
769+ # columns:
770+ # - name: foo
771+ # type: tag
772+ # - name: event.total
773+ # type: gauge
774+ # tags:
775+ # - test:mysql
776+ # metric_prefix: mysql
777+
778+ ## @param tags - list of strings - optional
779+ ## A list of tags to attach to every metric and service check emitted by this instance.
780+ ##
781+ ## Learn more about tagging at https://docs.datadoghq.com/tagging
782+ #
783+ # tags:
784+ # - <KEY_1>:<VALUE_1>
785+ # - <KEY_2>:<VALUE_2>
786+
787787 ## @param service - string - optional
788788 ## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.
789789 ##
0 commit comments