Skip to content

Commit 24d59c7

Browse files
pavolloffaypavolloffay
authored
Fix OpenShift dashboard metrics for collector 0.123.0 (#3994)
* Fix OpenShift dashboard metrics for collector 0.123.0 Signed-off-by: Pavol Loffay <[email protected]> * Fix OpenShift dashboard metrics for collector 0.123.0 Signed-off-by: Pavol Loffay <[email protected]> * Fix OpenShift dashboard metrics for collector 0.123.0 Signed-off-by: Pavol Loffay <[email protected]> * Fix Signed-off-by: Pavol Loffay <[email protected]> * Remove comment Signed-off-by: Pavol Loffay <[email protected]> --------- Signed-off-by: Pavol Loffay <[email protected]>
1 parent 9fb8427 commit 24d59c7

File tree

3 files changed

+73
-24
lines changed

3 files changed

+73
-24
lines changed

‎.chloggen/ocpdashboards.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
2+
change_type: bug_fix
3+
4+
# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
5+
component: collector
6+
7+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
8+
note: Fix OpenShift internal collector metrics dashboards to use `_total` suffix
9+
10+
# One or more tracking issues related to the change
11+
issues: [3994]
12+
13+
# (Optional) One or more lines of additional information to render under the primary note.
14+
# These lines will be padded with 2 spaces and then inserted directly into the document.
15+
# Use pipe (|) for multiline entries.
16+
subtext: |
17+
The following settings (or missing metrics configuration since 0.119.0) exposes metrics with `_total` suffix:
18+
```yaml
19+
service:
20+
telemetry:
21+
metrics:
22+
readers:
23+
- pull:
24+
exporter:
25+
prometheus:
26+
host: '0.0.0.0'
27+
port: 8888
28+
```
29+
30+
The following settings exposes metrics without `_total` suffix:
31+
```yaml
32+
service:
33+
telemetry:
34+
address: 0.0.0.0:8888
35+
````

‎internal/openshift/dashboards/dashboards.go‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import (
88
_ "embed"
99

1010
corev1 "k8s.io/api/core/v1"
11+
"k8s.io/apimachinery/pkg/api/errors"
1112
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1213
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1314
"k8s.io/client-go/kubernetes"
@@ -29,6 +30,8 @@ type dashboardManagement struct {
2930
clientset kubernetes.Interface
3031
}
3132

33+
var _ manager.Runnable = (*dashboardManagement)(nil)
34+
3235
func NewDashboardManagement(clientset kubernetes.Interface) manager.Runnable {
3336
return dashboardManagement{
3437
clientset: clientset,
@@ -49,9 +52,20 @@ func (d dashboardManagement) Start(ctx context.Context) error {
4952
},
5053
}
5154

52-
_, err := d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Create(ctx, &cm, metav1.CreateOptions{})
55+
_, err := d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Get(ctx, configMapName, metav1.GetOptions{})
5356
if err != nil {
54-
return nil
57+
if errors.IsNotFound(err) {
58+
_, err := d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Create(ctx, &cm, metav1.CreateOptions{})
59+
if err != nil {
60+
return nil
61+
}
62+
}
63+
} else {
64+
// config map already exists, update it
65+
_, err := d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Update(ctx, &cm, metav1.UpdateOptions{})
66+
if err != nil {
67+
return nil
68+
}
5569
}
5670

5771
<-ctx.Done()

‎internal/openshift/dashboards/metrics-dashboard.json‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@
5555
"steppedLine": false,
5656
"targets": [
5757
{
58-
"expr": "rate(otelcol_receiver_accepted_metric_points{receiver=~\"$metric receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
58+
"expr": "rate(otelcol_receiver_accepted_metric_points_total{receiver=~\"$metric receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
5959
"format": "time_series",
6060
"interval": "",
6161
"intervalFactor": 1,
6262
"legendFormat": "{{receiver}}/{{service}}/{{namespace}} accepted/sec",
6363
"refId": "A"
6464
},
6565
{
66-
"expr": "rate(otelcol_receiver_refused_metric_points{receiver=~\"$metric receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
66+
"expr": "rate(otelcol_receiver_refused_metric_points_total{receiver=~\"$metric receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
6767
"interval": "",
6868
"legendFormat": "{{ receiver }}/{{service}}/{{namespace}} refused/ sec",
6969
"refId": "B"
@@ -140,15 +140,15 @@
140140
"steppedLine": false,
141141
"targets": [
142142
{
143-
"expr": "rate(otelcol_exporter_sent_metric_points{exporter=~\"$metric exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
143+
"expr": "rate(otelcol_exporter_sent_metric_points_total{exporter=~\"$metric exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
144144
"format": "time_series",
145145
"interval": "",
146146
"intervalFactor": 1,
147147
"legendFormat": "{{exporter}}/{{service}}/{{namespace}} sent/sec",
148148
"refId": "A"
149149
},
150150
{
151-
"expr": "rate(otelcol_exporter_send_failed_metric_points{exporter=~\"$metric exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
151+
"expr": "rate(otelcol_exporter_send_failed_metric_points_total{exporter=~\"$metric exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
152152
"interval": "",
153153
"legendFormat": "{{ exporter }}/{{service}}/{{namespace}} failed/sec",
154154
"refId": "B"
@@ -225,21 +225,21 @@
225225
"steppedLine": false,
226226
"targets": [
227227
{
228-
"expr": "rate(otelcol_processor_accepted_metric_points{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
228+
"expr": "rate(otelcol_processor_accepted_metric_points_total{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
229229
"format": "time_series",
230230
"interval": "",
231231
"intervalFactor": 1,
232232
"legendFormat": "{{processor}} | accepted",
233233
"refId": "A"
234234
},
235235
{
236-
"expr": "rate(otelcol_processor_dropped_metric_points{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
236+
"expr": "rate(otelcol_processor_dropped_metric_points_total{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
237237
"interval": "",
238238
"legendFormat": "{{processor}}/{{service}}/{{namespace}} | dropped",
239239
"refId": "B"
240240
},
241241
{
242-
"expr": "rate(otelcol_processor_refused_metric_points{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
242+
"expr": "rate(otelcol_processor_refused_metric_points_total{processor=~\"$metric processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
243243
"interval": "",
244244
"legendFormat": "{{processor}}/{{service}}/{{namespace}} | refused",
245245
"refId": "C"
@@ -328,15 +328,15 @@
328328
"steppedLine": false,
329329
"targets": [
330330
{
331-
"expr": "rate(otelcol_receiver_accepted_spans{receiver=~\"$span receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
331+
"expr": "rate(otelcol_receiver_accepted_spans_total{receiver=~\"$span receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
332332
"format": "time_series",
333333
"interval": "",
334334
"intervalFactor": 1,
335335
"legendFormat": "{{receiver}}/{{service}}/{{namespace}} accepted/sec",
336336
"refId": "A"
337337
},
338338
{
339-
"expr": "rate(otelcol_receiver_refused_spans{receiver=~\"$span receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
339+
"expr": "rate(otelcol_receiver_refused_spans_total{receiver=~\"$span receiver\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
340340
"interval": "",
341341
"legendFormat": "{{ receiver }}/{{service}}/{{namespace}} refused/sec",
342342
"refId": "B"
@@ -413,15 +413,15 @@
413413
"steppedLine": false,
414414
"targets": [
415415
{
416-
"expr": "rate(otelcol_exporter_sent_spans{exporter=~\"$span exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
416+
"expr": "rate(otelcol_exporter_sent_spans_total{exporter=~\"$span exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
417417
"format": "time_series",
418418
"interval": "",
419419
"intervalFactor": 1,
420420
"legendFormat": "{{exporter}}/{{service}}/{{namespace}} sent/sec",
421421
"refId": "A"
422422
},
423423
{
424-
"expr": "rate(otelcol_exporter_send_failed_spans{exporter=~\"$span exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
424+
"expr": "rate(otelcol_exporter_send_failed_spans_total{exporter=~\"$span exporter\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
425425
"interval": "",
426426
"legendFormat": "{{ exporter }}/{{service}}/{{namespace}} failed/sec",
427427
"refId": "B"
@@ -498,21 +498,21 @@
498498
"steppedLine": false,
499499
"targets": [
500500
{
501-
"expr": "rate(otelcol_processor_accepted_spans{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
501+
"expr": "rate(otelcol_processor_accepted_spans_total{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
502502
"format": "time_series",
503503
"interval": "",
504504
"intervalFactor": 1,
505505
"legendFormat": "{{processor}}/{{service}}/{{namespace}} | accepted",
506506
"refId": "A"
507507
},
508508
{
509-
"expr": "rate(otelcol_processor_dropped_spans{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
509+
"expr": "rate(otelcol_processor_dropped_spans_total{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
510510
"interval": "",
511511
"legendFormat": "{{processor}}/{{service}}/{{namespace}} | dropped",
512512
"refId": "B"
513513
},
514514
{
515-
"expr": "rate(otelcol_processor_refused_spans{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
515+
"expr": "rate(otelcol_processor_refused_spans_total{processor=~\"$span processor\",namespace=~\"$namespace\",service=~\"$collector instance\"}[1m])",
516516
"interval": "",
517517
"legendFormat": "{{processor}}/{{service}}/{{namespace}} | refused",
518518
"refId": "C"
@@ -603,7 +603,7 @@
603603
{
604604
"editorMode": "code",
605605
"exemplar": true,
606-
"expr": "otelcol_process_memory_rss{service=~\"$collector instance\",namespace=~\"$namespace\"}",
606+
"expr": "otelcol_process_memory_rss_bytes{service=~\"$collector instance\",namespace=~\"$namespace\"}",
607607
"format": "time_series",
608608
"hide": false,
609609
"interval": "$minstep",
@@ -765,7 +765,7 @@
765765
{
766766
"editorMode": "code",
767767
"exemplar": true,
768-
"expr": "rate(otelcol_process_cpu_seconds{service=~\"$collector instance\",namespace=~\"$namespace\"}[1m])*100",
768+
"expr": "rate(otelcol_process_cpu_seconds_total{service=~\"$collector instance\",namespace=~\"$namespace\"}[1m])*100",
769769
"format": "time_series",
770770
"hide": false,
771771
"interval": "$minstep",
@@ -854,7 +854,7 @@
854854
"multi": true,
855855
"name": "span exporter",
856856
"options": [],
857-
"query": "label_values(otelcol_exporter_sent_spans, exporter)",
857+
"query": "label_values(otelcol_exporter_sent_spans_total, exporter)",
858858
"refresh": 2,
859859
"regex": "",
860860
"sort": 2,
@@ -877,7 +877,7 @@
877877
"multi": true,
878878
"name": "metric receiver",
879879
"options": [],
880-
"query": "label_values(otelcol_receiver_accepted_metric_points, receiver)",
880+
"query": "label_values(otelcol_receiver_accepted_metric_points_total, receiver)",
881881
"refresh": 2,
882882
"regex": "",
883883
"sort": 2,
@@ -900,7 +900,7 @@
900900
"multi": true,
901901
"name": "metric exporter",
902902
"options": [],
903-
"query": "label_values(otelcol_exporter_send_failed_metric_points, exporter)",
903+
"query": "label_values(otelcol_exporter_send_failed_metric_points_total, exporter)",
904904
"refresh": 2,
905905
"regex": "",
906906
"sort": 2,
@@ -923,7 +923,7 @@
923923
"multi": true,
924924
"name": "span receiver",
925925
"options": [],
926-
"query": "label_values(otelcol_receiver_accepted_spans, receiver)",
926+
"query": "label_values(otelcol_receiver_accepted_spans_total, receiver)",
927927
"refresh": 2,
928928
"regex": "",
929929
"sort": 2,
@@ -946,7 +946,7 @@
946946
"multi": true,
947947
"name": "span processor",
948948
"options": [],
949-
"query": "label_values(otelcol_processor_accepted_spans, processor)",
949+
"query": "label_values(otelcol_processor_accepted_spans_total, processor)",
950950
"refresh": 2,
951951
"regex": "",
952952
"sort": 2,
@@ -969,7 +969,7 @@
969969
"multi": true,
970970
"name": "metric processor",
971971
"options": [],
972-
"query": "label_values(otelcol_processor_accepted_metric_points, processor)",
972+
"query": "label_values(otelcol_processor_accepted_metric_points_total, processor)",
973973
"refresh": 2,
974974
"regex": "",
975975
"sort": 2,

0 commit comments

Comments
 (0)