1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-15 17:51:03 +00:00
kube-arangodb/pkg/metrics/metrics.go
2022-01-10 12:35:49 +01:00

119 lines
3.4 KiB
Go

//
// DISCLAIMER
//
// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
//
// 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.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//
package metrics
import (
"time"
"github.com/prometheus/client_golang/prometheus"
)
const (
namespace = "arangodb_operator"
// DeploymentName is a label key used for the name of a deployment
DeploymentName = "deployment"
// ActionName is a label key used for the name of an action
ActionName = "action"
// ActionPriority is a label key used for the priority of an action
ActionPriority = "priority"
// Result is a label key used for the result of an action (Success|Failed)
Result = "result"
// Success is a label value used for successful actions
Success = "success"
// Failed is a label value used for failed actions
Failed = "failed"
)
// MustRegisterCounter creates and registers a counter.
// Must be called from `init`.
func MustRegisterCounter(component, name, help string) prometheus.Counter {
m := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: component,
Name: name,
Help: help,
})
prometheus.MustRegister(m)
return m
}
// MustRegisterCounterVec creates and registers a counter vector.
// Must be called from `init`.
func MustRegisterCounterVec(component, name, help string, labelNames ...string) *prometheus.CounterVec {
m := prometheus.NewCounterVec(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: component,
Name: name,
Help: help,
}, labelNames)
prometheus.MustRegister(m)
return m
}
// MustRegisterGauge creates and registers a gauge.
// Must be called from `init`.
func MustRegisterGauge(component, name, help string) prometheus.Gauge {
m := prometheus.NewGauge(prometheus.GaugeOpts{
Namespace: namespace,
Subsystem: component,
Name: name,
Help: help,
})
prometheus.MustRegister(m)
return m
}
// MustRegisterGaugeVec creates and registers a gauge vector.
// Must be called from `init`.
func MustRegisterGaugeVec(component, name, help string, labelNames ...string) *prometheus.GaugeVec {
m := prometheus.NewGaugeVec(prometheus.GaugeOpts{
Namespace: namespace,
Subsystem: component,
Name: name,
Help: help,
}, labelNames)
prometheus.MustRegister(m)
return m
}
// MustRegisterSummary creates and registers a summary.
// Must be called from `init`.
func MustRegisterSummary(component, name, help string, objectives map[float64]float64) prometheus.Summary {
if objectives == nil {
objectives = map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001}
}
m := prometheus.NewSummary(prometheus.SummaryOpts{
Namespace: namespace,
Subsystem: component,
Name: name,
Help: help,
Objectives: objectives,
})
prometheus.MustRegister(m)
return m
}
// SetDuration sets a gauge value for the duration since the given start time
// in seconds.
func SetDuration(g prometheus.Gauge, startTime time.Time) {
g.Set(time.Since(startTime).Seconds())
}