fix: rename parameter prefixes from c10k to ckrack in configuration files

Author: ckrack

README.md

@@ -2,21 +2,48 @@
 
 Symfony bundle for Messenger lifecycle logging, suitable for monitoring.
 
+## Overview
+
+This bundle subscribes to Symfony Messenger lifecycle events and emits
+structured logs that are easy to correlate in monitoring and debugging tools.
+
+### What It Adds
+
+- A UUIDv7 is assigned when a message is queued.
+- The same UUID is reused across queueing, receiving, handling, failures, and retries.
+- Each log entry includes the message class and a normalized `stamps` array.
+- Transport metadata such as receiver names, retry counts, and failure-transport
+  details are included when available.
+
+### Supported Lifecycle Events
+
+The bundle logs queueing, receiving, success, failure, and retry events. If the
+installed Messenger version supports `WorkerMessageSkipEvent`, skipped messages
+are logged as well.
+
 ## Installation
 
+### Package Installation
+
 ```bash
 composer require ckrack/messenger-logging-bundle
 ```
 
+### Bundle Registration
+
 If you are not using Symfony Flex, register the bundle manually in
 `config/bundles.php`.
 
+### Supported Versions
+
 The bundle targets Symfony `6.4`, `7.4`, and `8.0`.
 
 ## Configuration
 
+### Basic Configuration
+
 ```yaml
-c10k_messenger_logging:
+ckrack_messenger_logging:
   enabled: true
   log_channel: messenger
   log_levels:
@@ -26,49 +53,56 @@ c10k_messenger_logging:
     failed: error
     retried: warning
     skipped: warning
-  stamp_normalizers: { }
+  stamp_normalizers: {}
 ```
 
+### Log Levels
+
 All PSR-3 log levels are supported. If failure logs are too noisy in a
 retry-heavy environment, you can set `failed: info`.
 
+### Dedicated Log Channel
+
 If `log_channel` is set, only the logs emitted by this bundle are sent to that
 Monolog channel. Other project logs remain unaffected unless they are
 explicitly configured to use the same channel. Without `log_channel`, the
 default logger behavior remains unchanged.
 
-The bundle subscribes to Messenger events and ensures that each message
-receives a UUIDv7 when it is queued. The same UUID then appears in the logs for
-queueing, receiving, success, failure, and retry, together with the message
-class and a normalized `stamps` array.
+## Stamp Normalization
+
+### Default Behavior
+
+The bundle normalizes a safe subset of Messenger stamp data and includes it in
+the `stamps` field of each log entry. Built-in normalizers cover
+`BusNameStamp`, `DelayStamp`, `HandledStamp`, `RedeliveryStamp`,
+`RouterContextStamp`, `SentStamp`, `TransportNamesStamp`, and
+`ValidationStamp`.
 
-Stamp normalization is explicit. The bundle ships dedicated normalizers for a
-safe subset of Messenger stamps such as `BusNameStamp`, `DelayStamp`,
-`HandledStamp`, `RedeliveryStamp`, `RouterContextStamp`, `SentStamp`,
-`TransportNamesStamp`, and `ValidationStamp`. Unknown stamps are still listed
-by class name, but their `context` remains empty unless a normalizer is
-registered for them. This avoids reflecting every public getter on every stamp,
-which can expose sensitive data or large payloads such as handler results.
+Unknown stamps are still listed by class name, but their `context` remains
+empty unless a normalizer is registered for them. This avoids reflecting every
+public getter on every stamp, which can expose sensitive data or large payloads
+such as handler results.
+
+### Custom Normalizers
 
 Custom normalizers are discovered automatically when they implement
 `C10k\MessengerLoggingBundle\Logging\StampNormalizerInterface` and are
 registered as autoconfigured services. The bundle tags them with
-`c10k_messenger_logging.stamp_normalizer` and maps them by supported stamp
+`ckrack_messenger_logging.stamp_normalizer` and maps them by supported stamp
 class.
 
 You can also wire an explicit `StampClass -> NormalizerClass` mapping via
 configuration, which is useful for overrides:
 
 ```yaml
-c10k_messenger_logging:
+ckrack_messenger_logging:
   stamp_normalizers:
     App\Messenger\CustomStamp: App\Messenger\Logging\CustomStampNormalizer
 ```
 
-If the installed Messenger version supports `WorkerMessageSkipEvent`, skipped
-messages are logged as well.
+## Logged Lifecycle
 
-## Example Lifecycle
+### Example Message Flow
 
 The example below shows how a single message can appear in the logs when it is
 queued, fails once, is retried, and is eventually handled successfully. The
@@ -135,16 +169,23 @@ retry_count:              1</pre></td>
   </tbody>
 </table>
 
-Each entry also contains the normalized `stamps` array, plus fields such as
+### Additional Context Fields
+
+Each entry also contains the normalized `stamps` array. Depending on the
+envelope state, the bundle may also include fields such as
 `transport_message_id`, `from_failed_transport`, and
-`failed_transport_original_receiver_name` when those details are available.
+`failed_transport_original_receiver_name`.
 
 ## Local development
 
+### Prerequisites
+
 - Docker with Compose V2
 - pre-commit
 - GNU Make
 
+### Common Commands
+
 ```bash
 make setup
 make check

src/DependencyInjection/C10kMessengerLoggingExtension.php

@@ -35,13 +35,13 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->registerForAutoconfiguration(StampNormalizerInterface::class)
             ->addTag(StampNormalizerInterface::SERVICE_TAG);
 
-        $container->setParameter('c10k_messenger_logging.enabled', $enabled);
-        $container->setParameter('c10k_messenger_logging.log_channel', $logChannel);
-        $container->setParameter('c10k_messenger_logging.stamp_normalizers', $stampNormalizers);
+        $container->setParameter('ckrack_messenger_logging.enabled', $enabled);
+        $container->setParameter('ckrack_messenger_logging.log_channel', $logChannel);
+        $container->setParameter('ckrack_messenger_logging.stamp_normalizers', $stampNormalizers);
 
         foreach ($logLevels as $event => $logLevel) {
             $container->setParameter(
-                'c10k_messenger_logging.log_levels.'.$event,
+                'ckrack_messenger_logging.log_levels.'.$event,
                 $logLevel,
             );
         }

src/DependencyInjection/Compiler/RegisterStampNormalizersPass.php

@@ -26,7 +26,7 @@ public function process(ContainerBuilder $container): void
         }
 
         /** @var array<class-string<StampInterface>, class-string<StampNormalizerInterface>> $configuredNormalizers */
-        $configuredNormalizers = $container->getParameter('c10k_messenger_logging.stamp_normalizers');
+        $configuredNormalizers = $container->getParameter('ckrack_messenger_logging.stamp_normalizers');
         $normalizers = [];
         $registeredBy = [];
 

src/DependencyInjection/Configuration.php

@@ -24,7 +24,7 @@ final class Configuration implements ConfigurationInterface
 
     public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder('c10k_messenger_logging');
+        $treeBuilder = new TreeBuilder('ckrack_messenger_logging');
 
         /** @var ArrayNodeDefinition $rootNode */
         $rootNode = $treeBuilder->getRootNode();

src/Logging/StampNormalizerInterface.php

@@ -8,7 +8,7 @@
 
 interface StampNormalizerInterface
 {
-    public const SERVICE_TAG = 'c10k_messenger_logging.stamp_normalizer';
+    public const SERVICE_TAG = 'ckrack_messenger_logging.stamp_normalizer';
 
     /**
      * @return class-string<StampInterface>

src/Resources/config/services.php

@@ -30,23 +30,23 @@
     );
     $services->set(SendMessageToTransportsEventSubscriber::class)
         ->arg('$logger', service('logger')->nullOnInvalid())
-        ->arg('$logLevel', param('c10k_messenger_logging.log_levels.queued'));
+        ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.queued'));
     $services->set(WorkerMessageReceivedEventSubscriber::class)
         ->arg('$logger', service('logger')->nullOnInvalid())
-        ->arg('$logLevel', param('c10k_messenger_logging.log_levels.received'));
+        ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.received'));
     $services->set(WorkerMessageHandledEventSubscriber::class)
         ->arg('$logger', service('logger')->nullOnInvalid())
-        ->arg('$logLevel', param('c10k_messenger_logging.log_levels.handled'));
+        ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.handled'));
     $services->set(WorkerMessageFailedEventSubscriber::class)
         ->arg('$logger', service('logger')->nullOnInvalid())
-        ->arg('$logLevel', param('c10k_messenger_logging.log_levels.failed'));
+        ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.failed'));
     $services->set(WorkerMessageRetriedEventSubscriber::class)
         ->arg('$logger', service('logger')->nullOnInvalid())
-        ->arg('$logLevel', param('c10k_messenger_logging.log_levels.retried'));
+        ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.retried'));
 
     if (class_exists(WorkerMessageSkipEvent::class)) {
         $services->set(WorkerMessageSkipEventSubscriber::class)
             ->arg('$logger', service('logger')->nullOnInvalid())
-            ->arg('$logLevel', param('c10k_messenger_logging.log_levels.skipped'));
+            ->arg('$logLevel', param('ckrack_messenger_logging.log_levels.skipped'));
     }
 };

tests/DependencyInjection/C10kMessengerLoggingExtensionTest.php

@@ -37,11 +37,11 @@ public function testItLoadsServicesWhenEnabled(): void
 
         $extension->load([], $container);
 
-        self::assertTrue($container->hasParameter('c10k_messenger_logging.enabled'));
-        self::assertTrue($container->getParameter('c10k_messenger_logging.enabled'));
-        self::assertNull($container->getParameter('c10k_messenger_logging.log_channel'));
+        self::assertTrue($container->hasParameter('ckrack_messenger_logging.enabled'));
+        self::assertTrue($container->getParameter('ckrack_messenger_logging.enabled'));
+        self::assertNull($container->getParameter('ckrack_messenger_logging.log_channel'));
         self::assertTrue($container->hasDefinition(MessengerLogContextBuilder::class));
-        self::assertSame([], $container->getParameter('c10k_messenger_logging.stamp_normalizers'));
+        self::assertSame([], $container->getParameter('ckrack_messenger_logging.stamp_normalizers'));
         self::assertTrue($container->hasDefinition(SendMessageToTransportsEventSubscriber::class));
         self::assertTrue($container->hasDefinition(WorkerMessageReceivedEventSubscriber::class));
         self::assertTrue($container->hasDefinition(WorkerMessageHandledEventSubscriber::class));
@@ -51,8 +51,8 @@ public function testItLoadsServicesWhenEnabled(): void
             class_exists(WorkerMessageSkipEvent::class),
             $container->hasDefinition(WorkerMessageSkipEventSubscriber::class),
         );
-        self::assertSame('info', $container->getParameter('c10k_messenger_logging.log_levels.queued'));
-        self::assertSame('error', $container->getParameter('c10k_messenger_logging.log_levels.failed'));
+        self::assertSame('info', $container->getParameter('ckrack_messenger_logging.log_levels.queued'));
+        self::assertSame('error', $container->getParameter('ckrack_messenger_logging.log_levels.failed'));
         self::assertSame([], $container->getDefinition(SendMessageToTransportsEventSubscriber::class)->getTag('monolog.logger'));
     }
 
@@ -63,7 +63,7 @@ public function testItSkipsServicesWhenDisabled(): void
 
         $extension->load([['enabled' => false]], $container);
 
-        self::assertFalse($container->getParameter('c10k_messenger_logging.enabled'));
+        self::assertFalse($container->getParameter('ckrack_messenger_logging.enabled'));
     }
 
     public function testItLoadsCustomLogLevels(): void
@@ -73,8 +73,8 @@ public function testItLoadsCustomLogLevels(): void
 
         $extension->load([['log_levels' => ['queued' => 'debug', 'failed' => 'info']]], $container);
 
-        self::assertSame('debug', $container->getParameter('c10k_messenger_logging.log_levels.queued'));
-        self::assertSame('info', $container->getParameter('c10k_messenger_logging.log_levels.failed'));
+        self::assertSame('debug', $container->getParameter('ckrack_messenger_logging.log_levels.queued'));
+        self::assertSame('info', $container->getParameter('ckrack_messenger_logging.log_levels.failed'));
     }
 
     public function testItLoadsCustomStampNormalizerConfiguration(): void
@@ -95,7 +95,7 @@ public function testItLoadsCustomStampNormalizerConfiguration(): void
 
         self::assertSame(
             ['App\\Messenger\\CustomStamp' => 'App\\Messenger\\Logging\\CustomStampNormalizer'],
-            $container->getParameter('c10k_messenger_logging.stamp_normalizers'),
+            $container->getParameter('ckrack_messenger_logging.stamp_normalizers'),
         );
     }
 
@@ -106,7 +106,7 @@ public function testItAddsConfiguredLogChannelToAllSubscribers(): void
 
         $extension->load([['log_channel' => 'messenger']], $container);
 
-        self::assertSame('messenger', $container->getParameter('c10k_messenger_logging.log_channel'));
+        self::assertSame('messenger', $container->getParameter('ckrack_messenger_logging.log_channel'));
 
         foreach ($this->expectedSubscriberServiceIds() as $subscriberServiceId) {
             self::assertSame(