https://github.com/phauthentic/correlation-id-symfony-bundle

A correlation ID integration for Symfony apps
https://github.com/phauthentic/correlation-id-symfony-bundle

correlation-id microservices php php8 symfony symfony-bundle traceability

Last synced: about 1 month ago
JSON representation

A correlation ID integration for Symfony apps

• Host: GitHub
• URL: https://github.com/phauthentic/correlation-id-symfony-bundle
• Owner: Phauthentic
• License: mit
• Created: 2024-03-27T13:38:17.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-04-01T22:17:38.000Z (8 months ago)
• Last Synced: 2024-09-30T16:20:11.765Z (about 2 months ago)
• Topics: correlation-id, microservices, php, php8, symfony, symfony-bundle, traceability
• Language: PHP
• Homepage:
• Size: 35.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Correlation ID Symfony Bundle

![PHP >= 8.1](https://img.shields.io/static/v1?label=PHP&message=^8.1&color=787CB5&style=for-the-badge&logo=php)

![phpstan Level 8](https://img.shields.io/static/v1?label=phpstan&message=Level%208&color=%3CCOLOR%3E&style=for-the-badge)

![License: MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=%3CCOLOR%3E&style=for-the-badge)

[![Code Quality](https://img.shields.io/scrutinizer/g/Phauthentic/correlation-id-symfony-bundle/master.svg?style=for-the-badge)](https://scrutinizer-ci.com/g/Phauthentic/correlation-id-symfony-bundle/)

This is a Symfony bridge for the framework agnostic [Correlation ID library](https://github.com/Phauthentic/correlation-id).

## Features

* Adds the Correlation ID to the Request and Response automatically.

  * Header names can be configured for each separately.

* Provides a messenger stamp and middleware, that will add the CorrelationIDStamp to each message.

## Installation

```sh

composer require phauthentic/correlation-id-symfony-bundle

```

## Configuration

You can configure three different settings to control the behavior:

* `response_header_name` - The name of the response header for the ID.

* `request_header_name` - The name of the request header for the ID.

* `pass_through` - If the ID from the request should be passed to the response enable this. This is useful if you are dealing with a microservice that is not exposed to the public but gets further actions delegated from the entry point and must retain the original ID.

`config/correlation_id.yaml`:

```yaml

correlation_id:

    response_header_name: 'X-Correlation-ID'

    request_header_name: 'X-Correlation-ID'

    pass_through: false

```

## Messenger Middleware

The messenger middleware will add the Correlation ID to your messages. Just add the middleware to your bus.

## Copyright & License

Licensed under the [MIT license](LICENSE).

Copyright (c) [Phauthentic](https://github.com/Phauthentic) / Florian Krämer