eonx-com/easy-request-id

Uniquely identify each request across multiple projects

5.10.2 2024-04-05 14:51 UTC

Requires

• php: ^8.1
• eonx-com/easy-random: ^5.10.2
• eonx-com/easy-utils: ^5.10.2

Requires (Dev)

• laravel/lumen-framework: ^9.1
• phpunit/phpunit: ^10.2
• symfony/framework-bundle: ^6.3
• symfony/uid: ^6.3
• symfony/yaml: ^6.3

MIT

README

---eonx_docs--- title: Introduction weight: 0 ---eonx_docs---

Microservices infrastructures are common, one request can involve N different applications sending requests to each other, and it can be hard to link events occurring across them. This package objective is to create a standard way in PHP projects to resolve/share IDs across projects so linking requests becomes easier!

It is based on 2 different IDs:

• request_id: ID of request specific to each project
• correlation_id: shared ID across projects for the same initial request

On the top of resolving those IDs for you, this package also comes with bridges to different packages to automatically include those IDs in your:

• bugsnag notifications: using EasyBugsnag
• error responses: using EasyErrorHandler
• logs: using EasyLogging
• webhooks: using EasyWebhook

Dependencies

This package has dependencies on the following packages, please see their documentation directly:

• EasyRandom

Require package (Composer)

The recommended way to install this package is to use Composer:

$ composer require eonx-com/easy-request-id

Usage

This package is based on a single service providing the requestId and correlationId anywhere you need them:

// src/Controller/MyController.php

namespace App\Controller;

use EonX\EasyRequestId\Interfaces\RequestIdServiceInterface;

final class MyController
{
    /**
     * @var \EonX\EasyRequestId\Interfaces\RequestIdServiceInterface
     */
    private $requestIdService;

    public function __construct(RequestIdServiceInterface $requestIdService)
    {
        $this->requestIdService = $requestIdService; 
    }

    public function __invoke()
    {
        $requestId = $this->requestIdService->getRequestId();
        $correlationId = $this->requestIdService->getCorrelationId();

        // Use the IDs in your logic...
    }
}