Conversation
tballison
marked this pull request as draft
August 27, 2026 12:41
tballison
marked this pull request as ready for review
August 27, 2026 17:03
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new JSONL (one-JSON-object-per-line) pipes reporter for the file-system pipes plugin to provide an append-only per-document audit log, and updates reporter/async-processing behavior and documentation to support it.
Changes:
- Introduces
file-system-jsonl-reporter(config record, reporter implementation, PF4J factory) plus extensive unit tests and config examples. - Updates
CompositePipesReporterto invoke all configured reporters even if one throws, then rethrow the first exception with the rest suppressed. - Updates async CLI/config writing and docs to apply
--on-existsmapping to the JSONL reporter (skip→APPEND) and documents the new reporter.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/test/resources/config-examples/file-system-jsonl-reporter.json | Adds a file-system JSONL reporter config example for validation tests. |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/test/java/org/apache/tika/pipes/reporter/fs/FileSystemJsonlReporterTest.java | Adds unit tests for JSONL line format, filtering, truncation, concurrency, and failure modes. |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/test/java/org/apache/tika/pipes/fs/ConfigExamplesTest.java | Validates the new JSONL reporter config example and factory registration. |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/main/java/org/apache/tika/pipes/reporter/fs/FileSystemJsonlReporterFactory.java | Registers the new reporter via PF4J and exposes its component name. |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/main/java/org/apache/tika/pipes/reporter/fs/FileSystemJsonlReporterConfig.java | Adds strongly-typed config (path, includes/excludes, onExists, maxMessageLength). |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/src/main/java/org/apache/tika/pipes/reporter/fs/FileSystemJsonlReporter.java | Implements the JSONL reporter with per-line flush, on-exists behavior, and message truncation. |
| tika-pipes/tika-pipes-plugins/tika-pipes-file-system/pom.xml | Adds dependency on tika-pipes-reporter-commons for PipesReporterBase. |
| tika-pipes/tika-pipes-core/src/test/java/org/apache/tika/pipes/core/reporter/CompositePipesReporterTest.java | Adds coverage to ensure throwing reporters don’t starve sibling reporters. |
| tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/reporter/CompositePipesReporter.java | Ensures all reporters see calls and aggregates exceptions via suppression. |
| tika-pipes/tika-pipes-core/src/main/java/org/apache/tika/pipes/core/async/AsyncProcessor.java | Latches first worker/emitter failure; adjusts error/report behavior around reporter failures. |
| tika-pipes/tika-async-cli/src/test/java/org/apache/tika/async/cli/TikaConfigAsyncWriterTest.java | Tests --on-exists mapping through to the JSONL reporter configuration. |
| tika-pipes/tika-async-cli/src/main/java/org/apache/tika/async/cli/PluginsWriter.java | Applies onExists mapping to file-system-jsonl-reporter (SKIP → APPEND). |
| docs/modules/ROOT/pages/using-tika/cli/index.adoc | Documents that --on-exists also applies to the JSONL reporter. |
| docs/modules/ROOT/pages/pipes/reporters.adoc | Documents composite reporter behavior (all reporters called; first exception rethrown). |
| docs/modules/ROOT/pages/pipes/plugins/filesystem.adoc | Adds full documentation for the new JSONL reporter (format, guarantees, configuration). |
| CHANGES.txt | Adds a release-note entry for the new reporter (TIKA-4846). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thanks for your contribution to Apache Tika! Your help is appreciated!
Before opening the pull request, please verify that
TIKA-XXXX)[TIKA-XXXX] Issue or pull request title)./mvnw clean testmainbranch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulledmainbranchtika-bom/pom.xml.We will be able to faster integrate your pull request if these conditions are met. If you have any questions how to fix your problem or about using Tika in general, please sign up for the Tika mailing list. Thanks!