prometheus/web/semconv/metrics.go

// Code generated from semantic convention specification. DO NOT EDIT.

// Package metrics provides Prometheus instrumentation types for metrics
// defined in this semantic convention registry.
package metrics

import (
	"time"

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

// Attribute is an interface for metric label attributes.
type Attribute interface {
	ID() string
	Value() string
}
type CodeAttr string

func (a CodeAttr) ID() string {
	return "code"
}

func (a CodeAttr) Value() string {
	return string(a)
}

type HandlerAttr string

func (a HandlerAttr) ID() string {
	return "handler"
}

func (a HandlerAttr) Value() string {
	return string(a)
}

// PrometheusHTTPRequestDurationSeconds records the histogram of latencies for HTTP requests.
type PrometheusHTTPRequestDurationSeconds struct {
	*prometheus.HistogramVec
}

// NewPrometheusHTTPRequestDurationSeconds returns a new PrometheusHTTPRequestDurationSeconds instrument.
func NewPrometheusHTTPRequestDurationSeconds() PrometheusHTTPRequestDurationSeconds {
	labels := []string{
		"handler",
	}
	return PrometheusHTTPRequestDurationSeconds{
		HistogramVec: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Name:                            "prometheus_http_request_duration_seconds",
			Help:                            "Histogram of latencies for HTTP requests.",
			Buckets:                         []float64{0.1, 0.2, 0.4, 1, 3, 8, 20, 60, 120},
			NativeHistogramBucketFactor:     1.1,
			NativeHistogramMaxBucketNumber:  100,
			NativeHistogramMinResetDuration: 1 * time.Hour,
		}, labels),
	}
}

type PrometheusHTTPRequestDurationSecondsAttr interface {
	Attribute
	implPrometheusHTTPRequestDurationSeconds()
}

func (a HandlerAttr) implPrometheusHTTPRequestDurationSeconds() {}

func (m PrometheusHTTPRequestDurationSeconds) With(
	extra ...PrometheusHTTPRequestDurationSecondsAttr,
) prometheus.Observer {
	labels := prometheus.Labels{
		"handler": "",
	}
	for _, v := range extra {
		labels[v.ID()] = v.Value()
	}
	return m.HistogramVec.With(labels)
}

// PrometheusHTTPRequestsTotal records the counter of HTTP requests.
type PrometheusHTTPRequestsTotal struct {
	*prometheus.CounterVec
}

// NewPrometheusHTTPRequestsTotal returns a new PrometheusHTTPRequestsTotal instrument.
func NewPrometheusHTTPRequestsTotal() PrometheusHTTPRequestsTotal {
	labels := []string{
		"handler",
		"code",
	}
	return PrometheusHTTPRequestsTotal{
		CounterVec: prometheus.NewCounterVec(prometheus.CounterOpts{
			Name: "prometheus_http_requests_total",
			Help: "Counter of HTTP requests.",
		}, labels),
	}
}

type PrometheusHTTPRequestsTotalAttr interface {
	Attribute
	implPrometheusHTTPRequestsTotal()
}

func (a HandlerAttr) implPrometheusHTTPRequestsTotal() {}
func (a CodeAttr) implPrometheusHTTPRequestsTotal()    {}

func (m PrometheusHTTPRequestsTotal) With(
	extra ...PrometheusHTTPRequestsTotalAttr,
) prometheus.Counter {
	labels := prometheus.Labels{
		"handler": "",
		"code":    "",
	}
	for _, v := range extra {
		labels[v.ID()] = v.Value()
	}
	return m.CounterVec.With(labels)
}

// PrometheusHTTPResponseSizeBytes records the histogram of response size for HTTP requests.
type PrometheusHTTPResponseSizeBytes struct {
	*prometheus.HistogramVec
}

// NewPrometheusHTTPResponseSizeBytes returns a new PrometheusHTTPResponseSizeBytes instrument.
func NewPrometheusHTTPResponseSizeBytes() PrometheusHTTPResponseSizeBytes {
	labels := []string{
		"handler",
	}
	return PrometheusHTTPResponseSizeBytes{
		HistogramVec: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Name:    "prometheus_http_response_size_bytes",
			Help:    "Histogram of response size for HTTP requests.",
			Buckets: prometheus.ExponentialBuckets(100, 10, 8),
		}, labels),
	}
}

type PrometheusHTTPResponseSizeBytesAttr interface {
	Attribute
	implPrometheusHTTPResponseSizeBytes()
}

func (a HandlerAttr) implPrometheusHTTPResponseSizeBytes() {}

func (m PrometheusHTTPResponseSizeBytes) With(
	extra ...PrometheusHTTPResponseSizeBytesAttr,
) prometheus.Observer {
	labels := prometheus.Labels{
		"handler": "",
	}
	for _, v := range extra {
		labels[v.ID()] = v.Value()
	}
	return m.HistogramVec.With(labels)
}

// PrometheusReady records the whether Prometheus startup was fully completed and the server is ready for normal operation.
type PrometheusReady struct {
	prometheus.Gauge
}

// NewPrometheusReady returns a new PrometheusReady instrument.
func NewPrometheusReady() PrometheusReady {
	return PrometheusReady{
		Gauge: prometheus.NewGauge(prometheus.GaugeOpts{
			Name: "prometheus_ready",
			Help: "Whether Prometheus startup was fully completed and the server is ready for normal operation.",
		}),
	}
}

// PrometheusWebFederationErrorsTotal records the total number of errors that occurred while sending federation responses.
type PrometheusWebFederationErrorsTotal struct {
	prometheus.Counter
}

// NewPrometheusWebFederationErrorsTotal returns a new PrometheusWebFederationErrorsTotal instrument.
func NewPrometheusWebFederationErrorsTotal() PrometheusWebFederationErrorsTotal {
	return PrometheusWebFederationErrorsTotal{
		Counter: prometheus.NewCounter(prometheus.CounterOpts{
			Name: "prometheus_web_federation_errors_total",
			Help: "Total number of errors that occurred while sending federation responses.",
		}),
	}
}

// PrometheusWebFederationWarningsTotal records the total number of warnings that occurred while sending federation responses.
type PrometheusWebFederationWarningsTotal struct {
	prometheus.Counter
}

// NewPrometheusWebFederationWarningsTotal returns a new PrometheusWebFederationWarningsTotal instrument.
func NewPrometheusWebFederationWarningsTotal() PrometheusWebFederationWarningsTotal {
	return PrometheusWebFederationWarningsTotal{
		Counter: prometheus.NewCounter(prometheus.CounterOpts{
			Name: "prometheus_web_federation_warnings_total",
			Help: "Total number of warnings that occurred while sending federation responses.",
		}),
	}
}