Skip to content

Commit

Permalink
docs(golden-signal-alerts-new): tiny corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
pranav-new-relic committed Jul 19, 2024
1 parent ab2d71a commit 1347d33
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion examples/modules/golden-signal-alerts-new/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Applications making use of this module need to be reporting data into both APM a
The following input variables are accepted by the module:

* `name`: The APM application name as reported to New Relic
* `threshold_duration`: The duration that the threshold must violate in order to create an incident, in seconds.
* `threshold_duration`: The duration, in seconds, that the condition must violate the threshold before creating a violation.
* `cpu_threshold`: The critical threshold of the CPU utilization condition, as a percentage
* `error_percentage_threshold`: The critical threshold of the error rate condition, as a percentage
* `response_time_threshold`: The critical threshold of the response time condition, in seconds
Expand Down
2 changes: 1 addition & 1 deletion examples/modules/golden-signal-alerts-new/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ variable "service" {
}

variable "notification_channel_ids" {
description = "The notification channel IDs to add to this policy"
description = "The IDs of notification channels to add to this policy"
type = list(string)
}
12 changes: 9 additions & 3 deletions examples/modules/golden-signal-alerts/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# [Golden Signal Alerts](modules/golden-signal-alerts) [Deprecated]:
This module encapsulates an alerting strategy based on the [Four Golden Signals](https://landing.google.com/sre/sre-book/chapters/monitoring-distributed-systems/#xref_monitoring_golden-signals) introduced in Google’s widely read book on [Site Reliability Engineering](https://landing.google.com/sre/sre-book/toc/index.html).
# Module: Golden Signal Alerts [Deprecated]:

**⚠ WARNING**:

This module, [golden-signal-alerts](https://github.com/newrelic/terraform-provider-newrelic/tree/main/examples/modules/golden-signal-alerts), functions using multiple resources in the New Relic Terraform Provider that have been **deprecated** and will be removed in the next major release. These resources include `newrelic_alert_policy_channel`, `newrelic_infra_alert_condition`, and `newrelic_alert_condition`.

-> **WARNING:** The [golden-signal-alerts](modules/golden-signal-alerts) module is deprecated and will be removed in the next major release. The module [golden-signal-alerts-new](modules/golden-signal-alerts-new) would be a preferred alternative to `golden-signal-alerts`.
To set up golden signal alerts using a similar module with newer alternatives to the legacy resources listed above, **please use the newer alternative to the module linked above, which has recently been added: [golden-signal-alerts-new](https://github.com/newrelic/terraform-provider-newrelic/tree/main/examples/modules/golden-signal-alerts-new)**.
______

This module encapsulates an alerting strategy based on the [Four Golden Signals](https://landing.google.com/sre/sre-book/chapters/monitoring-distributed-systems/#xref_monitoring_golden-signals) introduced in Google’s widely read book on [Site Reliability Engineering](https://landing.google.com/sre/sre-book/toc/index.html).

The signals chosen for this module are:

Expand Down

0 comments on commit 1347d33

Please sign in to comment.