File: prometheus.go

package info (click to toggle)
golang-github-intel-goresctrl 0.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,064 kB
  • sloc: makefile: 19; sh: 15
file content (124 lines) | stat: -rw-r--r-- 3,191 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
Copyright 2020 Intel Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package rdt

import (
	"fmt"
	"sync"

	"github.com/prometheus/client_golang/prometheus"
)

var customLabels []string = []string{}

// collector implements prometheus.Collector interface
type collector struct {
	descriptors map[string]*prometheus.Desc
}

// NewCollector creates new Prometheus collector of RDT metrics
func NewCollector() (prometheus.Collector, error) {
	c := &collector{descriptors: make(map[string]*prometheus.Desc)}
	return c, nil
}

// RegisterCustomPrometheusLabels registers monitor group annotations to be
// exported as Prometheus metrics labels
func RegisterCustomPrometheusLabels(names ...string) {
Names:
	for _, n := range names {
		for _, c := range customLabels {
			if n == c {
				break Names
			}
		}
		customLabels = append(customLabels, n)
	}
}

// Describe method of the prometheus.Collector interface
func (c *collector) Describe(ch chan<- *prometheus.Desc) {
	for resource, features := range GetMonFeatures() {
		switch resource {
		case MonResourceL3:
			for _, f := range features {
				ch <- c.describeL3(f)
			}
		}
	}
}

// Collect method of the prometheus.Collector interface
func (c collector) Collect(ch chan<- prometheus.Metric) {
	var wg sync.WaitGroup

	for _, cls := range GetClasses() {
		for _, monGrp := range cls.GetMonGroups() {
			wg.Add(1)
			g := monGrp
			go func() {
				defer wg.Done()
				c.collectGroupMetrics(ch, g)
			}()
		}
	}
	wg.Wait()
}

func (c *collector) describeL3(feature string) *prometheus.Desc {
	d, ok := c.descriptors[feature]
	if !ok {
		name := "l3_" + feature
		help := "L3 " + feature

		switch feature {
		case "llc_occupancy":
			help = "L3 (LLC) occupancy"
		case "mbm_local_bytes":
			help = "bytes transferred to/from local memory through LLC"
		case "mbm_total_bytes":
			help = "total bytes transferred to/from memory through LLC"
		}
		labels := append([]string{"rdt_class", "rdt_mon_group", "cache_id"}, customLabels...)
		d = prometheus.NewDesc(name, help, labels, nil)
		c.descriptors[feature] = d
	}
	return d
}

func (c *collector) collectGroupMetrics(ch chan<- prometheus.Metric, mg MonGroup) {
	allData := mg.GetMonData()

	annotations := mg.GetAnnotations()
	customLabelValues := make([]string, len(customLabels))
	for i, name := range customLabels {
		customLabelValues[i] = annotations[name]
	}

	for cacheID, data := range allData.L3 {
		for feature, value := range data {
			labels := append([]string{mg.Parent().Name(), mg.Name(), fmt.Sprint(cacheID)}, customLabelValues...)

			ch <- prometheus.MustNewConstMetric(
				c.describeL3(feature),
				prometheus.CounterValue,
				float64(value),
				labels...,
			)
		}
	}
}