Skip to content

Commit c9b6b32

Browse files
Reinhard-Pilz-DynatraceReinhard-Pilz-Dynatrace
committed
updated documentation prior to release 1.19.0
1 parent 6df405f commit c9b6b32

28 files changed

+2585
-18
lines changed

‎docs/data-sources/alerting_profiles.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,16 @@ resource "dynatrace_notification" "#name#" {
3838

3939
### Read-Only
4040

41-
- `id` (String) The ID of this resource.
41+
- `id` (String) The ID of this resource.
42+
- `values` (List of Object) (see [below for nested schema](#nestedatt--values))
43+
44+
<a id="nestedatt--values"></a>
45+
### Nested Schema for `values`
46+
47+
Read-Only:
48+
49+
- `id` (String)
50+
- `legacy_id` (String)
51+
- `management_zone_id` (String)
52+
- `management_zone_legacy_id` (String)
53+
- `name` (String)

‎docs/data-sources/management_zones.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dynatrace_management_zones Data Source - terraform-provider-dynatrace"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# dynatrace_management_zones (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `id` (String) The ID of this resource.
21+
- `values` (List of Object) (see [below for nested schema](#nestedatt--values))
22+
23+
<a id="nestedatt--values"></a>
24+
### Nested Schema for `values`
25+
26+
Read-Only:
27+
28+
- `description` (String)
29+
- `id` (String)
30+
- `legacy_id` (String)
31+
- `name` (String)
32+
33+

‎docs/data-sources/service.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ resource "dynatrace_key_requests" "#name#" {
3636

3737
### Optional
3838

39+
- `operator` (String)
3940
- `tags` (Set of String) Required tags of the service to find
4041

4142
### Read-Only

‎docs/guides/export-v2.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,13 @@ description: |-
66
---
77

88
## Export Utility
9+
Windows: `terraform-provider-dynatrace.exe -export [-ref] [-id] [-flat] [-exclude] [<resourcename>[=<id>]]`
910

10-
### Command Line Syntax
11-
Invoking the export functionality requires
12-
* The environment variable `DYNATRACE_ENV_URL` as the URL of your Dynatrace environment
13-
* The environment variable `DYNATRACE_API_TOKEN` as the API Token of your Dynatrace environment
14-
* Optionally the environment variable `DYNATRACE_TARGET_FOLDER`. If it's not set, the output folder `./configuration` is assumed
15-
16-
Windows: `terraform-provider-dynatrace.exe -export [-v] [-ref] [-id] [-migrate] [-exclude] [<resourcename>[=<id>]]`
17-
18-
Linux: `./terraform-provider-dynatrace -export [-v] [-ref] [-id] [-migrate] [-exclude] [<resourcename>[=<id>]]`
11+
Linux: `./terraform-provider-dynatrace -export [-ref] [-id] [-flat] [-exclude] [<resourcename>[=<id>]]`
1912
### Options
20-
* `-v` Enable verbose logging
2113
* `-ref` Enable resources with data sources and dependencies
2214
* `-id` Enable commented id output in resource files
23-
* `-migrate` Enable output specific to environment migration
24-
- Removes node IDs from private synthetic locations
15+
* `-flat` All downloaded resources end up directly within the target folder - no module structure will be created
2516
* `-exclude` Exclude specified resource(s) from export
2617

2718
**NOTE:** Dashboards (because there could be thousands of them) are currently excluded from the export unless the resource is directly specified in the command line arguments.

‎docs/resources/custom_app_anomalies.md‎

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_custom_app_anomalies Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_custom_app_anomalies` covers configuration for custom application anomaly detection
6+
---
7+
8+
# dynatrace_custom_app_anomalies (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Adjust the sensitivity of anomaly detection for applications - https://www.dynatrace.com/support/help/how-to-use-dynatrace/problem-detection-and-analysis/problem-detection/adjust-sensitivity-anomaly-detection/adjust-sensitivity-applications
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:anomaly-detection.rum-custom`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_custom_app_anomalies` downloads all existing custom application anomaly detection configuration
19+
20+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
21+
22+
## Resource Example Usage
23+
24+
```terraform
25+
resource "dynatrace_custom_app_anomalies" "#name#" {
26+
scope = "CUSTOM_APPLICATION-1234567890000000"
27+
error_rate_increase {
28+
enabled = true
29+
detection_mode = "fixed"
30+
error_rate_increase_fixed {
31+
sensitivity = "low"
32+
threshold_absolute = 5
33+
}
34+
}
35+
slow_user_actions {
36+
enabled = false
37+
}
38+
unexpected_high_load {
39+
enabled = true
40+
threshold_percentage = 300
41+
}
42+
unexpected_low_load {
43+
enabled = true
44+
threshold_percentage = 80
45+
}
46+
}
47+
```
48+
49+
<!-- schema generated by tfplugindocs -->
50+
## Schema
51+
52+
### Required
53+
54+
- `error_rate_increase` (Block List, Min: 1, Max: 1) Error rate increase (see [below for nested schema](#nestedblock--error_rate_increase))
55+
- `slow_user_actions` (Block List, Min: 1, Max: 1) Slow user actions (see [below for nested schema](#nestedblock--slow_user_actions))
56+
- `unexpected_high_load` (Block List, Min: 1, Max: 1) Unexpected high load (see [below for nested schema](#nestedblock--unexpected_high_load))
57+
- `unexpected_low_load` (Block List, Min: 1, Max: 1) Unexpected low load (see [below for nested schema](#nestedblock--unexpected_low_load))
58+
59+
### Optional
60+
61+
- `scope` (String) The scope of this setting (DEVICE_APPLICATION_METHOD CUSTOM_APPLICATION environment)
62+
63+
### Read-Only
64+
65+
- `id` (String) The ID of this resource.
66+
67+
<a id="nestedblock--error_rate_increase"></a>
68+
### Nested Schema for `error_rate_increase`
69+
70+
Required:
71+
72+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
73+
74+
Optional:
75+
76+
- `detection_mode` (String) Possible Values: `Auto`, `Fixed`
77+
- `error_rate_increase_auto` (Block List, Max: 1) Alert if the percentage of user actions affected by reported errors exceeds **both** the absolute threshold and the relative threshold (see [below for nested schema](#nestedblock--error_rate_increase--error_rate_increase_auto))
78+
- `error_rate_increase_fixed` (Block List, Max: 1) Alert if the custom reported error rate threshold is exceeded during any 5-minute period (see [below for nested schema](#nestedblock--error_rate_increase--error_rate_increase_fixed))
79+
80+
<a id="nestedblock--error_rate_increase--error_rate_increase_auto"></a>
81+
### Nested Schema for `error_rate_increase.error_rate_increase_auto`
82+
83+
Required:
84+
85+
- `threshold_absolute` (Number) Absolute threshold
86+
- `threshold_relative` (Number) Relative threshold
87+
88+
89+
<a id="nestedblock--error_rate_increase--error_rate_increase_fixed"></a>
90+
### Nested Schema for `error_rate_increase.error_rate_increase_fixed`
91+
92+
Required:
93+
94+
- `sensitivity` (String) Possible Values: `Low`, `Medium`, `High`
95+
- `threshold_absolute` (Number) Absolute threshold
96+
97+
98+
99+
<a id="nestedblock--slow_user_actions"></a>
100+
### Nested Schema for `slow_user_actions`
101+
102+
Required:
103+
104+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
105+
106+
Optional:
107+
108+
- `detection_mode` (String) Possible Values: `Auto`, `Fixed`
109+
- `slow_user_actions_auto` (Block List, Max: 1) no documentation available (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_auto))
110+
- `slow_user_actions_fixed` (Block List, Max: 1) no documentation available (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_fixed))
111+
112+
<a id="nestedblock--slow_user_actions--slow_user_actions_auto"></a>
113+
### Nested Schema for `slow_user_actions.slow_user_actions_auto`
114+
115+
Required:
116+
117+
- `duration_avoid_overalerting` (Block List, Min: 1, Max: 1) To avoid over-alerting do not alert for low traffic applications with less than (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_auto--duration_avoid_overalerting))
118+
- `duration_threshold_all` (Block List, Min: 1, Max: 1) Alert if the action duration of all user actions degrades beyond **both** the absolute and relative threshold: (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_auto--duration_threshold_all))
119+
- `duration_threshold_slowest` (Block List, Min: 1, Max: 1) Alert if the action duration of the slowest 10% of user actions degrades beyond **both** the absolute and relative threshold: (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_auto--duration_threshold_slowest))
120+
121+
<a id="nestedblock--slow_user_actions--slow_user_actions_auto--duration_avoid_overalerting"></a>
122+
### Nested Schema for `slow_user_actions.slow_user_actions_auto.duration_avoid_overalerting`
123+
124+
Required:
125+
126+
- `min_action_rate` (Number) no documentation available
127+
128+
129+
<a id="nestedblock--slow_user_actions--slow_user_actions_auto--duration_threshold_all"></a>
130+
### Nested Schema for `slow_user_actions.slow_user_actions_auto.duration_threshold_all`
131+
132+
Required:
133+
134+
- `duration_threshold` (Number) Absolute threshold
135+
- `slowdown_percentage` (Number) Relative threshold
136+
137+
138+
<a id="nestedblock--slow_user_actions--slow_user_actions_auto--duration_threshold_slowest"></a>
139+
### Nested Schema for `slow_user_actions.slow_user_actions_auto.duration_threshold_slowest`
140+
141+
Required:
142+
143+
- `duration_threshold` (Number) Absolute threshold
144+
- `slowdown_percentage` (Number) Relative threshold
145+
146+
147+
148+
<a id="nestedblock--slow_user_actions--slow_user_actions_fixed"></a>
149+
### Nested Schema for `slow_user_actions.slow_user_actions_fixed`
150+
151+
Required:
152+
153+
- `duration_avoid_overalerting` (Block List, Min: 1, Max: 1) To avoid over-alerting do not alert for low traffic applications with less than (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_fixed--duration_avoid_overalerting))
154+
- `duration_threshold_all_fixed` (Block List, Min: 1, Max: 1) Alert if the action duration of all user actions degrades beyond the absolute threshold: (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_fixed--duration_threshold_all_fixed))
155+
- `duration_threshold_slowest` (Block List, Min: 1, Max: 1) Alert if the action duration of the slowest 10% of user actions degrades beyond the absolute threshold: (see [below for nested schema](#nestedblock--slow_user_actions--slow_user_actions_fixed--duration_threshold_slowest))
156+
- `sensitivity` (String) Possible Values: `Medium`, `High`, `Low`
157+
158+
<a id="nestedblock--slow_user_actions--slow_user_actions_fixed--duration_avoid_overalerting"></a>
159+
### Nested Schema for `slow_user_actions.slow_user_actions_fixed.duration_avoid_overalerting`
160+
161+
Required:
162+
163+
- `min_action_rate` (Number) no documentation available
164+
165+
166+
<a id="nestedblock--slow_user_actions--slow_user_actions_fixed--duration_threshold_all_fixed"></a>
167+
### Nested Schema for `slow_user_actions.slow_user_actions_fixed.duration_threshold_all_fixed`
168+
169+
Required:
170+
171+
- `duration_threshold` (Number) Absolute threshold
172+
173+
174+
<a id="nestedblock--slow_user_actions--slow_user_actions_fixed--duration_threshold_slowest"></a>
175+
### Nested Schema for `slow_user_actions.slow_user_actions_fixed.duration_threshold_slowest`
176+
177+
Required:
178+
179+
- `duration_threshold` (Number) Absolute threshold
180+
181+
182+
183+
184+
<a id="nestedblock--unexpected_high_load"></a>
185+
### Nested Schema for `unexpected_high_load`
186+
187+
Required:
188+
189+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
190+
191+
Optional:
192+
193+
- `threshold_percentage` (Number) Dynatrace learns your typical application traffic over an observation period of one week. Depending on this expected value Dynatrace detects abnormal traffic spikes within your application.
194+
195+
196+
<a id="nestedblock--unexpected_low_load"></a>
197+
### Nested Schema for `unexpected_low_load`
198+
199+
Required:
200+
201+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
202+
203+
Optional:
204+
205+
- `threshold_percentage` (Number) Dynatrace learns your typical application traffic over an observation period of one week. Depending on this expected value Dynatrace detects abnormal traffic drops within your application.
206+

‎docs/resources/custom_app_crash_rate.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_custom_app_crash_rate Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_custom_app_crash_rate` covers configuration for custom application crash rate increase
6+
---
7+
8+
# dynatrace_custom_app_crash_rate (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Adjust the sensitivity of anomaly detection for applications - https://www.dynatrace.com/support/help/how-to-use-dynatrace/problem-detection-and-analysis/problem-detection/adjust-sensitivity-anomaly-detection/adjust-sensitivity-applications
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:anomaly-detection.rum-custom-crash-rate-increase`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_custom_app_crash_rate` downloads all existing custom application crash rate increase configuration
19+
20+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
21+
22+
## Resource Example Usage
23+
24+
```terraform
25+
resource "dynatrace_custom_app_crash_rate" "CUSTOM_APPLICATION-1234567890000000" {
26+
scope = "CUSTOM_APPLICATION-1234567890000000"
27+
crash_rate_increase {
28+
enabled = true
29+
detection_mode = "fixed"
30+
crash_rate_increase_fixed {
31+
absolute_crash_rate = 25
32+
concurrent_users = 200
33+
}
34+
}
35+
}
36+
```
37+
38+
<!-- schema generated by tfplugindocs -->
39+
## Schema
40+
41+
### Required
42+
43+
- `crash_rate_increase` (Block List, Min: 1, Max: 1) Crash rate increase (see [below for nested schema](#nestedblock--crash_rate_increase))
44+
45+
### Optional
46+
47+
- `scope` (String) The scope of this setting (CUSTOM_APPLICATION environment)
48+
49+
### Read-Only
50+
51+
- `id` (String) The ID of this resource.
52+
53+
<a id="nestedblock--crash_rate_increase"></a>
54+
### Nested Schema for `crash_rate_increase`
55+
56+
Required:
57+
58+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
59+
60+
Optional:
61+
62+
- `crash_rate_increase_auto` (Block List, Max: 1) Alert crash rate increases when auto-detected baseline is exceeded by a certain number of users (see [below for nested schema](#nestedblock--crash_rate_increase--crash_rate_increase_auto))
63+
- `crash_rate_increase_fixed` (Block List, Max: 1) Alert crash rate increases when the defined threshold is exceeded by a certain number of users (see [below for nested schema](#nestedblock--crash_rate_increase--crash_rate_increase_fixed))
64+
- `detection_mode` (String) Possible Values: `Auto`, `Fixed`
65+
66+
<a id="nestedblock--crash_rate_increase--crash_rate_increase_auto"></a>
67+
### Nested Schema for `crash_rate_increase.crash_rate_increase_auto`
68+
69+
Required:
70+
71+
- `baseline_violation_percentage` (Number) Dynatrace learns the typical crash rate for all app versions and will create an alert if the baseline is violated by more than a specified threshold. Analysis happens based on a sliding window of 10 minutes.
72+
- `concurrent_users` (Number) Amount of users
73+
- `sensitivity` (String) Possible Values: `Low`, `Medium`, `High`
74+
75+
76+
<a id="nestedblock--crash_rate_increase--crash_rate_increase_fixed"></a>
77+
### Nested Schema for `crash_rate_increase.crash_rate_increase_fixed`
78+
79+
Required:
80+
81+
- `absolute_crash_rate` (Number) Absolute threshold
82+
- `concurrent_users` (Number) Amount of users
83+

‎docs/resources/dashboard.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,7 @@ Required:
929929
Optional:
930930

931931
- `assigned_entities` (Set of String) The list of Dynatrace entities, assigned to the tile
932+
- `auto_refresh_disabled` (Boolean) Auto Refresh is disabled (`true`)
932933
- `bounds` (Block List, Max: 1) the position and size of a tile (see [below for nested schema](#nestedblock--tile--bounds))
933934
- `chart_visible` (Boolean)
934935
- `configured` (Boolean) The tile is configured and ready to use (`true`) or just placed on the dashboard (`false`)

0 commit comments

Comments
 (0)