Weave Code
Correlation Ids Bundle Laravel Package
softwax/correlation-ids-bundle
A PHP/Symfony bundle that generates and propagates correlation IDs across requests, responses, and logs, making it easier to trace distributed transactions and debug issues end-to-end.
softwax/correlation-ids-bundle adds request-scoped correlation IDs to your PHP application so every log line, outbound HTTP call and background job can be traced back to the request that started it. A unique ID is generated at the edge—or adopted from an incoming header—and then propagated through the request lifecycle, giving you end-to-end visibility across services without editing every log statement.
- Automatic ID generation with fallback to an inbound
X-Correlation-IDheader - Propagation to logs, sub-requests and outgoing HTTP clients
- Monolog processor for zero-config log enrichment
- Configurable header name, ID generator and trusted sources
- Small, framework-agnostic core with drop-in integration
Frequently asked questions about Correlation Ids Bundle
- Is softwax/correlation-ids-bundle a Laravel package or a Symfony bundle?
- The name and -bundle suffix indicate this is a Symfony bundle, not a Laravel-native package. The available release information does not confirm a Laravel service provider, middleware registration, or config publish command. Laravel teams should treat it as Symfony-first and verify whether an adapter is required before planning integration work.
- How do I install softwax/correlation-ids-bundle with Composer?
- You would install it with composer require softwax/correlation-ids-bundle, but v0.1 is pre-1.0 so you may need to adjust minimum-stability or pin the exact version. In a Laravel application, expect to wire middleware and logging configuration manually unless the package explicitly ships Laravel support. Check the package composer.json for framework requirements before committing.
- Does softwax/correlation-ids-bundle support Laravel 10, 11, or 12?
- There is no documented Laravel version support matrix in the available release information. The package is identified as a Symfony bundle, so Laravel compatibility cannot be assumed. Review composer.json constraints and run a small spike before relying on it in a Laravel 10, 11, or 12 application.
- How does the bundle generate and propagate correlation IDs?
- Based on the package description, it accepts or generates a per-request correlation ID, attaches it to request context and log records, and propagates it through HTTP headers and Monolog. The release notes do not document exact header names, defaults, or configuration keys. You should confirm the supported ID format and header behaviour from the source before rollout.
- Are inbound correlation ID headers safe to trust?
- An inbound correlation ID header is attacker-controlled input and should not be trusted by default. Unvalidated IDs can enable log injection, unbounded log-field cardinality, and forged-trace pollution. Restrict acceptance to trusted upstream proxies with a strict format allowlist before using this package in production.
- Does softwax/correlation-ids-bundle work with Laravel Octane or long-lived workers?
- The available information does not confirm Octane or RoadRunner support. Correlation ID state must be reset per request in long-lived workers, or IDs can leak between requests. Test explicitly for cross-request leakage in Octane before adopting the package in a production Laravel application.
- How are correlation IDs propagated into queued jobs and outbound HTTP calls?
- Propagation into queued jobs and Laravel HTTP client calls is not documented in the provided release information. In most correlation ID designs this is left to the integrator, so you should plan explicit propagation for jobs and outbound requests. Verify whether the package resets or forwards the ID correctly across worker boundaries.
- What ID format does the bundle use — UUID, ULID, or a custom format?
- The release information mentions configurable settings but does not document the supported correlation ID format. Common choices are UUIDv4, UUIDv7, or ULID, and each has trade-offs for sortability and storage. Confirm the default format and whether it is configurable before mapping it to your observability platform.
- How does this compare with OpenTelemetry or Sentry trace IDs in Laravel?
- If OpenTelemetry, Sentry, or a service mesh already injects trace identifiers, this package may be redundant or create duplicate-ID hazards. Decide which identifier is canonical and whether the correlation ID should be mapped to the existing trace ID. The intended relationship to OpenTelemetry is not documented, so clarify it during your evaluation.
- Is softwax/correlation-ids-bundle production-ready and actively maintained?
- Version 0.1 is an initial public release with no changelog body, so there is little signal on scope, known limitations, or semver intent. There is also no visible evidence yet of CI, test coverage, or a support policy. Because the integration is additive and reversible, pilot it in one non-production service and then one production service before generalising.
Weaver
How can I help you explore Laravel packages today?