opensearch-project / opensearch-project/data-prepper

Audit Logs

Open
#2,705 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem? Please describe.
For pull based sources that perform bulk reading like S3 scan or the OpenSearch source that is in PR. As a user, I would like a mechanism to track which data has been read and processed. This could include if data is dropped, a node in my data prepper cluster becomes unresponsive

Describe the solution you'd like
An audit log comes to mind. This log would contain a list of data processing events related to docs or indices or some metadata determine by the source. These logs could be used to determine the exact time frame a set of data was pulled into data prepper.

Describe alternatives you've considered (Optional)

  • Metrics tracking the completion percentage for a scan
  • Improving existing logs by adding an Audit tag to the message which tracks relevant data processing events.
  • Not including audit logs. I am not sure if this makes sense in Data Prepper. Audit logging would be a new requirement that we may have to enforce on every plugin if we wanted to track data through a pipeline.

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.

Research direction

No files or tests are named. Start by reviewing the S3 scan and OpenSearch source entry points, then examine existing logs and metrics to determine whether audit events can track reads, drops, unresponsive nodes, and processing timeframes; done requires a settled scope and an agreed implementation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
data-engineering, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.