Skip to content

Commit

Permalink
fix(docs): Regenerate docs after alert example changes
Browse files Browse the repository at this point in the history
This change fixes a small typo in an alert example, and regenerates the
documentation to capture that, and the previous example updates.

Ref: LOG-20284
  • Loading branch information
jmoses committed Jul 25, 2024
1 parent 7d421b9 commit e71c5d9
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 13 deletions.
13 changes: 9 additions & 4 deletions docs/resources/absence_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,15 @@ resource "mezmo_absence_alert" "no_data_alert" {
name = "metrics absence alert"
event_type = "metric"
window_duration_minutes = 15
subject = "No data received!"
severity = "WARNING"
body = "There has been no metrics data recieved in the last 15 minutes!"
ingestion_key = "abc123"
alert_payload = {
service = {
name = "log_analysis"
subject = "No data received!"
severity = "WARNING"
body = "There has been no metrics data received in the last 15 minutes!"
ingestion_key = "abc123"
}
}
}
```

Expand Down
16 changes: 12 additions & 4 deletions docs/resources/change_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,18 @@ resource "mezmo_change_alert" "order_spike" {
}
window_type = "sliding"
window_duration_minutes = 15
subject = "Spike in ordering!"
severity = "WARNING"
body = "There has been a > 20% increase in orders over the last 15 minutes. Check application scaling."
ingestion_key = "abc123"
alert_payload = {
service = {
name = "webhook"
uri = "https://example.com/my_webhook"
message_text = "There has been a > 20% increase in orders ({{.total_orders}}) over the last 15 minutes. Check application scaling."
}
throttling = {
window_secs = 3600
threshold = 2
}
}
}
```

Expand Down
19 changes: 15 additions & 4 deletions docs/resources/threshold_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,21 @@ resource "mezmo_threshold_alert" "order_count" {
}
window_type = "tumbling"
window_duration_minutes = 60
subject = "Lots of orders coming in the last hour!"
severity = "WARNING"
body = "Check to make sure there are no errors in pricing, and no unexpected special offers were released."
ingestion_key = "abc123"
alert_payload = {
service = {
name = "pager_duty"
uri = "https://example.com/pager_duty_api"
source = "{{.my_source}}"
routing_key = "abc123"
severity = "CRITICAL"
event_action = "trigger"
summary = "Check to make sure there are no errors in pricing, and no unexpected special offers were released."
}
throttling = {
window_secs = 3600
threshold = 1
}
}
}
```

Expand Down
2 changes: 1 addition & 1 deletion examples/resources/mezmo_absence_alert/resource.tf
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ resource "mezmo_absence_alert" "no_data_alert" {
name = "log_analysis"
subject = "No data received!"
severity = "WARNING"
body = "There has been no metrics data recieved in the last 15 minutes!"
body = "There has been no metrics data received in the last 15 minutes!"
ingestion_key = "abc123"
}
}
Expand Down

0 comments on commit e71c5d9

Please sign in to comment.