Skip to content

Commit 5dc88be

Browse files
committed
updated docs
1 parent 6accf3e commit 5dc88be

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,16 @@
55

66
# Terraform module for Datadog Apm
77

8-
This module adds error and latency monitoring for APM data.
9-
It also includes SLO's for errors and latency but this requires some manual actions first.
10-
Datadog has a feature to generated metrics based on APM data.
11-
Unfortunately this is not a feature you can configure with Terraform.
12-
You'll have to create these metrics by hand unfortunately :(
8+
This module provides SLO's and other alerts based on APM data.
9+
Note that it's this module's opinion that you should prefer to alert on SLO burn rates in stead of latency thresholds.
10+
11+
There is also some backwards compatibility if you want to use generated metrics for your SLO's
12+
13+
## OLD SOLUTION FOR SLO's
14+
15+
Before datadog supported latency SLO's we used generated metrics to base our SLO's on.
16+
Creating the generated metrics is not something you can do with Terraform.
17+
You'll have to create these metrics by hand if you need/want this.
1318

1419
In Datadog go to APM -> Setup and Configuration -> Generate Metrics -> New Metric
1520

module_description.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
This module adds error and latency monitoring for APM data.
2-
It also includes SLO's for errors and latency but this requires some manual actions first.
3-
Datadog has a feature to generated metrics based on APM data.
4-
Unfortunately this is not a feature you can configure with Terraform.
5-
You'll have to create these metrics by hand unfortunately :(
1+
This module provides SLO's and other alerts based on APM data.
2+
Note that it's this module's opinion that you should prefer to alert on SLO burn rates in stead of latency thresholds.
3+
4+
There is also some backwards compatibility if you want to use generated metrics for your SLO's
5+
6+
## OLD SOLUTION FOR SLO's
7+
8+
Before datadog supported latency SLO's we used generated metrics to base our SLO's on.
9+
Creating the generated metrics is not something you can do with Terraform.
10+
You'll have to create these metrics by hand if you need/want this.
611

712
In Datadog go to APM -> Setup and Configuration -> Generate Metrics -> New Metric
813

0 commit comments

Comments
 (0)