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 MetricPartialSuccessError(itemsRejected int64, errorMessage string) error
• func TracePartialSuccessError(itemsRejected int64, errorMessage string) error
• func WrapTracesError(err error) error
• type ErrorKind
• type PartialSuccess
  • func (ps PartialSuccess) Error() string
  • func (ps PartialSuccess) Is(err error) bool

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 MetricPartialSuccessError

func MetricPartialSuccessError(itemsRejected int64, errorMessage string) error

MetricPartialSuccessError returns an error describing a partial success response for the metric signal.

func TracePartialSuccessError

func TracePartialSuccessError(itemsRejected int64, errorMessage string) error

TracePartialSuccessError returns an error describing a partial success response for the trace signal.

func WrapTracesError

func WrapTracesError(err error) error

WrapTracesError wraps an error from the OTLP exporter for traces.

Types

type ErrorKind

type ErrorKind int

ErrorKind is used to identify the kind of export error being wrapped.

const (
	// TracesExport indicates the error comes from the OTLP trace exporter.
	TracesExport ErrorKind = iota
)

type PartialSuccess

type PartialSuccess struct {
	ErrorMessage  string
	RejectedItems int64
	RejectedKind  string
}

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.