resourcetotelemetry

README

Resource to Telemetry

This is an exporter helper for converting resource attributes to telemetry attributes. This helper can be used to wrap other exporters.

⚠ This exporter helper should not be added to a service pipeline.

Configuration

The following configuration options can be modified:

• resource_to_telemetry_conversion
  • enabled (default = false): If enabled is true, all the resource attributes will be converted to metric labels by default.
  • exclude_service_attributes (default = false): If set to true, the service.name, service.instance.id and service.namespace resource attributes, which are already converted to job and instance labels respectively, will be excluded from the final metrics.

Documentation

Index

• func WrapMetricsExporter(set Settings, exporter exporter.Metrics) exporter.Metrics
• type Settings

Functions

func WrapMetricsExporter

func WrapMetricsExporter(set Settings, exporter exporter.Metrics) exporter.Metrics

WrapMetricsExporter wraps a given exporter.Metrics and based on the given settings converts incoming resource attributes to metrics attributes.

Types

type Settings

type Settings struct {
	// Enabled indicates whether to convert resource attributes to telemetry attributes. Default is `false`.
	Enabled bool `mapstructure:"enabled"`
	// ExcludeServiceAttributes indicates whether to exclude `service.name`, `service.instance.id` and `service.namespace`
	// resource attributes from being converted to metric attributes. Default is `false`.
	// When set to `true`, these attributes will not be added to metric labels since they are
	// already mapped to Prometheus `job` and `instance` labels respectively.
	ExcludeServiceAttributes bool `mapstructure:"exclude_service_attributes"`
}

Settings defines configuration for converting resource attributes to telemetry attributes. When used, it must be embedded in the exporter configuration:

type Config struct {
  // ...
  resourcetotelemetry.Settings `mapstructure:"resource_to_telemetry_conversion"`
}