Ecotone
SponsorBlogGithubSupport and ContactCommunity Channel
  • About
  • Installation
  • How to use
    • CQRS PHP
    • Event Handling PHP
    • Aggregates & Sagas
    • Scheduling in PHP
    • Asynchronous PHP
    • Event Sourcing PHP
    • Microservices PHP
    • Resiliency and Error Handling
    • Laravel Demos
    • Symfony Demos
      • Doctrine ORM
  • Tutorial
    • Before we start tutorial
    • Lesson 1: Messaging Concepts
    • Lesson 2: Tactical DDD
    • Lesson 3: Converters
    • Lesson 4: Metadata and Method Invocation
    • Lesson 5: Interceptors
    • Lesson 6: Asynchronous Handling
  • Enterprise
  • Modelling
    • Introduction
    • Message Bus and CQRS
      • CQRS Introduction - Commands
        • Query Handling
        • Event Handling
      • Aggregate Introduction
        • Aggregate Command Handlers
        • Aggregate Query Handlers
        • Aggregate Event Handlers
        • Advanced Aggregate creation
      • Repositories Introduction
      • Business Interface
        • Introduction
        • Business Repository
        • Database Business Interface
          • Converting Parameters
          • Converting Results
      • Saga Introduction
      • Identifier Mapping
    • Extending Messaging (Middlewares)
      • Message Headers
      • Interceptors (Middlewares)
        • Additional Scenarios
      • Intercepting Asynchronous Endpoints
      • Extending Message Buses (Gateways)
    • Event Sourcing
      • Installation
      • Event Sourcing Introduction
        • Working with Event Streams
        • Event Sourcing Aggregates
          • Working with Aggregates
          • Applying Events
          • Different ways to Record Events
        • Working with Metadata
        • Event versioning
        • Event Stream Persistence
          • Event Sourcing Repository
          • Making Stream immune to changes
          • Snapshoting
          • Persistence Strategies
          • Event Serialization and PII Data (GDPR)
      • Projection Introduction
        • Configuration
        • Choosing Event Streams for Projection
        • Executing and Managing
          • Running Projections
          • Projection CLI Actions
          • Access Event Store
        • Projections with State
        • Emitting events
    • Recovering, Tracing and Monitoring
      • Resiliency
        • Retries
        • Error Channel and Dead Letter
          • Dbal Dead Letter
        • Idempotent Consumer (Deduplication)
        • Resilient Sending
        • Outbox Pattern
        • Concurrency Handling
      • Message Handling Isolation
      • Ecotone Pulse (Service Dashboard)
    • Asynchronous Handling and Scheduling
      • Asynchronous Message Handlers
      • Asynchronous Message Bus (Gateways)
      • Delaying Messages
      • Time to Live
      • Message Priority
      • Scheduling
      • Dynamic Message Channels
    • Distributed Bus and Microservices
      • Distributed Bus
        • Distributed Bus with Service Map
          • Configuration
          • Custom Features
          • Non-Ecotone Application integration
          • Testing
        • AMQP Distributed Bus (RabbitMQ)
          • Configuration
        • Distributed Bus Interface
      • Message Consumer
      • Message Publisher
    • Business Workflows
      • The Basics - Stateless Workflows
      • Stateful Workflows - Saga
      • Handling Failures
    • Testing Support
      • Testing Messaging
      • Testing Aggregates and Sagas with Message Flows
      • Testing Event Sourcing Applications
      • Testing Asynchronous Messaging
  • Messaging and Ecotone In Depth
    • Overview
    • Multi-Tenancy Support
      • Getting Started
        • Any Framework Configuration
        • Symfony and Doctrine ORM
        • Laravel
      • Different Scenarios
        • Hooking into Tenant Switch
        • Shared and Multi Database Tenants
        • Accessing Current Tenant in Message Handler
        • Events and Tenant Propagation
        • Multi-Tenant aware Dead Letter
      • Advanced Queuing Strategies
    • Document Store
    • Console Commands
    • Messaging concepts
      • Message
      • Message Channel
      • Message Endpoints/Handlers
        • Internal Message Handler
        • Message Router
        • Splitter
      • Consumer
      • Messaging Gateway
      • Inbound/Outbound Channel Adapter
    • Method Invocation And Conversion
      • Method Invocation
      • Conversion
        • Payload Conversion
        • Headers Conversion
    • Service (Application) Configuration
    • Contributing to Ecotone
      • How Ecotone works under the hood
      • Ecotone Phases
      • Registering new Module Package
      • Demo Integration with SQS
        • Preparation
        • Inbound and Outbound Adapters and Message Channel
        • Message Consumer and Publisher
  • Modules
    • Overview
    • Symfony
      • Symfony Configuration
      • Symfony Database Connection (DBAL Module)
      • Doctrine ORM
      • Symfony Messenger Transport
    • Laravel
      • Laravel Configuration
      • Database Connection (DBAL Module)
      • Eloquent
      • Laravel Queues
      • Laravel Octane
    • Ecotone Lite
      • Logging
      • Database Connection (DBAL Module)
    • JMS Converter
    • OpenTelemetry (Tracing and Metrics)
      • Configuration
    • RabbitMQ Support
    • Kafka Support
      • Configuration
      • Message partitioning
      • Usage
    • DBAL Support
    • Amazon SQS Support
    • Redis Support
  • Other
    • Contact, Workshops and Support
Powered by GitBook
On this page
  • Dbal Dead Letter
  • Installation
  • Send Error Messages directly to Dead Letter:
  • Try to recover with Retries first
  • Dead Letter Console Commands
  • Help
  • Listing Error Messages
  • Show Details About Error Message
  • Replay Error Message
  • Replay All Messages
  • Delete Message
  • Turn off Dbal Dead Letter
  • Managing Multiple Ecotone Applications

Was this helpful?

Export as PDF
  1. Modelling
  2. Recovering, Tracing and Monitoring
  3. Resiliency
  4. Error Channel and Dead Letter

Dbal Dead Letter

PreviousError Channel and Dead LetterNextIdempotent Consumer (Deduplication)

Last updated 4 months ago

Was this helpful?

Dbal Dead Letter

Ecotone comes with full support for managing full life cycle of a error message by using .

  • Store failed Message with all details about the exception

  • Allow for reviewing error Messages

  • Allow for deleting and replaying error Message back to the

Installation

  • Install .

  • Set up Error Channel like discussed at the

Send Error Messages directly to Dead Letter:

If we configure default error channel to point to "dbal_dead_letter" then all Error Messages will land there directly:

config/packages/ecotone.yaml

ecotone:
  defaultErrorChannel: "dbal_dead_letter"

config/ecotone.php

return [
    'defaultErrorChannel' => 'dbal_dead_letter',
];
$ecotone = EcotoneLite::bootstrap(
    configuration: ServiceConfiguration::createWithDefaults()
        ->withDefaultErrorChannel('dbal_dead_letter')
);

Try to recover with Retries first

We may also want to try to recover before we consider Message to be stored in Dead Letter:

config/packages/ecotone.yaml

ecotone:
  defaultErrorChannel: "errorChannel"

config/ecotone.php

return [
    'defaultErrorChannel' => 'errorChannel',
];
$ecotone = EcotoneLite::bootstrap(
    configuration: ServiceConfiguration::createWithDefaults()
        ->withDefaultErrorChannel('errorChannel')
);

and then we use inbuilt Retry Strategy:

#[ServiceContext]
public function errorConfiguration()
{
    return ErrorHandlerConfiguration::createWithDeadLetterChannel(
        "errorChannel",
        //  retry strategy
        RetryTemplateBuilder::exponentialBackoff(1000, 10)
            ->maxRetryAttempts(3),
        // if retry strategy will not recover, then send here
        "dbal_dead_letter"
    );
}

Dead Letter Console Commands

Help

Get more details about existing commands

bin/console ecotone:deadletter:help
artisan ecotone:deadletter:help

Listing Error Messages

Listing current error messages

bin/console ecotone:deadletter:list
artisan ecotone:deadletter:list
$list = $messagingSystem->runConsoleCommand("ecotone:deadletter:list", []);

Show Details About Error Message

Get more details about given error message

bin/console ecotone:deadletter:show {messageId}
artisan ecotone:deadletter:show {messageId}
$details = $messagingSystem->runConsoleCommand("ecotone:deadletter:show", ["messageId" => $messageId]);

Replay Error Message

Replay error message. It will return to previous channel for consumer to pick it up and handle again.

bin/console ecotone:deadletter:replay {messageId}
artisan ecotone:deadletter:replay {messageId}
$messagingSystem->runConsoleCommand("ecotone:deadletter:replay", ["messageId" => $messageId]);

Replay All Messages

Replaying all the error messages.

bin/console ecotone:deadletter:replayAll
artisan ecotone:deadletter:replayAll
$messagingSystem->runConsoleCommand("ecotone:deadletter:replayAll", []);

Delete Message

Delete given error message

bin/console ecotone:deadletter:delete {messageId}
artisan ecotone:deadletter:delete {messageId}
$messagingSystem->runConsoleCommand("ecotone:deadletter:delete", ["messageId" => $messageId]);

Turn off Dbal Dead Letter

#[ServiceContext]
public function dbalConfiguration()
{
    return DbalConfiguration::createWithDefaults()
        ->withDeadLetter(false);
}

Managing Multiple Ecotone Applications

This is especially useful when we've multiple Applications, so we can go to single place and see if any Application have failed to process Message.

The above solution requires running Console Line Commands. If we want however, we can manage all our Error Messages from one place using .

Ecotone Pulse
Asynchronous Message Channels
Ecotone's Dbal Module
beginning of the section
Dbal Module