prometheusexporter

README

Prometheus Exporter

Exports metric data to a Prometheus back-end.

The following settings are required:

• endpoint (no default): Where to send metric data

The following settings can be optionally configured:

• constlabels (no default): key/values that are applied for every exported metric.
• namespace (no default): if set, exports metrics under the provided value.
• send_timestamps (default false): if true, sends the timestamp of the underlying metric sample in the response.

Example:

exporters:
  prometheus:
    endpoint: "1.2.3.4:1234"
    namespace: test-space
    const_labels:
      label1: value1
      "another label": spaced value
    send_timestamps: true

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

Documentation

Index

• func NewFactory() component.ExporterFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for OTLP exporter.

Types

type Config

type Config struct {
	configmodels.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	// The address on which the Prometheus scrape handler will be run on.
	Endpoint string `mapstructure:"endpoint"`

	// Namespace if set, exports metrics under the provided value.
	Namespace string `mapstructure:"namespace"`

	// ConstLabels are values that are applied for every exported metric.
	ConstLabels prometheus.Labels `mapstructure:"const_labels"`

	// SendTimestamps will send the underlying scrape timestamp with the export
	SendTimestamps bool `mapstructure:"send_timestamps"`
}

Config defines configuration for Prometheus exporter.