Skip to content

Commit b5d8b7c

Browse files
authored
Update several component Readmes (cloudposse/terraform-aws-components#611)
1 parent 579eb89 commit b5d8b7c

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

src/README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ components:
7676
- "stage:dev"
7777
```
7878
79-
# Cluster Checks
79+
## Cluster Checks
8080
8181
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.
8282
8383
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.
8484
8585
Public addresses that test endpoints must use the agent configuration, whereas service addresses internal to the cluster can be tested by annotations.
8686
87-
## Adding Cluster Checks
87+
### Adding Cluster Checks
8888
8989
Cluster Checks can be enabled or disabled via the `cluster_checks_enabled` variable. We recommend this be set to true.
9090

@@ -94,7 +94,30 @@ Once they are added, and properly configured, the new checks show up in the netw
9494

9595
**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`.
9696

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`
101+
[Datadog Cluster Checks](https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/?tab=helm#configuration-from-static-configuration-files)
102+
103+
:::
104+
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
98121
99122
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).
100123

0 commit comments

Comments
 (0)