otelbeatfx

README

otelbeatfx

OpenTelemetry metrics for beat through Uber Fx. Requires Go 1.27 or later.

go get github.com/uchaloop/otelbeatfx@v0.1.0

Wiring

Input from DI	Output to DI
metric.MeterProvider	beat.Handler

Module() constructs the handler on the github.com/uchaloop/otelbeat instrumentation scope. It does not execute work, configure exporters, or install provider lifecycle hooks. Provide the interface metric.MeterProvider, rather than only its concrete SDK type.

Application wiring with a Runner provided by the service domain:

app := fx.New(
    fx.Provide(provideMeterProvider),
    fx.Supply(beatConfig),
    domain.Module(), // provides *job.Runner
    otelbeatfx.Module(),
    beatfx.Module(),
)
app.Run()

domain.Module() represents your application's domain module, which constructs and provides *job.Runner. beatConfig is a beat.Config value; the provider constructor is shown below. beatfx receives the Runner from DI and automatically attaches the handler supplied by otelbeatfx.

Neither jobfx nor oteljobfx is required for this setup. otelbeat reuses oteljob instrumentation internally; this does not require either Fx adapter. Do not add jobfx.Module() when the domain already provides *job.Runner, since that would register a second provider for the same type.

Environment configuration

Read telemetry identity from the standard OTel environment variables when the application constructs its MeterProvider. The adapters consume that provider; they do not read environment variables themselves. No separate configuration library is needed for these values.

Environment variable	Value
OTEL_SERVICE_NAME	Set to a stable service name, such as daemon-efiro.
OTEL_RESOURCE_ATTRIBUTES	Comma-separated key=value Resource attributes, as below.

Recommended attributes inside OTEL_RESOURCE_ATTRIBUTES:

Attribute	When to set it
deployment.environment.name	Local, staging or production environment.
service.instance.id	A unique identity for each concurrently running instance.
k8s.namespace.name	Kubernetes namespace; omit outside Kubernetes.
k8s.cluster.name	Kubernetes cluster name; omit outside Kubernetes.

These are application identity conventions, not required configuration fields of the handler. OTEL_SERVICE_NAME takes precedence over service.name inside OTEL_RESOURCE_ATTRIBUTES. Set identity before constructing the provider; changing the environment afterward does not refresh its Resource.

Local example (use a distinct instance ID for each concurrent process):

export OTEL_SERVICE_NAME=worker
export OTEL_RESOURCE_ATTRIBUTES='deployment.environment.name=local,service.instance.id=worker-local-1'

In Kubernetes, obtain the namespace (metadata.namespace) and Pod identity (metadata.uid) through the Downward API. Supply the service name, deployment environment and cluster name through your deployment configuration. To compose OTEL_RESOURCE_ATTRIBUTES from these values, follow Kubernetes' official guide to dependent environment variables.

resource.WithFromEnv() reads these values. It does not configure an exporter. Select a reader/exporter separately; exporter-specific environment variables (such as an OTLP endpoint) only apply when that exporter is constructed. Resource attributes also do not automatically become Prometheus labels: configure selected Resource-to-label promotion in your exporter or Collector and preserve distinct replica identity.

Provider lifecycle

A minimal provider constructor with an application-configured reader:

import (
    "context"

    "go.opentelemetry.io/otel/metric"
    "go.opentelemetry.io/otel/sdk/resource"
    sdkmetric "go.opentelemetry.io/otel/sdk/metric"
    "go.uber.org/fx"
)

func provideMeterProvider(lc fx.Lifecycle, reader sdkmetric.Reader) (metric.MeterProvider, error) {
    res, err := resource.New(context.Background(), resource.WithFromEnv())
    if err != nil {
        return nil, err
    }

    provider := sdkmetric.NewMeterProvider(
        sdkmetric.WithResource(res),
        sdkmetric.WithReader(reader),
    )
    lc.Append(fx.Hook{OnStop: provider.Shutdown})
    return provider, nil
}

Provide the reader as sdkmetric.Reader. Configure Resource, Views and the exporter in your application. Start dependencies before work and stop the app only after work and observation finish. Give shutdown a fresh, bounded context so canceled work does not prevent export. A ManualReader is useful for tests; it does not export metrics to a backend.

For short-lived jobs, choose a suitable delivery pipeline explicitly. This module does not publish Pushgateway snapshots or change the underlying metric semantics.

If another provider already supplies the same Handler interface, combine handlers in your application using named providers or MultiHandler instead of registering two unnamed providers for that interface.

Acknowledgements

Thanks to the authors and maintainers of Uber Fx and OpenTelemetry Go.

Documentation

Overview

Package otelbeatfx provides an OpenTelemetry beat.Handler through Uber Fx. The application owns the metric.MeterProvider, exporter and provider shutdown.

Index

• func Module() fx.Option

Examples

• Module

Functions

func Module

func Module() fx.Option

Module provides a beat.Handler using the container's metric.MeterProvider. It does not run work or configure the SDK, Resource, exporter or shutdown.

Example

package main

import (
	"context"
	"fmt"

	"github.com/uchaloop/beat"
	"github.com/uchaloop/otelbeatfx"
	"go.opentelemetry.io/otel/metric"

	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
	"go.opentelemetry.io/otel/sdk/resource"
	"go.uber.org/fx"
)

func main() {
	var observer beat.Handler
	app := fx.New(
		fx.Provide(func(lc fx.Lifecycle) (metric.MeterProvider, error) {
			// Read OTEL_SERVICE_NAME and OTEL_RESOURCE_ATTRIBUTES from the environment.
			res, err := resource.New(context.Background(), resource.WithFromEnv())
			if err != nil {
				return nil, err
			}
			// Configure an exporter-backed reader in the application.
			provider := sdkmetric.NewMeterProvider(sdkmetric.WithResource(res))
			lc.Append(fx.Hook{OnStop: provider.Shutdown})
			return provider, nil
		}),
		otelbeatfx.Module(),
		fx.Populate(&observer),
		fx.NopLogger,
	)
	if err := app.Start(context.Background()); err != nil {
		panic(err)
	}
	fmt.Println("handler available:", observer != nil)
	if err := app.Stop(context.Background()); err != nil {
		panic(err)
	}
}

Output:
handler available: true