prometheusmetrics

README

go-metrics-prometheus

This is a reporter for the go-metrics library which will post the metrics to the prometheus client registry . It just updates the registry, taking care of exporting the metrics is still your responsibility.

Usage:

	import "github.com/deathowl/go-metrics-prometheus"
	import "github.com/prometheus/client_golang/prometheus"

    	prometheusRegistry := prometheus.NewRegistry()
        metricsRegistry := metrics.NewRegistry()
        pClient := NewPrometheusProvider(metricsRegistry, "test", "subsys", prometheusRegistry, 1*time.Second)
        go pClient.UpdatePrometheusMetrics()

Documentation

Overview

Package prometheusmetrics implements go-metrics library which will post to the prometheus client registry.

Index

• type PrometheusConfig
  • func NewPrometheusProvider(r metrics.Registry, namespace string, subsystem string, ...) *PrometheusConfig
  • func (c *PrometheusConfig) UpdatePrometheusMetrics()
  • func (c *PrometheusConfig) UpdatePrometheusMetricsOnce() error

Types

type PrometheusConfig

type PrometheusConfig struct {
	Registry metrics.Registry // Registry to be exported

	FlushInterval time.Duration // interval to update prom metrics
	// contains filtered or unexported fields
}

func NewPrometheusProvider

func NewPrometheusProvider(r metrics.Registry, namespace string, subsystem string, promRegistry prometheus.Registerer,
	FlushInterval time.Duration,
) *PrometheusConfig

NewPrometheusProvider returns a Provider that produces Prometheus metrics. Namespace and subsystem are applied to all produced metrics.

func (*PrometheusConfig) UpdatePrometheusMetrics

func (c *PrometheusConfig) UpdatePrometheusMetrics()

func (*PrometheusConfig) UpdatePrometheusMetricsOnce

func (c *PrometheusConfig) UpdatePrometheusMetricsOnce() error