prometheus

README

OpenTelemetry-Go Prometheus Exporter

OpenTelemetry Prometheus exporter

Installation

go get -u go.opentelemetry.io/otel/exporters/metric/prometheus

Documentation

Overview

Package prometheus provices an OpenTelemetry metrics exporter for Prometheus.

Deprecated: Use Prometheus exporter in package go.opentelemetry.io/otel/exporters/prometheus.

This package is frozen and no new functionality will be added.

Index

• Variables
• type Config
• type Exporter
  • func New(config Config, controller *controller.Controller) (*Exporter, error)
  • func (e *Exporter) Controller() *controller.Controller
  • func (e *Exporter) ExportKindFor(desc *metric.Descriptor, kind aggregation.Kind) export.ExportKind
  • func (e *Exporter) MeterProvider() metric.MeterProvider
  • func (e *Exporter) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var ErrUnsupportedAggregator = fmt.Errorf("unsupported aggregator type")

ErrUnsupportedAggregator is returned for unrepresentable aggregator types (e.g., exact).

Types

type Config

type Config struct {
	// Registry is the prometheus registry that will be used as the default Registerer and
	// Gatherer if these are not specified.
	//
	// If not set a new empty Registry is created.
	Registry *prometheus.Registry

	// Registerer is the prometheus registerer to register
	// metrics with.
	//
	// If not specified the Registry will be used as default.
	Registerer prometheus.Registerer

	// Gatherer is the prometheus gatherer to gather
	// metrics with.
	//
	// If not specified the Registry will be used as default.
	Gatherer prometheus.Gatherer

	// DefaultHistogramBoundaries defines the default histogram bucket
	// boundaries.
	DefaultHistogramBoundaries []float64
}

Config is a set of configs for the tally reporter.

type Exporter

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

Exporter supports Prometheus pulls. It does not implement the sdk/export/metric.Exporter interface--instead it creates a pull controller and reads the latest checkpointed data on-scrape.

func New

func New(config Config, controller *controller.Controller) (*Exporter, error)

New returns a new Prometheus exporter using the configured metric controller. See controller.New().

func (*Exporter) Controller

func (e *Exporter) Controller() *controller.Controller

Controller returns the controller object that coordinates collection for the SDK.

func (*Exporter) ExportKindFor

func (e *Exporter) ExportKindFor(desc *metric.Descriptor, kind aggregation.Kind) export.ExportKind

ExportKindFor implements ExportKindSelector.

func (*Exporter) MeterProvider

func (e *Exporter) MeterProvider() metric.MeterProvider

MeterProvider returns the MeterProvider of this exporter.

func (*Exporter) ServeHTTP

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

ServeHTTP implements http.Handler.