internal

Documentation

Overview

Package internal contains common functionality for all OTLP exporters.

Package internal contains common functionality for all OTLP exporters.

Index

• func CleanPath(urlPath string, defaultPath string) string
• func GetUserAgentHeader() string
• func PartialSuccessToError(kind PartialSuccessDropKind, itemsRejected int64, errorMessage string) error
• type PartialSuccess
  • func (ps PartialSuccess) Error() string
  • func (ps PartialSuccess) Is(err error) bool
• type PartialSuccessDropKind

Functions

func CleanPath

func CleanPath(urlPath string, defaultPath string) string

CleanPath returns a path with all spaces trimmed and all redundancies removed. If urlPath is empty or cleaning it results in an empty string, defaultPath is returned instead.

func GetUserAgentHeader

func GetUserAgentHeader() string

GetUserAgentHeader return an OTLP header value form "OTel OTLP Exporter Go/{{ .Version }}" https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#user-agent

func PartialSuccessToError

func PartialSuccessToError(kind PartialSuccessDropKind, itemsRejected int64, errorMessage string) error

PartialSuccessToError produces an error suitable for passing to `otel.Handle()` out of the fields in a partial success response, independent of which signal produced the outcome.

Types

type PartialSuccess

type PartialSuccess struct {
	ErrorMessage  string
	RejectedItems int64
	RejectedKind  PartialSuccessDropKind
}

PartialSuccess represents the underlying error for all handling OTLP partial success messages. Use `errors.Is(err, PartialSuccess{})` to test whether an error passed to the OTel error handler belongs to this category.

func (PartialSuccess) Error

func (ps PartialSuccess) Error() string

Error implements the error interface.

func (PartialSuccess) Is

func (ps PartialSuccess) Is(err error) bool

Is supports the errors.Is() interface.

type PartialSuccessDropKind

type PartialSuccessDropKind string

PartialSuccessDropKind indicates the kind of partial success error received by an OTLP exporter, which corresponds with the signal being exported.

const (
	// TracingPartialSuccess indicates that some spans were rejected.
	TracingPartialSuccess PartialSuccessDropKind = "spans"

	// MetricsPartialSuccess indicates that some metric data points were rejected.
	MetricsPartialSuccess PartialSuccessDropKind = "metric data points"
)