prome

README

prome

Prometheus Client for easy use.

Documentation

Index

• type Client
  • func NewClient(serviceName string, path string) *Client
  • func (c *Client) AddCounter(opts prometheus.CounterOpts) prometheus.Counter
  • func (c *Client) AddCounterVec(opts prometheus.CounterOpts, labelNames []string) *prometheus.CounterVec
  • func (c *Client) AddGauge(opts prometheus.GaugeOpts) prometheus.Gauge
  • func (c *Client) AddGaugeVec(opts prometheus.GaugeOpts, labelNames []string) *prometheus.GaugeVec
  • func (c *Client) AddHistogram(opts prometheus.HistogramOpts) prometheus.Histogram
  • func (c *Client) AddHistogramVec(opts prometheus.HistogramOpts, labelNames []string) *prometheus.HistogramVec
  • func (c *Client) AddSummary(opts prometheus.SummaryOpts) prometheus.Summary
  • func (c *Client) AddSummaryVec(opts prometheus.SummaryOpts, labelNames []string) *prometheus.SummaryVec
  • func (c *Client) DurationMiddleware(metricsName string, objectives map[float64]float64) gin.HandlerFunc
  • func (c *Client) Handler() http.Handler
  • func (c *Client) ListenAndServe(addr string) error
  • func (c *Client) QPSMiddleware(metricsName string) gin.HandlerFunc

Types

type Client

type Client struct {
	ServiceName string
	Path        string

	// Enable metrics of runtime. Default enabled.
	EnableRuntime bool

	// Labels which will always be attached to metrics.
	ConstLabels prometheus.Labels
	// contains filtered or unexported fields
}

Client represents the client for prometheus server to pull data from.

func NewClient

func NewClient(serviceName string, path string) *Client

NewClient creates and returns a new Client instance.

func (*Client) AddCounter

func (c *Client) AddCounter(opts prometheus.CounterOpts) prometheus.Counter

func (*Client) AddCounterVec

func (c *Client) AddCounterVec(
	opts prometheus.CounterOpts, labelNames []string,
) *prometheus.CounterVec

func (*Client) AddGauge

func (c *Client) AddGauge(opts prometheus.GaugeOpts) prometheus.Gauge

func (*Client) AddGaugeVec

func (c *Client) AddGaugeVec(
	opts prometheus.GaugeOpts, labelNames []string,
) *prometheus.GaugeVec

func (*Client) AddHistogram

func (c *Client) AddHistogram(opts prometheus.HistogramOpts) prometheus.Histogram

func (*Client) AddHistogramVec

func (c *Client) AddHistogramVec(
	opts prometheus.HistogramOpts, labelNames []string,
) *prometheus.HistogramVec

func (*Client) AddSummary

func (c *Client) AddSummary(opts prometheus.SummaryOpts) prometheus.Summary

func (*Client) AddSummaryVec

func (c *Client) AddSummaryVec(
	opts prometheus.SummaryOpts, labelNames []string,
) *prometheus.SummaryVec

func (*Client) DurationMiddleware

func (c *Client) DurationMiddleware(
	metricsName string, objectives map[float64]float64,
) gin.HandlerFunc

DurationMiddleware returns a gin handler which can be used as middleware to capture API duration summary.

func (*Client) Handler

func (c *Client) Handler() http.Handler

Handler returns the http handler which can be used for fetch metrics data.

func (*Client) ListenAndServe

func (c *Client) ListenAndServe(addr string) error

ListenAndServe listen on the addr and provide access for prometheus server to pull data.

func (*Client) QPSMiddleware

func (c *Client) QPSMiddleware(metricsName string) gin.HandlerFunc

QPSMiddleware returns a gin HandlerFunc which can be used as middleware to capture QPS counter.