Skip to content

v0.7.0

Choose a tag to compare

@deavgprime deavgprime released this 16 Nov 07:21
· 15 commits to main since this release

Safe defaults: a client can no longer choose trace IDs or learn from responses that an error was logged, and a notifier no longer starts unauthenticated by accident. Breaking: internal services that rely on forwarded request IDs or flush markers must opt in, and StartNotifier needs a signing option; see the migration note below.

Modules released: core v0.7.0, grpcflightrec/v0.4.0, notifier/redisnotifier/v0.4.0 and notifier/natsnotifier/v0.4.0 (each requiring core v0.7.0). otelflightrec is unchanged at v0.3.1.

Changed

  • Safe defaults. Each was an opt-out before; services that only your own services call opt back in:

    • Request headers and gRPC metadata (traceparent, X-Trace-Id, X-Request-Id) no longer choose trace IDs. Set Options.TrustRequestTraceIDs.
    • Triggered scopes no longer mark responses with Flightrec-Flush (gRPC: a trailer). Set Options.EnableFlushMarker.
    • StartNotifier panics without WithSigningKey. Pass WithoutSigning() for a channel that only trusted processes can publish on.

    Migration: add TrustRequestTraceIDs: true, EnableFlushMarker: true to the Options of internal services that use cross-service flush or forward request IDs, and pass WithSigningKey(key) (the same key in every service) or WithoutSigning() to StartNotifier. Without the opt-ins, a custom GRPCMetadataExtractor is not called, and the notifier and callers match requests only by an OpenTelemetry trace ID, never by a forwarded X-Request-Id. Without a signing option, StartNotifier panics at startup. Public-facing services that set IgnoreRequestTraceIDs and DisableFlushMarker need no change.

Added

  • Options.TrustRequestTraceIDs, Options.EnableFlushMarker and the WithoutSigning notifier option.

Deprecated

  • Options.IgnoreRequestTraceIDs and Options.DisableFlushMarker: they are the default now. They still override the new options.

Security

  • CI runs OpenSSF Scorecard and every fuzz target on each change, and CodeQL scans Go and the workflows.