observability

package

v0.1.21 Latest Latest Go to latest Published: Sep 29, 2025 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/minuk-dev/opampcommander

Links

Open Source Insights

Documentation ¶

Overview ¶

Package observability provides observability features for the application.

Index ¶

Constants
Variables
type Result
- func New(settings *config.ObservabilitySettings, lifecycle fx.Lifecycle) (Result, error)
type Service
- func (service *Service) Middleware() gin.HandlerFunc
type UnsupportedLogFormatError
- func (e *UnsupportedLogFormatError) Error() string

Constants ¶

View Source

const (
	// DefaultPrometheusReadTimeout is the default timeout for reading Prometheus metrics.
	DefaultPrometheusReadTimeout = 30 * time.Second

	// DefaultPrometheusReadHeaderTimeout is the default timeout for reading Prometheus headers.
	DefaultPrometheusReadHeaderTimeout = 10 * time.Second
)

Variables ¶

View Source

var (
	// ErrUnsupportedObservabilityType is returned when an unsupported observability type is specified.
	ErrUnsupportedObservabilityType = errors.New("unsupported observability type")

	// ErrNoImplementation is returned when no implementation is provided for the observability type.
	ErrNoImplementation = errors.New("no implementation provided for the observability type")

	// ErrInvalidPrometheusEndpoint is returned when the Prometheus endpoint is invalid.
	ErrInvalidPrometheusEndpoint = errors.New("invalid Prometheus endpoint URL")
)

View Source

var (
	// ErrUnsupportedCompressionAlgorithm is returned when an unsupported compression algorithm is specified.
	ErrUnsupportedCompressionAlgorithm = errors.New("unsupported compression algorithm")
	// ErrUnsupportedProtocol is returned when an unsupported trace protocol is specified.
	ErrUnsupportedProtocol = errors.New("unsupported trace protocol")
	// ErrInvalidTraceSampler is returned when an invalid trace sampler is specified.
	ErrInvalidTraceSampler = errors.New("invalid trace sampler")
)

Functions ¶

This section is empty.

Types ¶

type Result ¶ added in v0.1.21

type Result struct {
	fx.Out

	Service           *Service
	MeterProvider     metricapi.MeterProvider
	TracerProvider    traceapi.TracerProvider
	Logger            *slog.Logger
	TextMapPropagator propagation.TextMapPropagator
}

Result is the result type returned by the New function.

func New ¶ added in v0.1.9

func New(
	settings *config.ObservabilitySettings,
	lifecycle fx.Lifecycle,
) (Result, error)

New creates a new observability Service based on the provided settings. It provides observability service and its fields such as meter provider, trace provider, and logger for easy access.

type Service ¶ added in v0.1.9

type Service struct {
	// contains filtered or unexported fields
}

Service provides observability features such as metrics and tracing.

func (*Service) Middleware ¶ added in v0.1.9

func (service *Service) Middleware() gin.HandlerFunc

Middleware returns a Gin middleware function that applies OpenTelemetry instrumentation.

type UnsupportedLogFormatError ¶ added in v0.1.20

type UnsupportedLogFormatError struct {
	LogFormat config.LogFormat
}

UnsupportedLogFormatError is an error type that indicates an unsupported log format. It contains the unsupported log format.

func (*UnsupportedLogFormatError) Error ¶ added in v0.1.20

func (e *UnsupportedLogFormatError) Error() string

Error implements the error interface for UnsupportedLogFormatError.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL