From e60fe29ea0390777467956a86601c290270564ce Mon Sep 17 00:00:00 2001 From: Rafael Romero Carmona Date: Tue, 20 Aug 2019 12:13:02 +0100 Subject: [PATCH] MON-39 Readme ready --- saas/new-relic/README.md | 50 ++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/saas/new-relic/README.md b/saas/new-relic/README.md index 9df0e65..23a76b1 100644 --- a/saas/new-relic/README.md +++ b/saas/new-relic/README.md @@ -20,10 +20,50 @@ Creates DataDog monitors with the following checks: - New Relic application has no-data - New Relic Error rate -Usage: - terraform-docs [--no-required] [json | md | markdown] ... - terraform-docs -h | --help - +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| app\_apdex\_score\_enabled | Flag to enable APP Apdex Score monitor | string | `"true"` | no | +| app\_apdex\_score\_extra\_tags | Extra tags for New Relic APP Apdex Score monitor | list(string) | `[]` | no | +| app\_apdex\_score\_message | Custom message for the APP Apdex Score monitor | string | `""` | no | +| app\_apdex\_score\_threshold\_critical | APP Apdex Score critical threshold | string | `"0.25"` | no | +| app\_apdex\_score\_threshold\_warning | APP Apdex Score warning threshold | string | `"0.5"` | no | +| app\_apdex\_score\_time\_aggregator | Time aggregator for the APP Apdex Score monitor | string | `"avg"` | no | +| app\_apdex\_score\_timeframe | Timeframe for the APP Apdex Score monitor | string | `"last_15m"` | no | +| app\_error\_rate\_enabled | Flag to enable APP Error Rate monitor | string | `"true"` | no | +| app\_error\_rate\_extra\_tags | Extra tags for New Relic APP Error Rate monitor | list(string) | `[]` | no | +| app\_error\_rate\_message | Custom message for the APP Error Rate monitor | string | `""` | no | +| app\_error\_rate\_threshold\_critical | APP Error Rate critical threshold | string | `"5"` | no | +| app\_error\_rate\_threshold\_warning | APP Error Rate warning threshold | string | `"1"` | no | +| app\_error\_rate\_time\_aggregator | Time aggregator for the APP Error Rate monitor | string | `"min"` | no | +| app\_error\_rate\_timeframe | Timeframe for the APP Error Rate monitor | string | `"last_5m"` | no | +| data\_sent\_enabled | Flag to enable New Relic Data Sent monitor | string | `"true"` | no | +| data\_sent\_extra\_tags | Extra tags for New Relic Data Sent monitor | list(string) | `[]` | no | +| data\_sent\_message | Custom message for the New Relic Data Sent monitor | string | `""` | no | +| data\_sent\_no\_data\_timeframe | No data timeframe for the New Relic Data Sent monitor | string | `"30"` | no | +| data\_sent\_threshold\_critical | Critical threshold for the New Relic Data Sent monitor | string | `"0"` | no | +| data\_sent\_time\_aggregator | Time aggregator for the New Relic Data Sent monitor | string | `"avg"` | no | +| data\_sent\_timeframe | Timeframe for the New Relic Data Sent monitor | string | `"last_15m"` | no | +| environment | Architecture Environment | string | n/a | yes | +| evaluation\_delay | Delay in seconds for the metric evaluation | string | `"900"` | no | +| filter\_tags\_custom | Tags used for custom filtering when filter_tags_use_defaults is false | string | `"*"` | no | +| filter\_tags\_custom\_excluded | Tags excluded for custom filtering when filter_tags_use_defaults is false | string | `""` | no | +| filter\_tags\_use\_defaults | Use default filter tags convention | string | `"true"` | no | +| message | Message sent when an alert is triggered | string | n/a | yes | +| new\_host\_delay | Delay in seconds before monitor new resource | string | `"300"` | no | +| prefix\_slug | Prefix string to prepend between brackets on every monitors names | string | `""` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| app\_apdex\_score\_id | id for monitor app_apdex_score | +| app\_error\_rate\_id | id for monitor app_error_rate | +| data\_sent\_id | id for monitor data_sent | + ## Related documentation -Datadog Documentation https://docs.datadoghq.com/integrations/new_relic/ \ No newline at end of file +* [Datadog New Relic integration](https://docs.datadoghq.com/integrations/new_relic/) + +