observability

Documentation

Overview

Package observability provides an EnginePlugin that contributes all observability-related module types: metrics collector, health checker, log collector, OpenTelemetry tracing, OpenAPI generator/consumer, and distributed trace propagation.

Index

• type ObservabilityPlugin
  • func New() *ObservabilityPlugin
  • func (p *ObservabilityPlugin) Capabilities() []capability.Contract
  • func (p *ObservabilityPlugin) ModuleFactories() map[string]plugin.ModuleFactory
  • func (p *ObservabilityPlugin) ModuleSchemas() []*schema.ModuleSchema
  • func (p *ObservabilityPlugin) StepFactories() map[string]plugin.StepFactory
  • func (p *ObservabilityPlugin) WiringHooks() []plugin.WiringHook

Types

type ObservabilityPlugin

type ObservabilityPlugin struct {
	plugin.BaseEnginePlugin
}

ObservabilityPlugin provides metrics, health checking, log collection, distributed tracing (OpenTelemetry), and OpenAPI spec generation/consumption.

func New

func New() *ObservabilityPlugin

New creates a new ObservabilityPlugin.

func (*ObservabilityPlugin) Capabilities

func (p *ObservabilityPlugin) Capabilities() []capability.Contract

Capabilities returns the capability contracts this plugin defines.

func (*ObservabilityPlugin) ModuleFactories

func (p *ObservabilityPlugin) ModuleFactories() map[string]plugin.ModuleFactory

ModuleFactories returns factories for all observability module types.

func (*ObservabilityPlugin) ModuleSchemas

func (p *ObservabilityPlugin) ModuleSchemas() []*schema.ModuleSchema

ModuleSchemas returns the UI schema definitions for observability module types.

func (*ObservabilityPlugin) StepFactories

func (p *ObservabilityPlugin) StepFactories() map[string]plugin.StepFactory

StepFactories returns the tracing pipeline step factories.

func (*ObservabilityPlugin) WiringHooks

func (p *ObservabilityPlugin) WiringHooks() []plugin.WiringHook

WiringHooks returns post-init wiring functions that connect observability modules to the HTTP router.