From cdb3a284dc2fd0f017ec1d6c3a7778b523586e3a Mon Sep 17 00:00:00 2001 From: Rafael Romero Carmona Date: Tue, 20 Aug 2019 12:17:54 +0100 Subject: [PATCH] MON-498 Readme ready --- middleware/kong/README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/middleware/kong/README.md b/middleware/kong/README.md index b83bcf7..ecc7e99 100644 --- a/middleware/kong/README.md +++ b/middleware/kong/README.md @@ -19,8 +19,40 @@ Creates DataDog monitors with the following checks: - Kong does not respond - Kong exceeded its treatment limit +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| environment | Architecture Environment | string | n/a | yes | +| evaluation\_delay | Delay in seconds for the metric evaluation | string | `"15"` | 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 | +| not\_responding\_enabled | Flag to enable Kong does not respond monitor | string | `"true"` | no | +| not\_responding\_extra\_tags | Extra tags for Kong does not respond monitor | list(string) | `[]` | no | +| not\_responding\_last | Parameter 'last' for the service check | string | `"6"` | no | +| not\_responding\_message | Custom message for Kong does not respond monitor | string | `""` | no | +| not\_responding\_no\_data\_timeframe | Kong does not respond monitor no data timeframe | string | `"10"` | no | +| not\_responding\_threshold\_critical | Parameter 'last' for the service check | string | `"5"` | no | +| prefix\_slug | Prefix string to prepend between brackets on every monitors names | string | `""` | no | +| treatment\_limit\_enabled | Flag to enable Kong Treatment Limit monitor | string | `"true"` | no | +| treatment\_limit\_extra\_tags | Extra tags for Kong Treatment Limit monitor | list(string) | `[]` | no | +| treatment\_limit\_message | Custom message for the Kong Treatment Limit monitor | string | `""` | no | +| treatment\_limit\_threshold\_critical | Docker Container Memory Usage critical threshold | string | `"20"` | no | +| treatment\_limit\_threshold\_warning | Docker Container Memory Usage warning threshold | string | `"0"` | no | +| treatment\_limit\_time\_aggregator | Time aggregator for the Kong Treatment Limit monitor | string | `"min"` | no | +| treatment\_limit\_timeframe | Timeframe for the Kong Treatment Limit monitor | string | `"last_15m"` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| not\_responding\_id | id for monitor not_responding | +| treatment\_limit\_id | id for monitor treatment_limit | ## Related documentation -Datadog Documentation https://docs.datadoghq.com/integrations/kong/ +* [Datadog Kong integration](https://docs.datadoghq.com/integrations/kong/)