|
1 | 1 | ---
|
2 |
| -# generated by https://github.com/hashicorp/terraform-plugin-docs |
3 | 2 | page_title: "grafana_apps_alertenrichment_alertenrichment_v1beta1 Resource - terraform-provider-grafana"
|
4 | 3 | subcategory: "Alerting"
|
5 | 4 | description: |-
|
6 |
| - Manages Grafana Alert Enrichments. |
| 5 | + Under development |
7 | 6 | ---
|
8 | 7 |
|
9 | 8 | # grafana_apps_alertenrichment_alertenrichment_v1beta1 (Resource)
|
10 | 9 |
|
11 |
| -Manages Grafana Alert Enrichments. |
12 |
| - |
13 |
| -## Example Usage |
14 |
| - |
15 |
| -```terraform |
16 |
| -resource "grafana_apps_alertenrichment_alertenrichment_v1beta1" "example" { |
17 |
| - metadata = { |
18 |
| - uid = "alert-enrichment-example" |
19 |
| - } |
20 |
| -
|
21 |
| - spec { |
22 |
| - title = "Critical Alert Enrichment Pipeline" |
23 |
| - description = "Enriches critical production alerts with team information" |
24 |
| -
|
25 |
| - # Apply only to specific alert rules |
26 |
| - alert_rule_uids = ["high-cpu-alert", "disk-space-alert"] |
27 |
| -
|
28 |
| - # Apply only to specific receivers |
29 |
| - receivers = ["critical-alerts", "alerting-team"] |
30 |
| -
|
31 |
| - # Match alerts with specific labels |
32 |
| - label_matchers = [ |
33 |
| - { |
34 |
| - type = "=" |
35 |
| - name = "severity" |
36 |
| - value = "critical" |
37 |
| - }, |
38 |
| - { |
39 |
| - type = "=~" # Regex match |
40 |
| - name = "environment" |
41 |
| - value = "prod.*" |
42 |
| - }, |
43 |
| - { |
44 |
| - type = "!=" |
45 |
| - name = "team" |
46 |
| - value = "test" |
47 |
| - } |
48 |
| - ] |
49 |
| -
|
50 |
| - # Match alerts with specific annotations |
51 |
| - annotation_matchers = [ |
52 |
| - { |
53 |
| - type = "!~" # Regex not match |
54 |
| - name = "runbook_url" |
55 |
| - value = "^http://grafana.com$" |
56 |
| - } |
57 |
| - ] |
58 |
| -
|
59 |
| - step { |
60 |
| - assign { |
61 |
| - annotations = { |
62 |
| - enrichment_team = "alerting-team" |
63 |
| - runbook_url = "https://runbooks.grafana.com/critical-alerts" |
64 |
| - contact_slack = "#alerts-critical" |
65 |
| - incident_severity = "high" |
66 |
| - } |
67 |
| - timeout = "30s" |
68 |
| - } |
69 |
| - } |
70 |
| - } |
71 |
| -} |
72 |
| -``` |
73 |
| - |
74 |
| -<!-- schema generated by tfplugindocs --> |
75 |
| -## Schema |
76 |
| - |
77 |
| -### Optional |
78 |
| - |
79 |
| -- `metadata` (Block, Optional) The metadata of the resource. (see [below for nested schema](#nestedblock--metadata)) |
80 |
| -- `options` (Block, Optional) Options for applying the resource. (see [below for nested schema](#nestedblock--options)) |
81 |
| -- `spec` (Block, Optional) The spec of the resource. (see [below for nested schema](#nestedblock--spec)) |
82 |
| - |
83 |
| -### Read-Only |
84 |
| - |
85 |
| -- `id` (String) The ID of the resource derived from UUID. |
86 |
| - |
87 |
| -<a id="nestedblock--metadata"></a> |
88 |
| -### Nested Schema for `metadata` |
89 |
| - |
90 |
| -Required: |
91 |
| - |
92 |
| -- `uid` (String) The unique identifier of the resource. |
93 |
| - |
94 |
| -Optional: |
95 |
| - |
96 |
| -- `folder_uid` (String) The UID of the folder to save the resource in. |
97 |
| - |
98 |
| -Read-Only: |
99 |
| - |
100 |
| -- `url` (String) The full URL of the resource. |
101 |
| -- `uuid` (String) The globally unique identifier of a resource, used by the API for tracking. |
102 |
| -- `version` (String) The version of the resource. |
103 |
| - |
104 |
| - |
105 |
| -<a id="nestedblock--options"></a> |
106 |
| -### Nested Schema for `options` |
107 |
| - |
108 |
| -Optional: |
109 |
| - |
110 |
| -- `overwrite` (Boolean) Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid. |
111 |
| - |
112 |
| - |
113 |
| -<a id="nestedblock--spec"></a> |
114 |
| -### Nested Schema for `spec` |
115 |
| - |
116 |
| -Required: |
117 |
| - |
118 |
| -- `title` (String) The title of the alert enrichment. |
119 |
| - |
120 |
| -Optional: |
121 |
| - |
122 |
| -- `alert_rule_uids` (List of String) UIDs of alert rules this enrichment applies to. If empty, applies to all alert rules. |
123 |
| -- `annotation_matchers` (List of Object) Annotation matchers that an alert must satisfy for this enrichment to apply. Each matcher is an object with: 'type' (string, one of: =, !=, =~, !~), 'name' (string, annotation key to match), 'value' (string, annotation value to compare against, supports regex for =~/!~ operators). (see [below for nested schema](#nestedatt--spec--annotation_matchers)) |
124 |
| -- `description` (String) Description of the alert enrichment. |
125 |
| -- `label_matchers` (List of Object) Label matchers that an alert must satisfy for this enrichment to apply. Each matcher is an object with: 'type' (string, one of: =, !=, =~, !~), 'name' (string, label key to match), 'value' (string, label value to compare against, supports regex for =~/!~ operators). (see [below for nested schema](#nestedatt--spec--label_matchers)) |
126 |
| -- `receivers` (List of String) Receiver names to match. If empty, applies to all receivers. |
127 |
| -- `step` (Block List) Enrichment step. Can be repeated multiple times to define a sequence of steps. Each step must contain exactly one enrichment block. (see [below for nested schema](#nestedblock--spec--step)) |
128 |
| - |
129 |
| -<a id="nestedatt--spec--annotation_matchers"></a> |
130 |
| -### Nested Schema for `spec.annotation_matchers` |
131 |
| - |
132 |
| -Optional: |
133 |
| - |
134 |
| -- `name` (String) |
135 |
| -- `type` (String) |
136 |
| -- `value` (String) |
137 |
| - |
138 |
| - |
139 |
| -<a id="nestedatt--spec--label_matchers"></a> |
140 |
| -### Nested Schema for `spec.label_matchers` |
141 |
| - |
142 |
| -Optional: |
143 |
| - |
144 |
| -- `name` (String) |
145 |
| -- `type` (String) |
146 |
| -- `value` (String) |
147 |
| - |
148 |
| - |
149 |
| -<a id="nestedblock--spec--step"></a> |
150 |
| -### Nested Schema for `spec.step` |
151 |
| - |
152 |
| -Optional: |
153 |
| - |
154 |
| -- `assign` (Block, Optional) Assign annotations to an alert. (see [below for nested schema](#nestedblock--spec--step--assign)) |
155 |
| - |
156 |
| -<a id="nestedblock--spec--step--assign"></a> |
157 |
| -### Nested Schema for `spec.step.assign` |
158 |
| - |
159 |
| -Optional: |
160 |
| - |
161 |
| -- `annotations` (Map of String) Map of annotation names to values to set on matching alerts. |
162 |
| -- `timeout` (String) Maximum execution time (e.g., '30s', '1m') |
| 10 | +This resource is currently under development. Documentation will be provided in a future release. |
0 commit comments