metrics

Documentation

Index

• type Config
• type CountMap
  • func NewCountMap() *CountMap
  • func (cm *CountMap) Get(labels ...string) (uint64, error)
• type EmulatedMetricer
  • func NewEmulatedMetricer() *EmulatedMetricer
  • func (n *EmulatedMetricer) Document() []metrics.DocumentedMetric
  • func (n *EmulatedMetricer) RecordInfo(_ string)
  • func (n *EmulatedMetricer) RecordRPCServerRequest(method string) func(status, mode, ver string)
  • func (n *EmulatedMetricer) RecordSecondaryRequest(x string, y string) func(status string)
  • func (n *EmulatedMetricer) RecordUp()
• type Metricer
• type Metrics
  • func NewMetrics(subsystem string) *Metrics
  • func (m *Metrics) Document() []metrics.DocumentedMetric
  • func (m *Metrics) RecordInfo(version string)
  • func (m *Metrics) RecordRPCServerRequest(method string) func(status, mode, ver string)
  • func (m *Metrics) RecordSecondaryRequest(bt string, method string) func(status string)
  • func (m *Metrics) RecordUp()
  • func (m *Metrics) StartServer(hostname string, port int) (*ophttp.HTTPServer, error)

Types

type Config

type Config struct {
	Host              string
	Port              int
	Enabled           bool
	ReadHeaderTimeout int
}

Config ... Metrics server configuration

type CountMap

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

CountMap ... In memory representation of a prometheus Count metric type

func NewCountMap

func NewCountMap() *CountMap

NewCountMap ... Init

func (*CountMap) Get

func (cm *CountMap) Get(labels ...string) (uint64, error)

Get ... fetches the value count associated with a deterministic label key

type EmulatedMetricer

type EmulatedMetricer struct {
	HTTPServerRequestsTotal *CountMap
	// secondary metrics
	SecondaryRequestsTotal *CountMap
}

EmulatedMetricer ... allows for tracking count metrics in memory and is only used for E2E testing. This is needed since prometheus/client_golang doesn't provide an interface for reading the count values from the codified metric.

func NewEmulatedMetricer

func NewEmulatedMetricer() *EmulatedMetricer

NewEmulatedMetricer ... constructor

func (*EmulatedMetricer) Document

func (n *EmulatedMetricer) Document() []metrics.DocumentedMetric

Document ... noop

func (*EmulatedMetricer) RecordInfo

func (n *EmulatedMetricer) RecordInfo(_ string)

RecordInfo ... noop

func (*EmulatedMetricer) RecordRPCServerRequest

func (n *EmulatedMetricer) RecordRPCServerRequest(method string) func(status, mode, ver string)

RecordRPCServerRequest ... updates server requests counter associated with label fingerprint

func (*EmulatedMetricer) RecordSecondaryRequest

func (n *EmulatedMetricer) RecordSecondaryRequest(x string, y string) func(status string)

RecordSecondaryRequest ... updates secondary insertion counter associated with label fingerprint

func (*EmulatedMetricer) RecordUp

func (n *EmulatedMetricer) RecordUp()

RecordUp ... noop

type Metricer

type Metricer interface {
	RecordInfo(version string)
	RecordUp()

	RecordRPCServerRequest(method string) func(status string, mode string, ver string)
	RecordSecondaryRequest(bt string, method string) func(status string)

	Document() []metrics.DocumentedMetric
}

Metricer ... Interface for metrics

var NoopMetrics Metricer = new(noopMetricer)

type Metrics

type Metrics struct {
	Info *prometheus.GaugeVec
	Up   prometheus.Gauge

	// server metrics
	HTTPServerRequestsTotal          *prometheus.CounterVec
	HTTPServerBadRequestHeader       *prometheus.CounterVec
	HTTPServerRequestDurationSeconds *prometheus.HistogramVec

	// secondary metrics
	SecondaryRequestsTotal      *prometheus.CounterVec
	SecondaryRequestDurationSec *prometheus.HistogramVec
	// contains filtered or unexported fields
}

Metrics ... Metrics struct

func NewMetrics

func NewMetrics(subsystem string) *Metrics

func (*Metrics) Document

func (m *Metrics) Document() []metrics.DocumentedMetric

func (*Metrics) RecordInfo

func (m *Metrics) RecordInfo(version string)

RecordInfo sets a pseudo-metric that contains versioning and config info for the proxy DA node.

func (*Metrics) RecordRPCServerRequest

func (m *Metrics) RecordRPCServerRequest(method string) func(status, mode, ver string)

RecordRPCServerRequest is a helper method to record an incoming HTTP request. It bumps the requests metric, and tracks how long it takes to serve a response, including the HTTP status code.

func (*Metrics) RecordSecondaryRequest

func (m *Metrics) RecordSecondaryRequest(bt string, method string) func(status string)

RecordSecondaryPut records a secondary put/get operation.

func (*Metrics) RecordUp

func (m *Metrics) RecordUp()

RecordUp sets the up metric to 1.

func (*Metrics) StartServer

func (m *Metrics) StartServer(hostname string, port int) (*ophttp.HTTPServer, error)

StartServer starts the metrics server on the given hostname and port. If port is 0, it automatically assigns an available port and returns the actual port.