Skip to content

Commit 38197ba

Browse files
committed
Updated documentation prior to release 1.20.0
1 parent 91fa635 commit 38197ba

16 files changed

+565
-13
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the links to the left to learn about the available resources and data source
1818
terraform {
1919
required_providers {
2020
dynatrace = {
21-
version = "1.18.0"
21+
version = "1.20.0"
2222
source = "dynatrace-oss/dynatrace"
2323
}
2424
}

docs/resources/api_token.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ description: |-
77

88
# dynatrace_api_token (Resource)
99

10-
The token value can be retrieved with `dynatrace_api_token.<#name#>.token` after apply.
10+
-> The usage of `dynatrace_api_token` will introduce sensitive data within your Terraform state. The `token` property is flagged as `sensitive`, but the field will be stored as plain-text. More information can be found [here](https://developer.hashicorp.com/terraform/language/state/sensitive-data).
1111

12-
WARNING: The usage of `dynatrace_api_token` will introduce sensitive data within your Terraform state. The `token` property is flagged as `sensitive`, but the field will be stored as plain-text. More information can be found [here](https://developer.hashicorp.com/terraform/language/state/sensitive-data).
12+
-> The token value can be retrieved with `dynatrace_api_token.<#name#>.token` after apply.
1313

1414
## Dynatrace Documentation
1515

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_connectivity_alerts Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_connectivity_alerts` covers configuration for process group connectivity alerts
6+
---
7+
8+
# dynatrace_connectivity_alerts (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Process Groups - https://www.dynatrace.com/support/help/how-to-use-dynatrace/process-groups
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:alerting.connectivity-alerts`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_connectivity_alerts` downloads all existing process group connectivity alerts
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_connectivity_alerts" "PROCESS_GROUP-1234567890000000" {
26+
connectivity_alerts = false
27+
process_group_id = "PROCESS_GROUP-1234567890000000"
28+
}
29+
```
30+
31+
<!-- schema generated by tfplugindocs -->
32+
## Schema
33+
34+
### Required
35+
36+
- `connectivity_alerts` (Boolean) TCP connectivity problems
37+
- `process_group_id` (String) The scope of this settings
38+
39+
### Read-Only
40+
41+
- `id` (String) The ID of this resource.
42+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: ""
3+
page_title: "dynatrace_custom_app_enablement Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_custom_app_enablement` covers configuration for custom application enablement and cost control
6+
---
7+
8+
# dynatrace_custom_app_enablement (Resource)
9+
10+
-> **Settings 2.0** Certain field(s) of this resource has overlap with `dynatrace_mobile_application`, therefore it is excluded from the default export. To retrieve this resource via export, directly specify it as a command line argument.
11+
12+
## Dynatrace Documentation
13+
14+
- Configure cost and traffic control for custom applications - https://www.dynatrace.com/support/help/how-to-use-dynatrace/real-user-monitoring/setup-and-configuration/custom-applications/configure-cost-and-traffic-control-custom
15+
16+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:rum.custom.enablement`)
17+
18+
## Export Example Usage
19+
20+
- `terraform-provider-dynatrace -export dynatrace_custom_app_enablement` downloads all existing custom application enablement and cost control configuration
21+
22+
The full documentation of the export feature is available [here](https://registry.terraform.io/providers/dynatrace-oss/dynatrace/latest/docs/guides/export-v2).
23+
24+
## Resource Example Usage
25+
26+
```terraform
27+
resource "dynatrace_custom_app_enablement" "#name#" {
28+
scope = "environment"
29+
rum {
30+
enabled = false
31+
cost_and_traffic_control = 40
32+
}
33+
}
34+
```
35+
36+
<!-- schema generated by tfplugindocs -->
37+
## Schema
38+
39+
### Required
40+
41+
- `rum` (Block List, Min: 1, Max: 1) Capture and analyze all user actions within your application. Enable [Real User Monitoring (RUM)](https://dt-url.net/1n2b0prq) to monitor and improve your application's performance, identify errors, and gain insight into your user's behavior and experience. (see [below for nested schema](#nestedblock--rum))
42+
43+
### Optional
44+
45+
- `scope` (String) The scope of this setting (CUSTOM_APPLICATION). Omit this property if you want to cover the whole environment.
46+
47+
### Read-Only
48+
49+
- `id` (String) The ID of this resource.
50+
51+
<a id="nestedblock--rum"></a>
52+
### Nested Schema for `rum`
53+
54+
Required:
55+
56+
- `cost_and_traffic_control` (Number) (Field has overlap with `dynatrace_mobile_application`) Percentage of user sessions captured and analyzed. By default, Dynatrace captures all user actions and user sessions for analysis. This approach ensures complete insight into your application’s performance and customer experience. You can optionally reduce the granularity of user-action and user-session analysis by capturing a lower percentage of user sessions. While this approach can reduce monitoring costs, it also results in lower visibility into how your customers are using your applications. For example, a setting of 10% results in Dynatrace analyzing only every tenth user session.
57+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
58+
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_declarative_grouping Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_declarative_grouping` covers configuration for declarative process grouping
6+
---
7+
8+
# dynatrace_declarative_grouping (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Declarative process grouping - https://www.dynatrace.com/support/help/shortlink/process-groups#declare
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:declarativegrouping`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_declarative_grouping` downloads all existing declarative process grouping 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_declarative_grouping" "#name#" {
26+
name = "#name#"
27+
enabled = true
28+
scope = "environment"
29+
detection {
30+
process_definition {
31+
id = "PGIdentifierSample"
32+
process_group_name = "PGDisplayNameSample"
33+
report = "always"
34+
rules {
35+
rule {
36+
condition = "$contains(TFExecutableSample)"
37+
property = "executable"
38+
}
39+
rule {
40+
condition = "$contains(TFCommandSample)"
41+
property = "commandLine"
42+
}
43+
}
44+
}
45+
}
46+
}
47+
```
48+
49+
<!-- schema generated by tfplugindocs -->
50+
## Schema
51+
52+
### Required
53+
54+
- `detection` (Block List, Min: 1, Max: 1) Enter a descriptive process group display name and a unique identifier that Dynatrace can use to recognize this process group. (see [below for nested schema](#nestedblock--detection))
55+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
56+
- `name` (String) Monitored technology name
57+
58+
### Optional
59+
60+
- `scope` (String) The scope of this setting (HOST, HOST_GROUP). Omit this property if you want to cover the whole environment.
61+
62+
### Read-Only
63+
64+
- `id` (String) The ID of this resource.
65+
66+
<a id="nestedblock--detection"></a>
67+
### Nested Schema for `detection`
68+
69+
Required:
70+
71+
- `process_definition` (Block List, Min: 1) (see [below for nested schema](#nestedblock--detection--process_definition))
72+
73+
<a id="nestedblock--detection--process_definition"></a>
74+
### Nested Schema for `detection.process_definition`
75+
76+
Required:
77+
78+
- `id` (String) Process group identifier
79+
- `process_group_name` (String) This identifier is used by Dynatrace to recognize this process group.
80+
- `report` (String) Possible Values: `Never`, `Always`, `HighResourceUsage`
81+
- `rules` (Block List, Min: 1, Max: 1) Define process detection rules by selecting a process property and a condition. Each process group can have multiple detection rules associated with it. (see [below for nested schema](#nestedblock--detection--process_definition--rules))
82+
83+
<a id="nestedblock--detection--process_definition--rules"></a>
84+
### Nested Schema for `detection.process_definition.rules`
85+
86+
Required:
87+
88+
- `rule` (Block List, Min: 1) (see [below for nested schema](#nestedblock--detection--process_definition--rules--rule))
89+
90+
<a id="nestedblock--detection--process_definition--rules--rule"></a>
91+
### Nested Schema for `detection.process_definition.rules.rule`
92+
93+
Required:
94+
95+
- `condition` (String) - $contains(svc) – Matches if svc appears anywhere in the process property value.
96+
- $eq(svc.exe) – Matches if svc.exe matches the process property value exactly.
97+
- $prefix(svc) – Matches if app matches the prefix of the process property value.
98+
- $suffix(svc.py) – Matches if svc.py matches the suffix of the process property value.
99+
100+
For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py.
101+
102+
For more details, see [Declarative process grouping](https://dt-url.net/j142w57).
103+
- `property` (String) Possible Values: `Executable`, `ExecutablePath`, `CommandLine`
104+

docs/resources/environment.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,16 @@ Optional:
6161

6262
Required:
6363

64-
- `logs` (Number) Log monitoring retention settings on environment level in days. Not editable when Log monitoring is not allowed by license or not configured on cluster level. Can be set to any value from 5 to 90 days
6564
- `rum` (Number) Real user monitoring retention settings on environment level in days. Can be set to any value from 1 to 35 days
6665
- `service_code_level` (Number) Service code level retention settings on environment level in days. Service code level retention time can't be greater than service request level retention time and both can't exceed one year
6766
- `service_request_level` (Number) Service request level retention settings on environment level in days. Service code level retention time can't be greater than service request level retention time and both can't exceed one year
6867
- `session_replay` (Number) Session replay retention settings on environment level in days. Can be set to any value from 1 to 35 days
6968
- `synthetic` (Number) Synthetic monitoring retention settings on environment level in days. Can be set to any value from 1 to 35 days
7069

70+
Optional:
71+
72+
- `logs` (Number) Log monitoring retention settings on environment level in days. Not editable when Log monitoring is not allowed by license or not configured on cluster level. Can be set to any value from 5 to 90 days
73+
7174

7275

7376
<a id="nestedblock--quotas"></a>

docs/resources/host_monitoring.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_host_monitoring Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_host_monitoring` covers configuration for host monitoring
6+
---
7+
8+
# dynatrace_host_monitoring (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Hosts - https://www.dynatrace.com/support/help/how-to-use-dynatrace/infrastructure-monitoring/hosts
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:host.monitoring`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_host_monitoring` downloads all existing host monitoring 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_host_monitoring" "#name#" {
26+
enabled = true
27+
auto_injection = false
28+
full_stack = false
29+
host_id = "HOST-1234567890000000"
30+
}
31+
```
32+
33+
<!-- schema generated by tfplugindocs -->
34+
## Schema
35+
36+
### Required
37+
38+
- `auto_injection` (Boolean) An auto-injection disabled with [oneagentctl](https://dt-url.net/oneagentctl) takes precedence over this setting and cannot be changed from the Dynatrace web UI.
39+
- `enabled` (Boolean) This setting is enabled (`true`) or disabled (`false`)
40+
- `full_stack` (Boolean) Dynatrace uses full-stack monitoring by default, to monitor every aspect of your environment, including all processes, services, and applications detected on your hosts.
41+
42+
If you turn off full-stack monitoring, Dynatrace will only monitor your infrastructure. You will lose access to application performance, user experience data, code-level visibility and PurePath insights.
43+
44+
To learn more, visit [Infrastructure Monitoring mode](https://www.dynatrace.com/support/help/shortlink/infrastructure).
45+
46+
Please note that changing the monitoring mode will impact the license consumption of this OneAgent. To learn more, visit [Host units](https://dt-url.net/hi03uns).
47+
- `host_id` (String) The scope of this settings. If the settings should cover the whole environment, just don't specify any scope.
48+
49+
### Read-Only
50+
51+
- `id` (String) The ID of this resource.
52+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: ""
3+
page_title: dynatrace_host_process_group_monitoring Resource - terraform-provider-dynatrace"
4+
description: |-
5+
The resource `dynatrace_host_process_group_monitoring` covers configuration of host level process group monitoring rules
6+
---
7+
8+
# dynatrace_host_process_group_monitoring (Resource)
9+
10+
## Dynatrace Documentation
11+
12+
- Set monitoring rules at host level - https://www.dynatrace.com/support/help/how-to-use-dynatrace/process-groups/configuration/pg-monitoring#set-monitoring-rules-at-host-level
13+
14+
- Settings API - https://www.dynatrace.com/support/help/dynatrace-api/environment-api/settings (schemaId: `builtin:host.process-groups.monitoring-state`)
15+
16+
## Export Example Usage
17+
18+
- `terraform-provider-dynatrace -export dynatrace_host_process_group_monitoring` downloads all existing host level process group monitoring 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_host_process_group_monitoring" "#name#" {
26+
host_id = "HOST-1234567890000000"
27+
monitoring_state = "MONITORING_ON"
28+
process_group = "PROCESS_GROUP-1234567890000000"
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Required
36+
37+
- `host_id` (String) The scope of this settings. If the settings should cover the whole environment, just don't specify any scope.
38+
- `monitoring_state` (String) Possible Values: `DEFAULT`, `MONITORING_OFF`, `MONITORING_ON`
39+
- `process_group` (String) Process group
40+
41+
### Read-Only
42+
43+
- `id` (String) The ID of this resource.
44+

0 commit comments

Comments
 (0)