You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/README.md
+26-3Lines changed: 26 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,15 +76,15 @@ components:
76
76
- "stage:dev"
77
77
```
78
78
79
-
# Cluster Checks
79
+
## Cluster Checks
80
80
81
81
Cluster Checks are configurations that allow us to setup external URLs to be monitored. They can be configured through the datadog agent or annotations on kubernetes services.
82
82
83
83
Cluster Checks are similar to synthetics checks, they are not as indepth, but significantly cheaper. Use Cluster Checks when you need a simple health check beyond the kubernetes pod health check.
84
84
85
85
Public addresses that test endpoints must use the agent configuration, whereas service addresses internal to the cluster can be tested by annotations.
86
86
87
-
## Adding Cluster Checks
87
+
### Adding Cluster Checks
88
88
89
89
Cluster Checks can be enabled or disabled via the `cluster_checks_enabled` variable. We recommend this be set to true.
90
90
@@ -94,7 +94,30 @@ Once they are added, and properly configured, the new checks show up in the netw
94
94
95
95
**Please note:** the yaml file name doesn't matter, but the root key inside which is `something.yaml` does matter. this is following [datadogs docs](https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/?tab=helm#configuration-from-static-configuration-files) for `<integration name>.yaml`.
96
96
97
-
## Monitoring Cluster Checks
97
+
#### Sample Yaml
98
+
99
+
:::caution
100
+
The key of a filename must match datadog docs, which is `<INTEGRATION_NAME>.yaml`
Cluster Checks **can** be used for external URL testing (loadbalancer endpoints), whereas annotations **must** be used for kubernetes services.
105
+
106
+
```
107
+
http_check.yaml:
108
+
cluster_check: true
109
+
init_config:
110
+
instances:
111
+
- name: "[${stage}] Echo Server"
112
+
url: "https://echo.${stage}.uw2.acme.com"
113
+
- name: "[${stage}] Portal"
114
+
url: "https://portal.${stage}.uw2.acme.com"
115
+
- name: "[${stage}] ArgoCD"
116
+
url: "https://argocd.${stage}.uw2.acme.com"
117
+
118
+
```
119
+
120
+
### Monitoring Cluster Checks
98
121
99
122
Using Cloudposse's `datadog-monitor` component. The following yaml snippet will monitor all HTTP Cluster Checks, this can be added to each stage (usually via a defaults folder).
0 commit comments