Skip to content

Commit 9244867

Browse files
domalessisteveny91
andauthored
clarify ports for GKE users (DataDog#22296)
* clarify ports for GKE users * Update cilium/README.md * Update cilium/README.md * Update cilium/README.md --------- Co-authored-by: Steven Yuen <steven.yuen@datadoghq.com>
1 parent c401058 commit 9244867

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

cilium/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Starting with version 1.10.0, this OpenMetrics-based integration has a latest mo
2323
`global.prometheus.enabled=true` and `global.operatorPrometheus.enabled=true`
2424
* Cilium >= 1.9.x:
2525
`prometheus.enabled=true` and `operator.prometheus.enabled=true`
26-
26+
2727
Or, separately enable Prometheus metrics in the Kubernetes manifests:
2828
<div class="alert alert-warning">For <a href="https://docs.cilium.io/en/v1.12/operations/upgrade/#id2">Cilium <= v1.11</a>, use <code>--prometheus-serve-addr=:9090</code>.</a></div>
2929

@@ -47,6 +47,8 @@ Or, separately enable Prometheus metrics in the Kubernetes manifests:
4747
- --enable-metrics
4848
```
4949

50+
<div class="alert alert-info"><strong>Note for GKE users:</strong> On Google Kubernetes Engine (GKE), Cilium exposes metrics on port <code>9990</code> by default, and this port cannot be changed. Make sure to configure the Datadog Agent to scrape port <code>9990</code> instead of the common defaults (<code>9090</code> or <code>9962</code>). Using an incorrect port can result in a high volume of connection errors in your Agent logs.</div>
51+
5052
### Configuration
5153

5254
<!-- xxx tabs xxx -->
@@ -60,6 +62,12 @@ To configure this check for an Agent running on a host:
6062
- To collect `cilium-agent` metrics, enable the `agent_endpoint` option.
6163
- To collect `cilium-operator` metrics, enable the `operator_endpoint` option.
6264

65+
**Note**: The default `agent_endpoint` port varies by environment and Cilium configuration:
66+
- Cilium <= v1.11 typically uses port `9090`
67+
- Self-managed Cilium >= v1.12 commonly uses port `9962`
68+
- GKE-managed Cilium uses port `9990` (fixed and not configurable)
69+
70+
6371
```yaml
6472
instances:
6573
@@ -127,6 +135,11 @@ Collecting logs is disabled by default in the Datadog Agent. To enable it, see [
127135
| `<INIT_CONFIG>` | blank or `{}` |
128136
| `<INSTANCE_CONFIG>` | `{"agent_endpoint": "http://%%host%%:9090/metrics", "use_openmetrics": "true"}` |
129137

138+
**Note**: For GKE environments, use port `9990` instead of `9090` in the `agent_endpoint` configuration. For example:
139+
```json
140+
{"agent_endpoint": "http://%%host%%:9990/metrics", "use_openmetrics": "true"}
141+
```
142+
130143
- Log collection
131144

132145
| Parameter | Value |

0 commit comments

Comments
 (0)