README
¶
Prometheus Exporter
Documentation
¶
Overview ¶
Package prometheus provides a Prometheus Exporter that converts OTLP metrics into the Prometheus exposition format and implements prometheus.Collector to provide a handler for these metrics.
Index ¶
- type Exporter
- type Option
- func WithAggregationSelector(agg metric.AggregationSelector) Option
- func WithNamespace(ns string) Option
- func WithProducer(producer metric.Producer) Option
- func WithRegisterer(reg prometheus.Registerer) Option
- func WithResourceAsConstantLabels(resourceFilter attribute.Filter) Option
- func WithoutCounterSuffixes() Option
- func WithoutScopeInfo() Option
- func WithoutTargetInfo() Option
- func WithoutUnits() Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Exporter ¶
Exporter is a Prometheus Exporter that embeds the OTel metric.Reader interface for easy instantiation with a MeterProvider.
func (*Exporter) MarshalLog ¶ added in v0.40.0
func (e *Exporter) MarshalLog() interface{}
MarshalLog returns logging data about the Exporter.
type Option ¶ added in v0.32.0
type Option interface {
// contains filtered or unexported methods
}
Option sets exporter option values.
func WithAggregationSelector ¶ added in v0.33.0
func WithAggregationSelector(agg metric.AggregationSelector) Option
WithAggregationSelector configure the Aggregation Selector the exporter will use. If no AggregationSelector is provided the DefaultAggregationSelector is used.
func WithNamespace ¶ added in v0.38.0
WithNamespace configures the Exporter to prefix metric with the given namespace. Metadata metrics such as target_info and otel_scope_info are not prefixed since these have special behavior based on their name.
func WithProducer ¶ added in v0.41.0
WithProducer configure the metric Producer the exporter will use as a source of external metric data.
func WithRegisterer ¶ added in v0.33.0
func WithRegisterer(reg prometheus.Registerer) Option
WithRegisterer configures which prometheus Registerer the Exporter will register with. If no registerer is used the prometheus DefaultRegisterer is used.
func WithResourceAsConstantLabels ¶ added in v0.45.0
WithResourceAsConstantLabels configures the Exporter to add the resource attributes the resourceFilter returns true for as attributes on all exported metrics.
The does not affect the target info generated from resource attributes.
func WithoutCounterSuffixes ¶ added in v0.40.0
func WithoutCounterSuffixes() Option
WithoutCounterSuffixes disables exporter's addition _total suffixes on counters.
By default, metric names include a _total suffix to follow Prometheus naming conventions. For example, the counter metric happy.people would become happy_people_total. With this option set, the name would instead be happy_people.
func WithoutScopeInfo ¶ added in v0.34.0
func WithoutScopeInfo() Option
WithoutScopeInfo configures the Exporter to not export the otel_scope_info metric. If not specified, the Exporter will create a otel_scope_info metric containing the metrics' Instrumentation Scope, and also add labels about Instrumentation Scope to all metric points.
func WithoutTargetInfo ¶ added in v0.33.0
func WithoutTargetInfo() Option
WithoutTargetInfo configures the Exporter to not export the resource target_info metric. If not specified, the Exporter will create a target_info metric containing the metrics' resource.Resource attributes.
func WithoutUnits ¶ added in v0.33.0
func WithoutUnits() Option
WithoutUnits disables exporter's addition of unit suffixes to metric names, and will also prevent unit comments from being added in OpenMetrics once unit comments are supported.
By default, metric names include a unit suffix to follow Prometheus naming conventions. For example, the counter metric request.duration, with unit milliseconds would become request_duration_milliseconds_total. With this option set, the name would instead be request_duration_total.
Source Files