metrics

Documentation

Index

• type HTTPMetricsRegistry
• type MetricsRegistry
  • func New(service string) *MetricsRegistry
  • func (r *MetricsRegistry) DecrementActiveConnections()
  • func (r *MetricsRegistry) IncrementActiveConnections()
  • func (r *MetricsRegistry) IncrementRequestsTotal(method, status, endpoint string)
  • func (r *MetricsRegistry) ObserveRequestDuration(method, status, endpoint string, duration float64)
  • func (r *MetricsRegistry) ObserveRequestSize(method, status, endpoint string, size float64)
  • func (r *MetricsRegistry) ObserveResponseSize(method, status, endpoint string, size float64)

Types

type HTTPMetricsRegistry

type HTTPMetricsRegistry interface {
	DecrementActiveConnections()
	IncrementActiveConnections()
	IncrementRequestsTotal(method string, status string, endpoint string)
	ObserveRequestDuration(method string, status string, endpoint string, duration float64)
	ObserveRequestSize(method string, status string, endpoint string, size float64)
	ObserveResponseSize(method string, status string, endpoint string, size float64)
}

MetricsRegistry is a registry for metrics.

type MetricsRegistry

type MetricsRegistry struct {
	// contains filtered or unexported fields
}

func New

func New(service string) *MetricsRegistry

New returns a new MetricsRegistry instance based on the provided service name. It configures the following metrics: - http_active_connections: number of active HTTP connections - http_requests_total: number of HTTP requests - http_request_duration: duration of HTTP requests - http_request_size: size of HTTP requests - http_response_size: size of HTTP responses

The metrics are registered with the global prometheus registry.

func (*MetricsRegistry) DecrementActiveConnections

func (r *MetricsRegistry) DecrementActiveConnections()

DecrementActiveConnections decrements the "http_active_connections" gauge for the given service by one.

func (*MetricsRegistry) IncrementActiveConnections

func (r *MetricsRegistry) IncrementActiveConnections()

IncrementActiveConnections increments the "http_active_connections" counter for the given service by one.

func (*MetricsRegistry) IncrementRequestsTotal

func (r *MetricsRegistry) IncrementRequestsTotal(method, status, endpoint string)

IncrementRequestsTotal increments the "http_requests_total" counter for the specified HTTP method, status, and endpoint within the context of the registered service.

func (*MetricsRegistry) ObserveRequestDuration

func (r *MetricsRegistry) ObserveRequestDuration(
	method, status, endpoint string,
	duration float64,
)

ObserveRequestDuration observes the duration of an HTTP request. method, status, and endpoint are labels that identify the request. duration is the duration of the request in seconds.

func (*MetricsRegistry) ObserveRequestSize

func (r *MetricsRegistry) ObserveRequestSize(method, status, endpoint string, size float64)

ObserveRequestSize records the size of an HTTP request. method, status, and endpoint are labels that identify the request. size is the size of the request in bytes.

func (*MetricsRegistry) ObserveResponseSize

func (r *MetricsRegistry) ObserveResponseSize(method, status, endpoint string, size float64)

ObserveResponseSize records the size of an HTTP response. method, status, and endpoint are labels that identify the request. size is the size of the response in bytes.