Skip to content

Commit 2764e17

Browse files
mruegmrueg
committed
feat(endpoints): Move ports into address metric
This marks kube_endpoint_ports as deprecated Fixes #2408
1 parent e295191 commit 2764e17

File tree

3 files changed

+47
-30
lines changed

3 files changed

+47
-30
lines changed

‎docs/metrics/service/endpoint-metrics.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
| kube_endpoint_info | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; | STABLE |
99
| kube_endpoint_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](../../developer/cli-arguments.md) | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; <br> `label_ENDPOINT_LABEL`=&lt;ENDPOINT_LABEL&gt; | STABLE |
1010
| kube_endpoint_created | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; | STABLE |
11-
| kube_endpoint_ports | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; <br> `port_name`=&lt;endpoint-port-name&gt; <br> `port_protocol`=&lt;endpoint-port-protocol&gt; <br> `port_number`=&lt;endpoint-port-number&gt; | STABLE |
12-
| kube_endpoint_address | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; <br> `ip`=&lt;endpoint-ip&gt; <br> `ready`=&lt;true if available, false if unavailalbe&gt; | STABLE |
11+
| kube_endpoint_ports | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; <br> `port_name`=&lt;endpoint-port-name&gt; <br> `port_protocol`=&lt;endpoint-port-protocol&gt; <br> `port_number`=&lt;endpoint-port-number&gt; | STABLE (Deprecated from 2.14.0) |
12+
| kube_endpoint_address | Gauge | | `endpoint`=&lt;endpoint-name&gt; <br> `namespace`=&lt;endpoint-namespace&gt; <br> `ip`=&lt;endpoint-ip&gt; <br> `port_name`=&lt;endpoint-port-name&gt; <br> `port_protocol`=&lt;endpoint-port-protocol&gt; <br> `port_number`=&lt;endpoint-port-number&gt;`ready`=&lt;true if available, false if unavailalbe&gt; | STABLE |

‎internal/store/endpoint.go‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -173,19 +173,24 @@ func endpointMetricFamilies(allowAnnotationsList, allowLabelsList []string) []ge
173173
wrapEndpointFunc(func(e *v1.Endpoints) *metric.Family {
174174
ms := []*metric.Metric{}
175175
for _, s := range e.Subsets {
176-
for _, available := range s.Addresses {
177-
ms = append(ms, &metric.Metric{
178-
LabelValues: []string{available.IP, "true"},
179-
LabelKeys: []string{"ip", "ready"},
180-
Value: 1,
181-
})
182-
}
183-
for _, notReadyAddresses := range s.NotReadyAddresses {
184-
ms = append(ms, &metric.Metric{
185-
LabelValues: []string{notReadyAddresses.IP, "false"},
186-
LabelKeys: []string{"ip", "ready"},
187-
Value: 1,
188-
})
176+
for _, port := range s.Ports {
177+
labelValues := []string{port.Name, string(port.Protocol), strconv.FormatInt(int64(port.Port), 10)}
178+
labelKeys := []string{"port_name", "port_protocol", "port_number"}
179+
180+
for _, available := range s.Addresses {
181+
ms = append(ms, &metric.Metric{
182+
LabelValues: append(labelValues, available.IP, "true"),
183+
LabelKeys: append(labelKeys, "ip", "ready"),
184+
Value: 1,
185+
})
186+
}
187+
for _, notReadyAddresses := range s.NotReadyAddresses {
188+
ms = append(ms, &metric.Metric{
189+
LabelValues: append(labelValues, notReadyAddresses.IP, "false"),
190+
LabelKeys: append(labelKeys, "ip", "ready"),
191+
Value: 1,
192+
})
193+
}
189194
}
190195
}
191196
return &metric.Family{
@@ -198,7 +203,7 @@ func endpointMetricFamilies(allowAnnotationsList, allowLabelsList []string) []ge
198203
"Information about the Endpoint ports.",
199204
metric.Gauge,
200205
basemetrics.STABLE,
201-
"",
206+
"v2.14.0",
202207
wrapEndpointFunc(func(e *v1.Endpoints) *metric.Family {
203208
ms := []*metric.Metric{}
204209
for _, s := range e.Subsets {

‎internal/store/endpoint_test.go‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ func TestEndpointStore(t *testing.T) {
4242
# TYPE kube_endpoint_info gauge
4343
# HELP kube_endpoint_labels [STABLE] Kubernetes labels converted to Prometheus labels.
4444
# TYPE kube_endpoint_labels gauge
45-
# HELP kube_endpoint_ports [STABLE] Information about the Endpoint ports.
45+
# HELP kube_endpoint_ports [STABLE] (Deprecated since v2.14.0) Information about the Endpoint ports.
4646
# TYPE kube_endpoint_ports gauge
4747
# HELP kube_endpoint_address [STABLE] Information about Endpoint available and non available addresses.
4848
# TYPE kube_endpoint_address gauge
@@ -93,18 +93,24 @@ func TestEndpointStore(t *testing.T) {
9393
kube_endpoint_address_not_ready{endpoint="test-endpoint",namespace="default"} 6
9494
kube_endpoint_created{endpoint="test-endpoint",namespace="default"} 1.5e+09
9595
kube_endpoint_info{endpoint="test-endpoint",namespace="default"} 1
96+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.1",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="true"} 1
97+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.1",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="true"} 1
98+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.10",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="false"} 1
99+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.10",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="false"} 1
100+
kube_endpoint_address{endpoint="test-endpoint",ip="127.0.0.1",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="true"} 1
101+
kube_endpoint_address{endpoint="test-endpoint",ip="127.0.0.1",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="true"} 1
102+
kube_endpoint_address{endpoint="test-endpoint",ip="172.22.23.202",namespace="default",port_name="https",port_number="8443",port_protocol="TCP",ready="true"} 1
103+
kube_endpoint_address{endpoint="test-endpoint",ip="172.22.23.202",namespace="default",port_name="prometheus",port_number="9090",port_protocol="TCP",ready="true"} 1
104+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.1.3",namespace="default",port_name="syslog",port_number="1234",port_protocol="UDP",ready="false"} 1
105+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.1.3",namespace="default",port_name="syslog-tcp",port_number="5678",port_protocol="TCP",ready="false"} 1
106+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.2.2",namespace="default",port_name="syslog",port_number="1234",port_protocol="UDP",ready="false"} 1
107+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.2.2",namespace="default",port_name="syslog-tcp",port_number="5678",port_protocol="TCP",ready="false"} 1
96108
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="http",port_protocol="TCP",port_number="8080"} 1
97109
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="app",port_protocol="TCP",port_number="8081"} 1
98110
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="https",port_protocol="TCP",port_number="8443"} 1
99111
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="prometheus",port_protocol="TCP",port_number="9090"} 1
100112
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="syslog",port_protocol="UDP",port_number="1234"} 1
101113
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="syslog-tcp",port_protocol="TCP",port_number="5678"} 1
102-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="127.0.0.1",ready="true"} 1
103-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="10.0.0.1",ready="true"} 1
104-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="172.22.23.202",ready="true"} 1
105-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="192.168.1.3",ready="false"} 1
106-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="192.168.2.2",ready="false"} 1
107-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="10.0.0.10",ready="false"} 1
108114
`,
109115
},
110116
{
@@ -168,7 +174,7 @@ func TestEndpointStoreWithLabels(t *testing.T) {
168174
# TYPE kube_endpoint_info gauge
169175
# HELP kube_endpoint_labels [STABLE] Kubernetes labels converted to Prometheus labels.
170176
# TYPE kube_endpoint_labels gauge
171-
# HELP kube_endpoint_ports [STABLE] Information about the Endpoint ports.
177+
# HELP kube_endpoint_ports [STABLE] (Deprecated since v2.14.0) Information about the Endpoint ports.
172178
# TYPE kube_endpoint_ports gauge
173179
# HELP kube_endpoint_address [STABLE] Information about Endpoint available and non available addresses.
174180
# TYPE kube_endpoint_address gauge
@@ -230,12 +236,18 @@ func TestEndpointStoreWithLabels(t *testing.T) {
230236
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="prometheus",port_protocol="TCP",port_number="9090"} 1
231237
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="syslog",port_protocol="UDP",port_number="1234"} 1
232238
kube_endpoint_ports{endpoint="test-endpoint",namespace="default",port_name="syslog-tcp",port_protocol="TCP",port_number="5678"} 1
233-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="127.0.0.1",ready="true"} 1
234-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="10.0.0.1",ready="true"} 1
235-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="172.22.23.202",ready="true"} 1
236-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="192.168.1.3",ready="false"} 1
237-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="192.168.2.2",ready="false"} 1
238-
kube_endpoint_address{endpoint="test-endpoint",namespace="default",ip="10.0.0.10",ready="false"} 1
239+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.1",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="true"} 1
240+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.1",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="true"} 1
241+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.10",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="false"} 1
242+
kube_endpoint_address{endpoint="test-endpoint",ip="10.0.0.10",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="false"} 1
243+
kube_endpoint_address{endpoint="test-endpoint",ip="127.0.0.1",namespace="default",port_name="app",port_number="8081",port_protocol="TCP",ready="true"} 1
244+
kube_endpoint_address{endpoint="test-endpoint",ip="127.0.0.1",namespace="default",port_name="http",port_number="8080",port_protocol="TCP",ready="true"} 1
245+
kube_endpoint_address{endpoint="test-endpoint",ip="172.22.23.202",namespace="default",port_name="https",port_number="8443",port_protocol="TCP",ready="true"} 1
246+
kube_endpoint_address{endpoint="test-endpoint",ip="172.22.23.202",namespace="default",port_name="prometheus",port_number="9090",port_protocol="TCP",ready="true"} 1
247+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.1.3",namespace="default",port_name="syslog",port_number="1234",port_protocol="UDP",ready="false"} 1
248+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.1.3",namespace="default",port_name="syslog-tcp",port_number="5678",port_protocol="TCP",ready="false"} 1
249+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.2.2",namespace="default",port_name="syslog",port_number="1234",port_protocol="UDP",ready="false"} 1
250+
kube_endpoint_address{endpoint="test-endpoint",ip="192.168.2.2",namespace="default",port_name="syslog-tcp",port_number="5678",port_protocol="TCP",ready="false"} 1
239251
`,
240252
},
241253
{

0 commit comments

Comments
 (0)