Have the option to write Event Metadata for failed documents to the DLQ

Open
#4,158 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
backend

Research direction

No files or tests are named in the issue. Start by locating the DLQ configuration and document serialization entry points, then trace how EventMetadata is available for failed events. Done means a false-by-default dlq.include_event_metadata option and an eventMetadata field in DLQ documents when enabled, with coverage for both settings.

Written by the indexing model from the issue text.

Description

enhancement

Is your feature request related to a problem? Please describe.
As a user of Data Prepper's DLQ, I would like to also get the metadata of Events in the case that I was using those values in my pipeline for the failed DLQ data. This would allow me to replay DLQ data in the exact same way as the previous pipeline attempted.

Describe the solution you'd like
A configurable option at the dlq level for include_event_metadata, which would default to false.

dlq:
    include_event_metadata: true
    s3:
          bucket: "dlq-bucket-ddb"
          key_path_prefix: "osi-test-dlq-pipeline/logs/dlq/%{yyyy}/%{MM}/%{dd}"
          region: "us-west-2"
          sts_role_arn: "arn:aws:iam::870201406020:role/osis-to-domain-ingestion-role"

When set to true, the DLQ documents will contain an extra field for eventMetadata, which contains the EventMetadata map.

Describe alternatives you've considered (Optional)
Default all DLQ documents to contain the Event metadata

Additional context
Add any other context or screenshots about the feature request here.

Dominant language
Java
Stars
374
Forks
355
Avg merge
3d 18h
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from opensearch-project/data-prepper

All issues in opensearch-project/data-prepper

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.