consul
consul copied to clipboard
hashicorp
Consul Kubernetes Datadog Integration Docs Update
Description
Adding in an Observability piece to supplement https://github.com/hashicorp/consul-k8s/pull/3407 which added helm configuration options for configuring Datadog metrics integration with consul-k8s.
Testing & Reproduction steps
Worked with the information here to update Consul documentation website with details outlining the changes made in the PR.
Links
- Consul Integration (Datadog Checks)
- Consul Integration Source Code
- DogstatsD over UDP
- DogstatsD over Unix Domain Socket
PR Checklist
- [X] external facing docs updated
- [X] appropriate backport labels added
- [X] not a security concern
@natemollica-nm Thank you for doing this and I think a huge boost to what we can do with DataDog. I have a high level question around placement of this doc. It's currently place under Service Mesh -> Observabililty. Are these metrics more for gathering Consul server metrics via DataDog or are these for collecting metrics for all service mesh components?
@david-yu -- Good point to bring up on the placement. This is more Consul specific metrics collection from the servers and nothing regarding Envoy metrics. That's a separate set of annotations that should be placed on Kube pods that have dataplane containers with them. Any recommendations on better placement or where you'd like to see it?
I think moving it under Deployment Configs makes the most sense for me perhaps: https://developer.hashicorp.com/consul/docs/k8s/deployment-configurations/datadog-metrics
I would put it under Vault Secrets Backend in the nav bar.
@david-yu @boruszak -- Sorry for this last commit and push 😬. I added some additional amplifying information in regard to the Consul Datadog Checks and OpenMetrics sections (Notes) in regard to how Consul RPC TLS certificates are handles by the automated integration. Let me know if these changes are OK with you guys and I'll go ahead and merge.