Documentation
¶
Overview ¶
Package observability provides observability features for the application.
Index ¶
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") )
Functions ¶
This section is empty.
Types ¶
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 New ¶ added in v0.1.9
func New( settings *config.ObservabilitySettings, lifecycle fx.Lifecycle, logger *slog.Logger, ) (*Service, error)
New creates a new observability Service based on the provided settings.
func (*Service) Middleware ¶ added in v0.1.9
func (service *Service) Middleware() gin.HandlerFunc
Middleware returns a Gin middleware function that applies OpenTelemetry instrumentation.
Source Files
Click to show internal directories.
Click to hide internal directories.