Skip to content

Commit faa1a77

Browse files
committed
add new alert types naming
1 parent 73f6a82 commit faa1a77

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

website/docs/r/monitor_alert_metric.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Sysdig Monitor"
33
layout: "sysdig"
44
page_title: "Sysdig: sysdig_monitor_alert_metric"
55
description: |-
6-
Creates a Sysdig Monitor Metric Alert.
6+
Creates a Sysdig Monitor Metric Threshold Alert.
77
---
88

99
# Resource: sysdig_monitor_alert_metric
1010

11-
Creates a Sysdig Monitor Metric Alert. Monitor time-series metrics and alert if they violate user-defined thresholds.
11+
Creates a Sysdig Monitor Metric Threshold Alert. Monitor time-series metrics and alert if they violate user-defined thresholds.
1212

1313
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1414

@@ -90,7 +90,7 @@ In addition to all arguments above, the following attributes are exported, which
9090

9191
## Import
9292

93-
Metric alerts can be imported using the alert ID, e.g.
93+
Metric Threshold alerts can be imported using the alert ID, e.g.
9494

9595
```
9696
$ terraform import sysdig_monitor_alert_metric.example 12345

website/docs/r/monitor_alert_promql.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Sysdig Monitor"
33
layout: "sysdig"
44
page_title: "Sysdig: sysdig_monitor_alert_promql"
55
description: |-
6-
Creates a Sysdig Monitor PromQL Alert.
6+
Creates a Sysdig Monitor Prometheus Alert.
77
---
88

99
# Resource: sysdig_monitor_alert_promql
1010

11-
Creates a Sysdig Monitor PromQL Alert. Monitor prometheus metrics and alert if they violate user-defined PromQL-based metric expression.
11+
Creates a Sysdig Monitor Prometheus Alert. Monitor prometheus metrics and alert if they violate user-defined PromQL-based metric expression.
1212

1313
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1414

@@ -50,7 +50,7 @@ By defining this field, the user can modify the title and the body of the messag
5050
* `prepend` - (Optional) Text to add before the alert template.
5151
* `append` - (Optional) Text to add after the alert template.
5252

53-
### PromQL alert arguments
53+
### Prometheus alert arguments
5454

5555
* `promql` - (Required) PromQL-based metric expression to alert on. Example: `histogram_quantile(0.99, rate(etcd_http_successful_duration_seconds_bucket[5m]) > 0.15` or `predict_linear(sysdig_fs_free_bytes{fstype!~"tmpfs"}[1h], 24*3600) < 10000000000`.
5656

@@ -69,7 +69,7 @@ In addition to all arguments above, the following attributes are exported, which
6969

7070
## Import
7171

72-
PromQL alerts can be imported using the alert ID, e.g.
72+
Prometheus alerts can be imported using the alert ID, e.g.
7373

7474
```
7575
$ terraform import sysdig_monitor_alert_promql.example 12345

website/docs/r/monitor_alert_v2_change.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Sysdig Monitor"
33
layout: "sysdig"
44
page_title: "Sysdig: sysdig_monitor_alert_v2_change"
55
description: |-
6-
Creates a Sysdig Monitor Change Alert with AlertV2 API.
6+
Creates a Sysdig Monitor Percentage of Change Alert with AlertV2 API.
77
---
88

99
# Resource: sysdig_monitor_alert_v2_change
1010

11-
Creates a Sysdig Monitor Change Alert. Change Alerts trigger when a metric value substantially deviates compared to historical values.
11+
Creates a Sysdig Monitor Percentage of Change Alert. Percentage of Change Alerts trigger when a metric value substantially deviates compared to historical values.
1212

1313
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1414

@@ -92,7 +92,7 @@ By defining this field, the user can add link to notifications.
9292
* `href` - (Optional) When using `runbook` type, url of the external resource.
9393
* `id` - (Optional) When using `dashboard` type, dashboard id.
9494

95-
### Change alert arguments
95+
### Percentage of Change alert arguments
9696

9797
* `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. Can be repeated.
9898
* `group_by` - (Optional) List of segments to trigger a separate alert on. Example: `["kube_cluster_name", "kube_pod_name"]`.
@@ -127,7 +127,7 @@ In addition to all arguments above, the following attributes are exported, which
127127

128128
## Import
129129

130-
Change alerts can be imported using the alert ID, e.g.
130+
Percentage of Change alerts can be imported using the alert ID, e.g.
131131

132132
```
133133
$ terraform import sysdig_monitor_alert_v2_change.example 12345

website/docs/r/monitor_alert_v2_form_based_prometheus.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Sysdig Monitor"
33
layout: "sysdig"
44
page_title: "Sysdig: sysdig_monitor_alert_v2_form_based_prometheus"
55
description: |-
6-
Creates a Sysdig Monitor Form Based Prometheus Alert with AlertV2 API.
6+
Creates a Sysdig Monitor Threshold Prometheus Alert with AlertV2 API.
77
---
88

99
# Resource: sysdig_monitor_alert_v2_form_based_prometheus
1010

11-
Creates a Sysdig Monitor Form Based Prometheus Alert. The notification is triggered on the user-defined PromQL expression with a threshold and operator defined outside of the expression, as described in [here](https://docs.sysdig.com/en/docs/sysdig-monitor/alerts/alert-types/metric-alerts/#translate-to-promql).
11+
Creates a Sysdig Monitor Prometheus Threshold Alert. The notification is triggered on the user-defined PromQL expression with a threshold and operator defined outside of the expression, as described in [here](https://docs.sysdig.com/en/docs/sysdig-monitor/alerts/alert-types/metric-alerts/#translate-to-promql).
1212

1313
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1414

@@ -71,7 +71,7 @@ By defining this field, the user can add link to notifications.
7171
* `href` - (Optional) When using `runbook` type, url of the external resource.
7272
* `id` - (Optional) When using `dashboard` type, dashboard id.
7373

74-
### Form Based Prometheus alert arguments
74+
### Threshold Prometheus alert arguments
7575

7676
* `query` - (Required) PromQL-based metric expression to alert on. Example: `sysdig_host_memory_available_bytes / sysdig_host_memory_total_bytes * 100` or `avg_over_time(sysdig_container_cpu_used_percent{}[59s])`.
7777
* `operator` - (Required) Operator for the condition to alert on. It can be `>`, `>=`, `<`, `<=`, `=` or `!=`.
@@ -95,7 +95,7 @@ In addition to all arguments above, the following attributes are exported, which
9595

9696
## Import
9797

98-
Form Based Prometheus alerts can be imported using the alert ID, e.g.
98+
Threshold Prometheus alerts can be imported using the alert ID, e.g.
9999

100100
```
101101
$ terraform import sysdig_monitor_alert_v2_form_based_prometheus.example 12345

website/docs/r/monitor_alert_v2_metric.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Sysdig Monitor"
33
layout: "sysdig"
44
page_title: "Sysdig: sysdig_monitor_alert_v2_metric"
55
description: |-
6-
Creates a Sysdig Monitor Metric Alert with AlertV2 API.
6+
Creates a Sysdig Monitor Metric Threshold Alert with AlertV2 API.
77
---
88

99
# Resource: sysdig_monitor_alert_v2_metric
1010

11-
Creates a Sysdig Monitor Metric Alert. Monitor time-series metrics and alert if they violate user-defined thresholds.
11+
Creates a Sysdig Monitor Metric Threshold Alert. Monitor time-series metrics and alert if they violate user-defined thresholds.
1212

1313
-> **Note:** Sysdig Terraform Provider is under rapid development at this point. If you experience any issue or discrepancy while using it, please make sure you have the latest version. If the issue persists, or you have a Feature Request to support an additional set of resources, please open a [new issue](https://github.com/sysdiglabs/terraform-provider-sysdig/issues/new) in the GitHub repository.
1414

@@ -104,7 +104,7 @@ Enables the creation of a capture file of the syscalls during the event.
104104
* `filter` - (Optional) Additional filter to apply to the capture. For example: `proc.name contains nginx`.
105105
* `enabled` - (Optional) Wether to enable captures. Default: `true`.
106106

107-
### Metric alert arguments
107+
### Metric Threshold alert arguments
108108

109109
* `scope` - (Optional) Part of the infrastructure where the alert is valid. Defaults to the entire infrastructure. Can be repeated.
110110
* `group_by` - (Optional) List of segments to trigger a separate alert on. Example: `["kube_cluster_name", "kube_pod_name"]`.
@@ -138,7 +138,7 @@ In addition to all arguments above, the following attributes are exported, which
138138

139139
## Import
140140

141-
Metric alerts can be imported using the alert ID, e.g.
141+
Metric Threshold alerts can be imported using the alert ID, e.g.
142142

143143
```
144144
$ terraform import sysdig_monitor_alert_v2_metric.example 12345

0 commit comments

Comments
 (0)