exporter

Documentation

Overview

Package exporter provides the interface for getting metrics out of mtail, into your monitoring system of choice.

Index

• type Exporter
  • func New(o Options) (*Exporter, error)
  • func (e *Exporter) HandleJSON(w http.ResponseWriter, r *http.Request)
  • func (e *Exporter) HandlePrometheusMetrics(w http.ResponseWriter, r *http.Request)
  • func (e *Exporter) HandleVarz(w http.ResponseWriter, r *http.Request)
  • func (e *Exporter) PushMetrics()
  • func (e *Exporter) RegisterPushExport(p pushOptions)
  • func (e *Exporter) StartMetricPush()
• type Options

Types

type Exporter

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

Exporter manages the export of metrics to passive and active collectors.

func New

func New(o Options) (*Exporter, error)

New creates a new Exporter.

func (*Exporter) HandleJSON

func (e *Exporter) HandleJSON(w http.ResponseWriter, r *http.Request)

HandleJSON exports the metrics in JSON format via HTTP.

func (*Exporter) HandlePrometheusMetrics

func (e *Exporter) HandlePrometheusMetrics(w http.ResponseWriter, r *http.Request)

HandlePrometheusMetrics exports the metrics in a format readable by Prometheus via HTTP.

func (*Exporter) HandleVarz

func (e *Exporter) HandleVarz(w http.ResponseWriter, r *http.Request)

HandleVarz exports the metrics in Varz format via HTTP.

func (*Exporter) PushMetrics

func (e *Exporter) PushMetrics()

PushMetrics sends metrics to each of the configured services.

func (*Exporter) RegisterPushExport

func (e *Exporter) RegisterPushExport(p pushOptions)

RegisterPushExport adds a push export connection to the Exporter. Items in the list must describe a Dial()able connection and will have all the metrics pushed to each pushInterval.

func (*Exporter) StartMetricPush

func (e *Exporter) StartMetricPush()

StartMetricPush pushes metrics to the configured services each interval.

type Options

type Options struct {
	Store         *metrics.Store
	Hostname      string // Not required, uses os.Hostname if zero.
	OmitProgLabel bool   // If true, don't emit the prog label that identifies the source program in variable exports.
}

Options contains the required and optional parameters for constructing an Exporter.