Rename package to dragon-code/request-tracker

Author: andrey-helldar

README.md

@@ -1,66 +1,66 @@
-# 🪢 Telemetry
+# 🪢 Request Tracker
 
-![the dragon code telemetry](https://preview.dragon-code.pro/the%20dragon%20code/telemetry.svg?brand=php&mode=auto)
+![the dragon code request-tracker](https://preview.dragon-code.pro/the%20dragon%20code/request-tracker.svg?brand=php&mode=auto)
 
 [![Stable Version][badge_stable]][link_packagist]
 [![Total Downloads][badge_downloads]][link_packagist]
 [![License][badge_license]][link_license]
 
-End-to-end telemetry of inter-service communication.
+Request tracking across microservices.
 
 ## Installation
 
-You can install the **Telemetry** package via [Composer](https://getcomposer.org):
+You can install the **Request Tracker** package via [Composer](https://getcomposer.org):
 
 ```Bash
-composer require dragon-code/telemetry
+composer require dragon-code/request-tracker
 ```
 
 ## Basic Usage
 
 ### Using Default Header Names
 
 ```php
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 use Symfony\Component\HttpFoundation\Request;
 
 /** @var Request $request */
 $request = /* ... */;
 
-$telemetry = new TelemetryRequest($request, new TelemetryHeader);
+$tracker = new TrackerRequest($request, new TrackerHeader);
 
-function telemetry(Request $request, ?int $userId = null): Request
+function tracker(Request $request, ?int $userId = null): Request
 {
-    return (new TelemetryRequest($request, new TelemetryHeader))
+    return (new TrackerRequest($request, new TrackerHeader))
         ->userId($userId)
         ->ip()
         ->traceId()
         ->getRequest();
 }
 
 // For the first call
-telemetry($request, $user->id);
+tracker($request, $user->id);
 
 // For subsequent services
-telemetry($request);
+tracker($request);
 ```
 
 ### Custom Headers
 
 ```php
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 use Symfony\Component\HttpFoundation\Request;
 
 /** @var Request $request */
 $request = /* ... */;
 
-$telemetry = new TelemetryRequest($request, new TelemetryHeader);
+$tracker = new TrackerRequest($request, new TrackerHeader);
 
-function telemetry(Request $request, ?int $userId = null): Request
+function tracker(Request $request, ?int $userId = null): Request
 {
-    return (new TelemetryRequest($request, new TelemetryHeader))
+    return (new TrackerRequest($request, new TrackerHeader))
         ->userId($userId)
         ->ip()
         ->traceId()
@@ -70,25 +70,25 @@ function telemetry(Request $request, ?int $userId = null): Request
 ```
 
 ```php
-$item = telemetry($request);
+$item = tracker($request);
 
 return $item->headers->get('Some-Header'); // 1234
 ```
 
 ```php
 $request->headers->set('Some-Header', 'qwerty');
 
-$item = telemetry($request);
+$item = tracker($request);
 
 return $item->headers->get('Some-Header'); // qwerty
 ```
 
 ### Custom Header Names
 
 ```php
-use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\RequestTracker\TrackerHeader;
 
-return new TelemetryHeader(
+return new TrackerHeader(
     userId: 'Some-User-Id',
     ip: 'Some-IP',
     traceId: 'Some-Trace-Id',
@@ -100,12 +100,12 @@ return new TelemetryHeader(
 This package is licensed under the [MIT License](LICENSE).
 
 
-[badge_downloads]:      https://img.shields.io/packagist/dt/dragon-code/telemetry.svg?style=flat-square
+[badge_downloads]:      https://img.shields.io/packagist/dt/dragon-code/request-tracker.svg?style=flat-square
 
-[badge_license]:        https://img.shields.io/packagist/l/dragon-code/telemetry.svg?style=flat-square
+[badge_license]:        https://img.shields.io/packagist/l/dragon-code/request-tracker.svg?style=flat-square
 
-[badge_stable]:         https://img.shields.io/github/v/release/TheDragonCode/telemetry?label=packagist&style=flat-square
+[badge_stable]:         https://img.shields.io/github/v/release/TheDragonCode/request-tracker?label=packagist&style=flat-square
 
 [link_license]:         LICENSE
 
-[link_packagist]:       https://packagist.org/packages/dragon-code/telemetry
+[link_packagist]:       https://packagist.org/packages/dragon-code/request-tracker

composer.json

@@ -1,6 +1,6 @@
 {
-    "name": "dragon-code/telemetry",
-    "description": "End-to-end telemetry of inter-service communication",
+    "name": "dragon-code/request-tracker",
+    "description": "Request tracking across microservices",
     "license": "MIT",
     "type": "library",
     "authors": [
@@ -23,7 +23,7 @@
     "minimum-stability": "stable",
     "autoload": {
         "psr-4": {
-            "DragonCode\\Telemetry\\": "src/"
+            "DragonCode\\RequestTracker\\": "src/"
         }
     },
     "autoload-dev": {

src/TelemetryHeader.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\RequestTracker;
+
+readonly class TrackerHeader
+{
+    public function __construct(
+        public string $userId = 'X-Tracker-User-Id',
+        public string $ip = 'X-Tracker-Ip',
+        public string $traceId = 'X-Tracker-Trace-Id',
+    ) {}
+}

src/TrackerHeader.php

@@ -2,19 +2,19 @@
 
 declare(strict_types=1);
 
-namespace DragonCode\Telemetry;
+namespace DragonCode\RequestTracker;
 
 use Closure;
 use Ramsey\Uuid\UuidFactory;
 use Symfony\Component\HttpFoundation\Request;
 
 use function is_int;
 
-class TelemetryRequest
+class TrackerRequest
 {
     public function __construct(
         protected Request $request,
-        protected TelemetryHeader $header,
+        protected TrackerHeader $header,
     ) {}
 
     public function userId(int|string|null $id): static

src/TelemetryRequest.php src/TrackerRequest.phpsrc/TelemetryRequest.php renamed to src/TrackerRequest.php

@@ -2,18 +2,18 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
+use DragonCode\RequestTracker\TrackerHeader;
 
 it('uses default header names', function () {
-    $header = new TelemetryHeader;
+    $header = new TrackerHeader;
 
-    expect($header->userId)->toBe('X-Telemetry-User-Id')
-        ->and($header->ip)->toBe('X-Telemetry-Ip')
-        ->and($header->traceId)->toBe('X-Telemetry-Trace-Id');
+    expect($header->userId)->toBe('X-Tracker-User-Id')
+        ->and($header->ip)->toBe('X-Tracker-Ip')
+        ->and($header->traceId)->toBe('X-Tracker-Trace-Id');
 });
 
 it('accepts custom header names', function () {
-    $header = new TelemetryHeader(
+    $header = new TrackerHeader(
         userId : 'Some-User-Id',
         ip     : 'Some-IP',
         traceId: 'Some-Trace-Id',

tests/Unit/HeaderTest.php

@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 use Symfony\Component\HttpFoundation\Request;
 
 it('sets header from callback when header is absent and casts ints to strings', function () {
     $headerName = 'Some-Header';
 
     $request   = makeRequest();
-    $header    = new TelemetryHeader;
-    $telemetry = new TelemetryRequest($request, $header);
+    $header    = new TrackerHeader;
+    $telemetry = new TrackerRequest($request, $header);
 
     $telemetry->custom($headerName, function (Request $req) {
         expect($req)->toBeInstanceOf(Request::class);
@@ -28,8 +28,8 @@
     $request = makeRequest([$headerName => 'qwerty']);
 
     $called    = false;
-    $header    = new TelemetryHeader;
-    $telemetry = new TelemetryRequest($request, $header);
+    $header    = new TrackerHeader;
+    $telemetry = new TrackerRequest($request, $header);
 
     $telemetry->custom($headerName, function () use (&$called) {
         $called = true; // must remain false if existing header is used

tests/Unit/Request/CustomTest.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 
 it('returns the same Request instance via getRequest()', function () {
-    $header    = new TelemetryHeader;
+    $header    = new TrackerHeader;
     $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
 
     expect($telemetry->getRequest())->toBe($request);
 });

tests/Unit/Request/GetRequestTest.php

@@ -2,26 +2,26 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 
 it('gets ip with correct precedence and sets header via ip()', function () {
-    $header = new TelemetryHeader;
+    $header = new TrackerHeader;
 
     // 1) If telemetry header exists, it wins
     $request   = makeRequest([$header->ip => '203.0.113.10']);
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
     expect($telemetry->getIp())->toBe('203.0.113.10');
 
     // 2) Else HTTP_X_REAL_IP (non-standard header name checked by the class)
     $request = makeRequest();
     $request->headers->set('HTTP_X_REAL_IP', '198.51.100.20');
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
     expect($telemetry->getIp())->toBe('198.51.100.20');
 
     // 3) Else client ip (REMOTE_ADDR)
     $request   = makeRequest([], ['REMOTE_ADDR' => '192.0.2.30']);
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
     expect($telemetry->getIp())->toBe('192.0.2.30');
 
     // 4) ip() without argument sets header from getIp()

tests/Unit/Request/IpTest.php

@@ -2,21 +2,21 @@
 
 declare(strict_types=1);
 
-use DragonCode\Telemetry\TelemetryHeader;
-use DragonCode\Telemetry\TelemetryRequest;
+use DragonCode\RequestTracker\TrackerHeader;
+use DragonCode\RequestTracker\TrackerRequest;
 use Ramsey\Uuid\Uuid;
 
 it('gets or sets trace id, generating a UUID v4 when absent', function () {
-    $header = new TelemetryHeader;
+    $header = new TrackerHeader;
 
     // 1) If header exists, return it
     $request   = makeRequest([$header->traceId => 'trace-123']);
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
     expect($telemetry->getTraceId())->toBe('trace-123');
 
     // 2) When absent, generate UUID v4
     $request   = makeRequest();
-    $telemetry = new TelemetryRequest($request, $header);
+    $telemetry = new TrackerRequest($request, $header);
     $generated = $telemetry->getTraceId();
     expect(Uuid::isValid($generated))->toBeTrue()
         ->and(Uuid::fromString($generated)->getVersion())->toBe(4);