56 lines
2.2 KiB
Markdown

# CAAS KUBERNETES CLUSTER DataDog monitors
## How to use this module
```hcl
module "datadog-monitors-caas-kubernetes-cluster" {
source = "claranet/monitors/datadog//caas/kubernetes/cluster"
version = "{revision}"
environment = var.environment
message = module.datadog-message-alerting.alerting-message
}
```
## Purpose
Creates DataDog monitors with the following checks:
- Kubernetes API server does not respond
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:-----:|
| apiserver\_enabled | Flag to enable API server monitor | `string` | `"true"` | no |
| apiserver\_extra\_tags | Extra tags for API server monitor | `list(string)` | `[]` | no |
| apiserver\_message | Custom message for API server monitor | `string` | `""` | no |
| apiserver\_no\_data\_timeframe | Number of minutes before reporting no data | `string` | `10` | no |
| apiserver\_threshold\_warning | API server monitor (warning threshold) | `string` | `3` | no |
| environment | Architecture environment | `any` | n/a | yes |
| evaluation\_delay | Delay in seconds for the metric evaluation | `number` | `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 a monitor is triggered | `any` | n/a | yes |
| new\_host\_delay | Delay in seconds before monitor new resource | `number` | `300` | no |
| notify\_no\_data | Will raise no data alert if set to true | `bool` | `true` | no |
| prefix\_slug | Prefix string to prepend between brackets on every monitors names | `string` | `""` | no |
## Outputs
| Name | Description |
|------|-------------|
| apiserver\_id | id for monitor apiserver |
## Related documentation
* [Datadog metrics](https://docs.datadoghq.com/agent/kubernetes/metrics/)
* [Datadog documentation](https://docs.datadoghq.com/integrations/kubernetes/)
* [Datadog Blog](https://www.datadoghq.com/blog/monitor-kubernetes-docker/)
## Requirements
* Datadog Agent > v6.6