feat(logger,tracing): share OTel resource for logs and traces
Factor the resource detector list into internal/otlpresource so the logger's OTLP provider and the trace provider describe the same process with the same attributes. OTLP log records now carry the full resource (process.pid, service.name, service.version, host.*, os.*, etc.) instead of no resource attributes at all.
This commit is contained in:
52
internal/otlpresource/resource.go
Normal file
52
internal/otlpresource/resource.go
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
// Package otlpresource builds the OpenTelemetry resource shared between the
|
||||||
|
// tracing and logger packages so spans, metrics, and logs describe the same
|
||||||
|
// process with the same attributes (service.name, process.pid, host.*, etc.).
|
||||||
|
// Keep the detector list in sync across signals.
|
||||||
|
package otlpresource
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
|
||||||
|
"go.opentelemetry.io/otel/attribute"
|
||||||
|
"go.opentelemetry.io/otel/sdk/resource"
|
||||||
|
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Options carries optional attributes that only some callers supply.
|
||||||
|
// Zero values are skipped.
|
||||||
|
type Options struct {
|
||||||
|
ServiceVersion string // added as semconv.ServiceVersionKey
|
||||||
|
Environment string // added as attribute "environment"
|
||||||
|
}
|
||||||
|
|
||||||
|
// New builds the shared OTel resource. Non-fatal partial/schema errors are
|
||||||
|
// logged via the provided slog logger and a usable resource is still returned.
|
||||||
|
func New(ctx context.Context, log *slog.Logger, opts Options) (*resource.Resource, error) {
|
||||||
|
detectors := []resource.Option{
|
||||||
|
resource.WithFromEnv(), // OTEL_SERVICE_NAME / OTEL_RESOURCE_ATTRIBUTES
|
||||||
|
resource.WithTelemetrySDK(), // telemetry.sdk.*
|
||||||
|
resource.WithProcess(), // process.pid + process.executable.* + process.runtime.*
|
||||||
|
resource.WithOS(),
|
||||||
|
resource.WithContainer(),
|
||||||
|
resource.WithHost(),
|
||||||
|
}
|
||||||
|
if opts.ServiceVersion != "" {
|
||||||
|
detectors = append(detectors,
|
||||||
|
resource.WithAttributes(semconv.ServiceVersionKey.String(opts.ServiceVersion)))
|
||||||
|
}
|
||||||
|
if opts.Environment != "" {
|
||||||
|
detectors = append(detectors,
|
||||||
|
resource.WithAttributes(attribute.String("environment", opts.Environment)))
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := resource.New(ctx, detectors...)
|
||||||
|
if errors.Is(err, resource.ErrPartialResource) || errors.Is(err, resource.ErrSchemaURLConflict) {
|
||||||
|
if log != nil {
|
||||||
|
log.Warn("otel resource setup", "err", err)
|
||||||
|
}
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
return res, err
|
||||||
|
}
|
||||||
@@ -36,6 +36,8 @@ import (
|
|||||||
|
|
||||||
slogtraceid "github.com/remychantenay/slog-otel"
|
slogtraceid "github.com/remychantenay/slog-otel"
|
||||||
slogmulti "github.com/samber/slog-multi"
|
slogmulti "github.com/samber/slog-multi"
|
||||||
|
"go.ntppool.org/common/internal/otlpresource"
|
||||||
|
"go.ntppool.org/common/version"
|
||||||
"go.opentelemetry.io/contrib/bridges/otelslog"
|
"go.opentelemetry.io/contrib/bridges/otelslog"
|
||||||
"go.opentelemetry.io/otel/log/global"
|
"go.opentelemetry.io/otel/log/global"
|
||||||
otellog "go.opentelemetry.io/otel/sdk/log"
|
otellog "go.opentelemetry.io/otel/sdk/log"
|
||||||
@@ -167,9 +169,18 @@ func setupOtlpLogger() *slog.Logger {
|
|||||||
otellog.WithExportMaxBatchSize(512),
|
otellog.WithExportMaxBatchSize(512),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Build the shared OTel resource (process.pid, host.*, service.name
|
||||||
|
// from OTEL_SERVICE_NAME, service.version, etc.). Environment is only
|
||||||
|
// known to the tracing package and is intentionally omitted here; see
|
||||||
|
// common/internal/otlpresource.
|
||||||
|
res, _ := otlpresource.New(context.Background(), Setup(), otlpresource.Options{
|
||||||
|
ServiceVersion: version.Version(),
|
||||||
|
})
|
||||||
|
|
||||||
// Create logger provider
|
// Create logger provider
|
||||||
provider := otellog.NewLoggerProvider(
|
provider := otellog.NewLoggerProvider(
|
||||||
otellog.WithProcessor(processor),
|
otellog.WithProcessor(processor),
|
||||||
|
otellog.WithResource(res),
|
||||||
)
|
)
|
||||||
|
|
||||||
// Set global provider
|
// Set global provider
|
||||||
|
|||||||
@@ -45,19 +45,18 @@ import (
|
|||||||
"slices"
|
"slices"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"go.ntppool.org/common/internal/otlpresource"
|
||||||
"go.ntppool.org/common/internal/tracerconfig"
|
"go.ntppool.org/common/internal/tracerconfig"
|
||||||
"go.ntppool.org/common/version"
|
"go.ntppool.org/common/version"
|
||||||
|
|
||||||
"go.opentelemetry.io/contrib/exporters/autoexport"
|
"go.opentelemetry.io/contrib/exporters/autoexport"
|
||||||
"go.opentelemetry.io/otel"
|
"go.opentelemetry.io/otel"
|
||||||
"go.opentelemetry.io/otel/attribute"
|
|
||||||
"go.opentelemetry.io/otel/log/global"
|
"go.opentelemetry.io/otel/log/global"
|
||||||
"go.opentelemetry.io/otel/propagation"
|
"go.opentelemetry.io/otel/propagation"
|
||||||
sdklog "go.opentelemetry.io/otel/sdk/log"
|
sdklog "go.opentelemetry.io/otel/sdk/log"
|
||||||
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
|
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
|
||||||
"go.opentelemetry.io/otel/sdk/resource"
|
"go.opentelemetry.io/otel/sdk/resource"
|
||||||
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
||||||
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
|
|
||||||
"go.opentelemetry.io/otel/trace"
|
"go.opentelemetry.io/otel/trace"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -177,33 +176,15 @@ func SetupSDK(ctx context.Context, cfg *TracerConfig) (shutdown TpShutdownFunc,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
resources := []resource.Option{
|
// Build the shared OTel resource. Kept in sync between traces, metrics,
|
||||||
resource.WithFromEnv(), // Discover and provide attributes from OTEL_RESOURCE_ATTRIBUTES and OTEL_SERVICE_NAME environment variables.
|
// and logs via common/internal/otlpresource — update the detector list
|
||||||
resource.WithTelemetrySDK(), // Discover and provide information about the OpenTelemetry SDK used.
|
// there, not here. service.name is supplied via OTEL_SERVICE_NAME (set
|
||||||
resource.WithProcess(), // Discover and provide process information.
|
// above when cfg.ServiceName is provided).
|
||||||
resource.WithOS(), // Discover and provide OS information.
|
res, err := otlpresource.New(ctx, log, otlpresource.Options{
|
||||||
resource.WithContainer(), // Discover and provide container information.
|
ServiceVersion: version.Version(),
|
||||||
resource.WithHost(), // Discover and provide host information.
|
Environment: cfg.Environment,
|
||||||
|
})
|
||||||
// set above via os.Setenv() for WithFromEnv to find
|
if err != nil {
|
||||||
// resource.WithAttributes(semconv.ServiceNameKey.String(cfg.ServiceName)),
|
|
||||||
|
|
||||||
resource.WithAttributes(semconv.ServiceVersionKey.String(version.Version())),
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(cfg.Environment) > 0 {
|
|
||||||
resources = append(resources,
|
|
||||||
resource.WithAttributes(attribute.String("environment", cfg.Environment)),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
res, err := resource.New(
|
|
||||||
context.Background(),
|
|
||||||
resources...,
|
|
||||||
)
|
|
||||||
if errors.Is(err, resource.ErrPartialResource) || errors.Is(err, resource.ErrSchemaURLConflict) {
|
|
||||||
log.Warn("otel resource setup", "err", err) // Log non-fatal issues.
|
|
||||||
} else if err != nil {
|
|
||||||
log.Error("otel resource setup", "err", err)
|
log.Error("otel resource setup", "err", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user