metrics

Documentation

Index

• func NewNginxMetricsClient(httpClient *http.Client) (*prometheusClient.NginxClient, error)
• func RunPrometheusListenerForNginx(port int, client *prometheusClient.NginxClient, registry *prometheus.Registry, ...)
• func RunPrometheusListenerForNginxPlus(port int, nginxPlusCollector prometheus.Collector, ...)
• type LatencyMetricsListener
  • func (l LatencyMetricsListener) Run()
  • func (l LatencyMetricsListener) Stop()
• type SyslogFakeListener
  • func NewSyslogFakeServer() *SyslogFakeListener
  • func (s SyslogFakeListener) Run()
  • func (s SyslogFakeListener) Stop()
• type SyslogListener
  • func NewLatencyMetricsListener(sockPath string, c collectors.LatencyCollector) SyslogListener

Functions

func NewNginxMetricsClient

func NewNginxMetricsClient(httpClient *http.Client) (*prometheusClient.NginxClient, error)

NewNginxMetricsClient creates an NginxClient to fetch stats from NGINX over an unix socket

func RunPrometheusListenerForNginx

func RunPrometheusListenerForNginx(port int, client *prometheusClient.NginxClient, registry *prometheus.Registry, constLabels map[string]string)

RunPrometheusListenerForNginx runs an http server to expose Prometheus metrics for NGINX

func RunPrometheusListenerForNginxPlus

func RunPrometheusListenerForNginxPlus(port int, nginxPlusCollector prometheus.Collector, registry *prometheus.Registry)

RunPrometheusListenerForNginxPlus runs an http server to expose Prometheus metrics for NGINX Plus

Types

type LatencyMetricsListener

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

LatencyMetricsListener implements the SyslogListener interface

func (LatencyMetricsListener) Run

func (l LatencyMetricsListener) Run()

Run reads from the unix connection until an unrecoverable error occurs or the connection is closed.

func (LatencyMetricsListener) Stop

func (l LatencyMetricsListener) Stop()

Stop closes the unix connection of the listener.

type SyslogFakeListener

type SyslogFakeListener struct{}

SyslogFakeListener is a fake implementation of the SyslogListener interface

func NewSyslogFakeServer

func NewSyslogFakeServer() *SyslogFakeListener

NewFakeSyslogServer returns a SyslogFakeListener

func (SyslogFakeListener) Run

func (s SyslogFakeListener) Run()

Run is a fake implementation of SyslogListener Run

func (SyslogFakeListener) Stop

func (s SyslogFakeListener) Stop()

Stop is a fake implementation of SyslogListener Stop

type SyslogListener

type SyslogListener interface {
	Run()
	Stop()
}

SyslogListener is an interface for syslog metrics listener that reads syslog metrics logged by nginx

func NewLatencyMetricsListener

func NewLatencyMetricsListener(sockPath string, c collectors.LatencyCollector) SyslogListener

NewLatencyMetricsListener returns a LatencyMetricsListener that listens over a unix socket for syslog messages from nginx.