otel

package

v0.0.7 Latest Latest Go to latest Published: Mar 3, 2026 License: MIT Imports: 19 Imported by: 0

Details

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

Repository

github.com/kernel/hypeman

Links

Open Source Insights

README ¶

OpenTelemetry

Provides OpenTelemetry initialization and metric definitions for Hypeman.

Features

OTLP export for traces, metrics, and logs (gRPC)
Runtime metrics (Go GC, goroutines, memory)
Application-specific metrics per subsystem
Log bridging from slog to OTel (viewable in Grafana/Loki)
Graceful degradation (failures don't crash the app)

Configuration

Variable	Description	Default
`ENV`	Deployment environment (`deployment.environment` attribute)	`unset`
`OTEL_ENABLED`	Enable OpenTelemetry	`false`
`OTEL_ENDPOINT`	OTLP endpoint (gRPC)	`127.0.0.1:4317`
`OTEL_SERVICE_NAME`	Service name	`hypeman`
`OTEL_SERVICE_INSTANCE_ID`	Instance ID (`service.instance.id` attribute)	hostname
`OTEL_INSECURE`	Disable TLS for OTLP	`true`

Metrics

System

Metric	Type	Description
`hypeman_uptime_seconds`	gauge	Process uptime
`hypeman_info`	gauge	Build info (version, go_version labels)

HTTP

Metric	Type	Labels	Description
`hypeman_http_requests_total`	counter	method, path, status	Total HTTP requests
`hypeman_http_request_duration_seconds`	histogram	method, path, status	Request latency

Images

Metric	Type	Labels	Description
`hypeman_images_build_queue_length`	gauge		Current build queue size
`hypeman_images_build_duration_seconds`	histogram	status	Image build time
`hypeman_images_total`	gauge	status	Cached images count
`hypeman_images_pulls_total`	counter	status	Registry pulls

Instances

Metric	Type	Labels	Description
`hypeman_instances_total`	gauge	state	Instances by state
`hypeman_instances_create_duration_seconds`	histogram	status	Create time
`hypeman_instances_restore_duration_seconds`	histogram	status	Restore time
`hypeman_instances_standby_duration_seconds`	histogram	status	Standby time
`hypeman_instances_state_transitions_total`	counter	from, to	State transitions

Network

Metric	Type	Labels	Description
`hypeman_network_allocations_total`	gauge		Active IP allocations
`hypeman_network_tap_operations_total`	counter	operation	TAP create/delete ops

Volumes

Metric	Type	Description
`hypeman_volumes_total`	gauge	Volume count
`hypeman_volumes_allocated_bytes`	gauge	Total provisioned size
`hypeman_volumes_used_bytes`	gauge	Actual disk space consumed
`hypeman_volumes_create_duration_seconds`	histogram	Creation time

VMM

Metric	Type	Labels	Description
`hypeman_vmm_api_duration_seconds`	histogram	operation, status	CH API latency
`hypeman_vmm_api_errors_total`	counter	operation	CH API errors

Exec

Metric	Type	Labels	Description
`hypeman_exec_sessions_total`	counter	status, exit_code	Exec sessions
`hypeman_exec_duration_seconds`	histogram	status	Command duration
`hypeman_exec_bytes_sent_total`	counter		Bytes to guest (stdin)
`hypeman_exec_bytes_received_total`	counter		Bytes from guest (stdout+stderr)

Usage

provider, shutdown, err := otel.Init(ctx, otel.Config{
    Enabled:     true,
    Endpoint:    "localhost:4317",
    ServiceName: "hypeman",
})
defer shutdown(ctx)

meter := provider.Meter       // Use for creating metrics
tracer := provider.Tracer     // Use for creating traces
logHandler := provider.LogHandler // Use with slog for logs to OTel

Logs

Logs are exported via the OTel log bridge (otelslog). When OTel is enabled, all slog logs are sent to Loki (via OTLP) and include:

subsystem attribute (API, IMAGES, INSTANCES, etc.)
trace_id and span_id when available
Service attributes (name, instance, environment)

Documentation ¶

Overview ¶

Package otel provides OpenTelemetry initialization and configuration.

Index ¶

func GetGlobalLogHandler() slog.Handler
func GoVersion() string
func SetGlobalLogHandler(h slog.Handler)
type Config
type Provider
- func Init(ctx context.Context, cfg Config) (*Provider, func(context.Context) error, error)
- func (p *Provider) MeterFor(subsystem string) metric.Meter
- func (p *Provider) TracerFor(subsystem string) trace.Tracer

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetGlobalLogHandler ¶

func GetGlobalLogHandler() slog.Handler

GetGlobalLogHandler returns the global OTel log handler.

func GoVersion ¶

func GoVersion() string

GoVersion returns the Go version used to build the binary.

func SetGlobalLogHandler ¶

func SetGlobalLogHandler(h slog.Handler)

SetGlobalLogHandler sets the global OTel log handler.

Types ¶

type Config ¶

type Config struct {
	Enabled           bool
	Endpoint          string
	ServiceName       string
	ServiceInstanceID string
	Insecure          bool
	Version           string
	Env               string
}

Config holds OpenTelemetry configuration.

type Provider ¶

type Provider struct {
	TracerProvider *sdktrace.TracerProvider
	MeterProvider  *sdkmetric.MeterProvider
	LoggerProvider *sdklog.LoggerProvider
	Tracer         trace.Tracer
	Meter          metric.Meter
	LogHandler     slog.Handler
	// contains filtered or unexported fields
}

Provider holds initialized OTel providers.

func Init ¶

func Init(ctx context.Context, cfg Config) (*Provider, func(context.Context) error, error)

Init initializes OpenTelemetry with the given configuration. Returns a shutdown function that should be called on application exit. If OTel is disabled, returns a no-op shutdown function.

func (*Provider) MeterFor ¶

func (p *Provider) MeterFor(subsystem string) metric.Meter

Meter returns a meter for the given subsystem.

func (*Provider) TracerFor ¶

func (p *Provider) TracerFor(subsystem string) trace.Tracer

Tracer returns a tracer for the given subsystem.

Source Files ¶

View all Source files

otel.go

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