metrics.go

package pusher

import (
	"strconv"

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

const (
	LabelValueMetrics        = "metrics"
	LabelValueLogs           = "logs"
	LabelValueClient         = "client"
	LabelValueRetryExhausted = "retry_exhausted"
	LabelValueTenant         = "tenant"
)

// Metrics contains the prometheus Metrics for a publisher.
type Metrics struct {
	PushCounter    *prometheus.CounterVec
	ErrorCounter   *prometheus.CounterVec
	BytesOut       *prometheus.CounterVec
	FailedCounter  *prometheus.CounterVec
	RetriesCounter *prometheus.CounterVec

	// For experimental publisher only
	DroppedCounter  *prometheus.CounterVec
	ResponseCounter *prometheus.CounterVec

	InstalledHandlers prometheus.Gauge
}

var (
	labelsWithTenantType       = []string{"regionID", "tenantID", "type"}
	labelsWithTenantTypeStatus = []string{"regionID", "tenantID", "type", "status"}
	labelsWithTenantTypeReason = []string{"regionID", "tenantID", "type", "reason"}
)

// NewMetrics returns a new set of publisher metrics registered in the given registerer.
func NewMetrics(promRegisterer prometheus.Registerer) (m Metrics) {
	m.PushCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "push_total",
			Help:      "Total number of push events by type.",
		},
		labelsWithTenantType)

	promRegisterer.MustRegister(m.PushCounter)

	m.ErrorCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "push_errors_total",
			Help:      "Total number of push errors by type and status.",
		},
		labelsWithTenantTypeStatus)

	promRegisterer.MustRegister(m.ErrorCounter)

	m.FailedCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "push_failed_total",
			Help:      "Total number of push failures by type.",
		},
		labelsWithTenantTypeReason)

	promRegisterer.MustRegister(m.FailedCounter)

	m.BytesOut = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "push_bytes",
			Help:      "Total number of bytes pushed by type.",
		},
		labelsWithTenantType)

	promRegisterer.MustRegister(m.BytesOut)

	m.RetriesCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "retries_total",
			Help:      "Total number of retries performed by type.",
		},
		labelsWithTenantType)

	promRegisterer.MustRegister(m.RetriesCounter)

	m.DroppedCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "drop_total",
			Help:      "Total number of results dropped by type.",
		},
		labelsWithTenantType)

	promRegisterer.MustRegister(m.DroppedCounter)

	m.ResponseCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "responses_total",
			Help:      "Total number of responses received by type and status code.",
		},
		labelsWithTenantTypeStatus)

	promRegisterer.MustRegister(m.ResponseCounter)

	m.InstalledHandlers = prometheus.NewGauge(
		prometheus.GaugeOpts{
			Namespace: "sm_agent",
			Subsystem: "publisher",
			Name:      "handlers_total",
			Help:      "Total number of installed publisher handlers.",
		},
	)

	promRegisterer.MustRegister(m.InstalledHandlers)

	return m
}

// WithTenant returns a new set of Metrics with the local and region ID labels
// already included.
func (m Metrics) WithTenant(localID int64, regionID int) Metrics {
	labels := prometheus.Labels{
		"regionID": strconv.FormatInt(int64(regionID), 10),
		"tenantID": strconv.FormatInt(localID, 10),
	}
	return Metrics{
		PushCounter:       m.PushCounter.MustCurryWith(labels),
		ErrorCounter:      m.ErrorCounter.MustCurryWith(labels),
		BytesOut:          m.BytesOut.MustCurryWith(labels),
		FailedCounter:     m.FailedCounter.MustCurryWith(labels),
		RetriesCounter:    m.RetriesCounter.MustCurryWith(labels),
		DroppedCounter:    m.DroppedCounter.MustCurryWith(labels),
		ResponseCounter:   m.ResponseCounter.MustCurryWith(labels),
		InstalledHandlers: m.InstalledHandlers,
	}
}

// WithType returns a new set of Metrics with the given type label.
func (m Metrics) WithType(t string) Metrics {
	var typeLabels = prometheus.Labels{
		"type": t,
	}

	return Metrics{
		PushCounter:       m.PushCounter.MustCurryWith(typeLabels),
		ErrorCounter:      m.ErrorCounter.MustCurryWith(typeLabels),
		BytesOut:          m.BytesOut.MustCurryWith(typeLabels),
		FailedCounter:     m.FailedCounter.MustCurryWith(typeLabels),
		RetriesCounter:    m.RetriesCounter.MustCurryWith(typeLabels),
		DroppedCounter:    m.DroppedCounter.MustCurryWith(typeLabels),
		ResponseCounter:   m.ResponseCounter.MustCurryWith(typeLabels),
		InstalledHandlers: m.InstalledHandlers,
	}
}