moved docs

obeleh · obeleh · commit 22c9a97379a7 · 2022-05-13T09:41:25.000+02:00
diff --git a/README.md b/README.md
@@ -157,7 +157,7 @@ burn_rate(\"${datadog_service_level_objective.latency_slo[0].id}\").over(\"${var
 |-----------------------------------------------------|------------------------------------------|----------|------------------------------------------------------------------------------------------------------|
 | latency_slo_enabled                                 | False                                    | No       | Note that this monitor requires custom metrics to be present. Those can unfortunately not be created with Terraform yet |
 | latency_slo_note                                    | ""                                       | No       |                                                                                                      |
-| latency_slo_docs                                    | Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert. | No       |                                                                                                      |
+| latency_slo_docs                                    | ""                                       | No       |                                                                                                      |
 | latency_slo_filter_override                         | ""                                       | No       |                                                                                                      |
 | latency_slo_warning                                 | None                                     | No       |                                                                                                      |
 | latency_slo_critical                                | 99.9                                     | No       |                                                                                                      |
@@ -169,7 +169,7 @@ burn_rate(\"${datadog_service_level_objective.latency_slo[0].id}\").over(\"${var
 | latency_slo_burn_rate_warning                       | None                                     | No       |                                                                                                      |
 | latency_slo_burn_rate_critical                      | 10                                       | No       |                                                                                                      |
 | latency_slo_burn_rate_note                          | ""                                       | No       |                                                                                                      |
-| latency_slo_burn_rate_docs                          | ""                                       | No       |                                                                                                      |
+| latency_slo_burn_rate_docs                          | Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert. | No       |                                                                                                      |
 | latency_slo_burn_rate_evaluation_period             | 30d                                      | No       |                                                                                                      |
 | latency_slo_burn_rate_short_window                  | 5m                                       | No       |                                                                                                      |
 | latency_slo_burn_rate_long_window                   | 1h                                       | No       |                                                                                                      |
@@ -213,7 +213,7 @@ burn_rate(\"${datadog_service_level_objective.error_slo[0].id}\").over(\"${var.e
 |---------------------------------------------------|------------------------------------------|----------|------------------------------------------------------------------------------------------------------|
 | error_slo_enabled                                 | True                                     | No       |                                                                                                      |
 | error_slo_note                                    | ""                                       | No       |                                                                                                      |
-| error_slo_docs                                    | Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert. | No       |                                                                                                      |
+| error_slo_docs                                    | ""                                       | No       |                                                                                                      |
 | error_slo_filter_override                         | ""                                       | No       |                                                                                                      |
 | error_slo_warning                                 | None                                     | No       |                                                                                                      |
 | error_slo_critical                                | 99.9                                     | No       |                                                                                                      |
@@ -229,7 +229,7 @@ burn_rate(\"${datadog_service_level_objective.error_slo[0].id}\").over(\"${var.e
 | error_slo_burn_rate_warning                       | None                                     | No       |                                                                                                      |
 | error_slo_burn_rate_critical                      | 10                                       | No       |                                                                                                      |
 | error_slo_burn_rate_note                          | ""                                       | No       |                                                                                                      |
-| error_slo_burn_rate_docs                          | ""                                       | No       |                                                                                                      |
+| error_slo_burn_rate_docs                          | Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert. | No       |                                                                                                      |
 | error_slo_burn_rate_evaluation_period             | 30d                                      | No       |                                                                                                      |
 | error_slo_burn_rate_short_window                  | 5m                                       | No       |                                                                                                      |
 | error_slo_burn_rate_long_window                   | 1h                                       | No       |                                                                                                      |
diff --git a/errors-slo-variables.tf b/errors-slo-variables.tf
@@ -10,7 +10,7 @@ variable "error_slo_note" {
 
 variable "error_slo_docs" {
   type    = string
-  default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
+  default = ""
 }
 
 variable "error_slo_filter_override" {
@@ -97,7 +97,7 @@ variable "error_slo_burn_rate_note" {
 
 variable "error_slo_burn_rate_docs" {
   type    = string
-  default = ""
+  default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
 }
 
 variable "error_slo_burn_rate_evaluation_period" {
diff --git a/latency-slo-variables.tf b/latency-slo-variables.tf
@@ -11,7 +11,7 @@ variable "latency_slo_note" {
 
 variable "latency_slo_docs" {
   type    = string
-  default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
+  default = ""
 }
 
 variable "latency_slo_filter_override" {
@@ -79,7 +79,7 @@ variable "latency_slo_burn_rate_note" {
 
 variable "latency_slo_burn_rate_docs" {
   type    = string
-  default = ""
+  default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
 }
 
 variable "latency_slo_burn_rate_evaluation_period" {

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ variable "error_slo_note" {`
`10`	`10`
`11`	`11`	`variable "error_slo_docs" {`
`12`	`12`	`type = string`
`13`		- default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
	`13`	`+ default = ""`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`variable "error_slo_filter_override" {`
`@@ -97,7 +97,7 @@ variable "error_slo_burn_rate_note" {`
`97`	`97`
`98`	`98`	`variable "error_slo_burn_rate_docs" {`
`99`	`99`	`type = string`
`100`		`- default = ""`
	`100`	+ default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`variable "error_slo_burn_rate_evaluation_period" {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ variable "latency_slo_note" {`
`11`	`11`
`12`	`12`	`variable "latency_slo_docs" {`
`13`	`13`	`type = string`
`14`		- default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
	`14`	`+ default = ""`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`variable "latency_slo_filter_override" {`
`@@ -79,7 +79,7 @@ variable "latency_slo_burn_rate_note" {`
`79`	`79`
`80`	`80`	`variable "latency_slo_burn_rate_docs" {`
`81`	`81`	`type = string`
`82`		`- default = ""`
	`82`	+ default = "Use burn rates alerts to measure how fast your error budget is being depleted relative to the time window of your SLO. For example, for a 30 day SLO if a burn rate of 1 is sustained, that means the error budget will be fully depleted in exactly 30 days, a burn rate of 2 means in exactly 15 days, etc. Therefore, you could use a burn rate alert to notify you if a burn rate of 10 is measured in the past hour. Burn rate alerts evaluate two time windows: a long window which you specify and a short window that is automatically calculated as 1/12 of your long window. The long window's purpose is to reduce alert flappiness, while the short window's purpose is to improve recovery time. If your threshold is violated in both windows, you will receive an alert."
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`variable "latency_slo_burn_rate_evaluation_period" {`