prometheusexporter

README

Prometheus Exporter

Exports data to a Prometheus back-end.

Supported pipeline types: metrics

Getting Started

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.
• metric_expiration (default = 5m): defines how long metrics are exposed without updates
• resource_to_telemetry_conversion
  • enabled (default = false): If enabled is true, all the resource attributes will be converted to metric labels by default.

Example:

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

Documentation

Overview

Package prometheusexporter exports metrics data as a Prometheus pull handler.

Index

• func NewFactory() component.ExporterFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a new Prometheus exporter factory.

Types

type Config

type Config struct {
	config.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"`

	// MetricExpiration defines how long metrics are kept without updates
	MetricExpiration time.Duration `mapstructure:"metric_expiration"`

	// ResourceToTelemetrySettings defines configuration for converting resource attributes to metric labels.
	ResourceToTelemetrySettings resourcetotelemetry.Settings `mapstructure:"resource_to_telemetry_conversion"`
}

Config defines configuration for Prometheus exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid