internal

Documentation

Overview

Package internal defines the PluginOption interface.

Index

• Variables
• type PluginOption

Variables

var SetPluginOption any // func(*Options, PluginOption)

SetPluginOption sets the plugin option on Options.

Types

type PluginOption

type PluginOption interface {
	// GetMetadata creates a MD with metadata exchange labels.
	GetMetadata() metadata.MD
	// GetLabels emits labels to be attached to metrics for the RPC that
	// contains the provided incomingMetadata.
	GetLabels(incomingMetadata metadata.MD) map[string]string
}

PluginOption is the interface which represents a plugin option for the OpenTelemetry instrumentation component. This plugin option emits labels from metadata and also creates metadata containing labels. These labels are intended to be added to applicable OpenTelemetry metrics recorded in the OpenTelemetry instrumentation component.

In the future, we hope to stabilize and expose this API to allow plugins to inject labels of their choosing into metrics recorded.