internal/satellite/telemetry/prometheus/gauge.go

// Licensed to Apache Software Foundation (ASF) under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Apache Software Foundation (ASF) licenses this file to you 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 prometheus

import (
	"github.com/apache/skywalking-satellite/internal/satellite/telemetry"

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

type Gauge struct {
	Collector
	name  string
	gauge prometheus.GaugeFunc
}

type DynamicGauge struct {
	Collector
	name  string
	gauge *prometheus.GaugeVec
}

func (s *Server) NewGauge(name, help string, getter func() float64, labels ...string) telemetry.Gauge {
	s.lock.Lock()
	defer s.lock.Unlock()
	rebuildName := rebuildGaugeName(name, labels...)
	constLabels := make(map[string]string)
	for inx := 0; inx < len(labels); inx += 2 {
		constLabels[labels[inx]] = labels[inx+1]
	}
	collector, ok := s.collectorContainer[rebuildName]
	if !ok {
		gauge := &Gauge{
			name: name,
			gauge: prometheus.NewGaugeFunc(prometheus.GaugeOpts{
				Name:        name,
				Help:        help,
				ConstLabels: constLabels,
			}, getter),
		}
		s.Register(s.WithMeta(rebuildName, gauge.gauge))
		s.collectorContainer[rebuildName] = gauge
		collector = gauge
	}
	return collector
}

func (s *Server) NewDynamicGauge(name, help string, labels ...string) telemetry.DynamicGauge {
	s.lock.Lock()
	defer s.lock.Unlock()
	rebuildName := rebuildGaugeName(name, labels...)
	collector, ok := s.collectorContainer[rebuildName]
	if !ok {
		gauge := &DynamicGauge{
			name: name,
			gauge: prometheus.NewGaugeVec(prometheus.GaugeOpts{
				Name: name,
				Help: help,
			}, labels),
		}
		s.Register(s.WithMeta(rebuildName, gauge.gauge))
		s.collectorContainer[rebuildName] = gauge
		collector = gauge
	}
	return collector.(telemetry.DynamicGauge)
}

func (i *DynamicGauge) Inc(labels ...string) {
	i.gauge.WithLabelValues(labels...).Inc()
}

func (i *DynamicGauge) Dec(labels ...string) {
	i.gauge.WithLabelValues(labels...).Dec()
}

func rebuildGaugeName(name string, labels ...string) string {
	resultName := name
	for inx := 0; inx < len(labels); inx++ {
		resultName += "_" + labels[inx]
	}

	return resultName
}