You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/dql.md
+26-1Lines changed: 26 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,9 @@ description: |-
7
7
8
8
# dynatrace_dql (Data Source)
9
9
10
+
The `dynatrace_dql` data source requires authentication via OAuth Client (`DT_CLIENT` and `DT_CLIENT_SECRET`).
11
+
It depends on the query you want to execute what permissions are required in details. For more information look into [https://docs.dynatrace.com/docs/discover-dynatrace/platform/grail/data-model/assign-permissions-in-grail#grail-permissions-table](Permissions in Grail — Dynatrace Docs).
12
+
10
13
The only required attribute is the `query` attribute - holding the DQL query.
11
14
You may or may not utilize the additional attributes in order to narrow down the results. But most of that can also get achieved with in the DQL query itself.
-`default_sampling_ratio` (Number) In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries
69
+
-`default_scan_limit_gbytes` (Number) Limit in gigabytes for the amount data that will be scanned during read
70
+
-`default_timeframe_end` (String) The query timeframe 'end' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter
71
+
-`default_timeframe_start` (String) The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter
72
+
-`fetch_timeout_seconds` (Number) The query will stop reading data after reaching the fetch-timeout. The query execution will continue, providing a partial result based on the read data
73
+
-`locale` (String) The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'
74
+
-`max_result_bytes` (Number) The maximum number of result bytes that this query will return
75
+
-`max_result_records` (Number) The maximum number of result records that this query will return
76
+
-`timezone` (String) The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
-`enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
41
+
-`rule` (Block List, Min: 1, Max: 1) Rule (see [below for nested schema](#nestedblock--rule))
42
+
43
+
### Optional
44
+
45
+
-`insert_after` (String) Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
46
+
-`scope` (String) The scope of this setting (CLOUD_APPLICATION_NAMESPACE, KUBERNETES_CLUSTER, HOST_GROUP). Omit this property if you want to cover the whole environment.
47
+
48
+
### Read-Only
49
+
50
+
-`id` (String) The ID of this resource.
51
+
52
+
<aid="nestedblock--rule"></a>
53
+
### Nested Schema for `rule`
54
+
55
+
Required:
56
+
57
+
-`rule_name` (String) Rule name
58
+
-`service_name_template` (String) Specify resource attribute placeholders in curly braces, e.g. {service.name} or {k8s.workload.name}.. All attributes used in the placeholder are required for the rule to apply. If any of them is missing, the rule will not be applied and ruleset evaluation continues.
59
+
60
+
All resolved attribute values contribute to the final service ID.
61
+
62
+
Optional:
63
+
64
+
-`additional_required_attributes` (Set of String) Define resource attributes that should not be part of the name but are required to detect the service, e.g. service.namespace or k8s.workload.kind.. Attributes specified here are required to apply the rule. If any of them is missing, the rule will not be applied and ruleset evaluation continues.
65
+
66
+
All attribute values contribute to the final service ID.
67
+
-`condition` (String) Limits the scope of the service detection rule using [DQL matcher](https://dt-url.net/l603wby) conditions on resource attributes.. A rule is applied only if the condition matches, otherwise the ruleset evaluation continues.
68
+
69
+
If empty, the condition will always match.
70
+
-`description` (String) no documentation available
-`enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
50
+
-`rule` (Block List, Min: 1, Max: 1) Rule (see [below for nested schema](#nestedblock--rule))
51
+
52
+
### Optional
53
+
54
+
-`insert_after` (String) Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
55
+
-`scope` (String) The scope of this setting (CLOUD_APPLICATION_NAMESPACE, KUBERNETES_CLUSTER, HOST_GROUP). Omit this property if you want to cover the whole environment.
56
+
57
+
### Read-Only
58
+
59
+
-`id` (String) The ID of this resource.
60
+
61
+
<aid="nestedblock--rule"></a>
62
+
### Nested Schema for `rule`
63
+
64
+
Required:
65
+
66
+
-`rule_name` (String) Rule name
67
+
68
+
Optional:
69
+
70
+
-`condition` (String) Limits the scope of the service splitting rule using [DQL matcher](https://dt-url.net/l603wby) conditions on resource attributes.. A rule is applied only if the condition matches, otherwise the ruleset evaluation continues.
71
+
72
+
If empty, the condition will always match.
73
+
-`description` (String) no documentation available
74
+
-`service_splitting_attributes` (Block List, Max: 1) Define the entire set of resource attributes that should split your services in the matching scope.. Each attribute that exists will contribute to the final service ID. (see [below for nested schema](#nestedblock--rule--service_splitting_attributes))
### Nested Schema for `rule.service_splitting_attributes`
78
+
79
+
Required:
80
+
81
+
-`service_splitting_attribute` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--rule--service_splitting_attributes--service_splitting_attribute))
0 commit comments