rename to recover_failure_document processor

Author: seanzatzdev

docs/changelog/133360.yaml

@@ -1,5 +1,5 @@
 pr: 133360
-summary: Add remediate processor to remediate failurestore docs
+summary: Add recover_failure_document processor to remediate failurestore docs
 area: Ingest Node
 type: feature
 issues: []

docs/reference/enrich-processor/index.md

@@ -156,7 +156,7 @@ Refer to [Enrich your data](docs-content://manage-data/ingest/transform-enrich/d
 [`lowercase` processor](/reference/enrich-processor/lowercase-processor.md) and [`uppercase` processor](/reference/enrich-processor/uppercase-processor.md)
 :   Converts a string field to lowercase or uppercase.
 
-[`remediate` processor](/reference/enrich-processor/remediate-processor.md)
+[`recover_failure_document` processor](/reference/enrich-processor/recover-failure-document-processor.md)
 :   Converts failure store document to its original format.
 
 [`split` processor](/reference/enrich-processor/split-processor.md)

docs/reference/enrich-processor/remediate-processor.md renamed to docs/reference/enrich-processor/recover-failure-document-processor.md

@@ -1,22 +1,22 @@
 ---
-navigation_title: "Remediate"
+navigation_title: "Recover Failure Document"
 mapped_pages:
-  - https://www.elastic.co/guide/en/elasticsearch/reference/current/remediate-processor.html
+  - https://www.elastic.co/guide/en/elasticsearch/reference/current/recover_failure_document-processor.html
 ---
 
-# Remediate processor [remediate-processor]
+# Recover Failure Document processor [recover_failure_document-processor]
 
 Remediates documents that have been stored in a data stream's failure store by restoring them to their original format. This processor is designed to work with documents that failed during ingestion and were automatically stored in the failure store with additional error metadata and document structure wrapping.
 
-The remediate processor performs the following operations:
+The Recover Failure Document processor performs the following operations:
 
 * Extracts the original document source from the `document.source` field
 * Restores the original index name from `document.index` to the document metadata
 * Restores the original routing value from `document.routing` to the document metadata (if present)
 * Removes the failure-related fields (`error` and `document`) from the document
 * Places all original source fields back at the root level of the document
 
-$$$remediate-options$$$
+$$$recover_failure_document-options$$$
 
 | Name | Required | Default | Description |
 | --- | --- | --- | --- |
@@ -26,15 +26,15 @@ $$$remediate-options$$$
 | `on_failure` | no | - | Handle failures for the processor. See [Handling pipeline failures](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#handling-pipeline-failures). |
 | `tag` | no | - | Identifier for the processor. Useful for debugging and metrics. |
 
-## Examples [remediate-processor-ex]
+## Examples [recover_failure_document-processor-ex]
 
 ```console
 POST _ingest/pipeline/_simulate
 {
     "pipeline": {
         "processors": [
             {
-                "remediate": {}
+                "recover_failure_document": {}
             }
         ]
     },
@@ -98,7 +98,7 @@ POST _ingest/pipeline/_simulate
     "pipeline": {
         "processors": [
             {
-                "remediate": {}
+                "recover_failure_document": {}
             }
         ]
     },

docs/reference/enrich-processor/toc.yml

@@ -32,7 +32,7 @@ toc:
   - file: pipeline-processor.md
   - file: redact-processor.md
   - file: registered-domain-processor.md
-  - file: remediate-processor.md
+  - file: recover-failure-document-processor.md
   - file: remove-processor.md
   - file: rename-processor.md
   - file: reroute-processor.md

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/plugins/IngestCommonPluginBridge.java

@@ -9,7 +9,7 @@
 package org.elasticsearch.logstashbridge.plugins;
 
 import org.elasticsearch.ingest.common.IngestCommonPlugin;
-import org.elasticsearch.ingest.common.RemediateProcessor;
+import org.elasticsearch.ingest.common.RecoverFailureDocumentProcessor;
 import org.elasticsearch.logstashbridge.StableBridgeAPI;
 import org.elasticsearch.logstashbridge.ingest.ProcessorBridge;
 
@@ -41,7 +41,7 @@ public class IngestCommonPluginBridge implements IngestPluginBridge {
     public static final String LOWERCASE_PROCESSOR_TYPE = org.elasticsearch.ingest.common.LowercaseProcessor.TYPE;
     public static final String NETWORK_DIRECTION_PROCESSOR_TYPE = org.elasticsearch.ingest.common.NetworkDirectionProcessor.TYPE;
     public static final String REGISTERED_DOMAIN_PROCESSOR_TYPE = org.elasticsearch.ingest.common.RegisteredDomainProcessor.TYPE;
-    public static final String REMEDIATE_PROCESSOR_TYPE = RemediateProcessor.TYPE;
+    public static final String RECOVER_FAILURE_DOCUMENT_PROCESSOR_TYPE = RecoverFailureDocumentProcessor.TYPE;
     public static final String REMOVE_PROCESSOR_TYPE = org.elasticsearch.ingest.common.RemoveProcessor.TYPE;
     public static final String RENAME_PROCESSOR_TYPE = org.elasticsearch.ingest.common.RenameProcessor.TYPE;
     public static final String REROUTE_PROCESSOR_TYPE = org.elasticsearch.ingest.common.RerouteProcessor.TYPE;

modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/IngestCommonPlugin.java

@@ -64,7 +64,7 @@ public Map<String, Processor.Factory> getProcessors(Processor.Parameters paramet
             entry(NetworkDirectionProcessor.TYPE, new NetworkDirectionProcessor.Factory(parameters.scriptService)),
             entry(PipelineProcessor.TYPE, new PipelineProcessor.Factory(parameters.ingestService)),
             entry(RegisteredDomainProcessor.TYPE, new RegisteredDomainProcessor.Factory()),
-            entry(RemediateProcessor.TYPE, new RemediateProcessor.Factory()),
+            entry(RecoverFailureDocumentProcessor.TYPE, new RecoverFailureDocumentProcessor.Factory()),
             entry(RemoveProcessor.TYPE, new RemoveProcessor.Factory(parameters.scriptService)),
             entry(RenameProcessor.TYPE, new RenameProcessor.Factory(parameters.scriptService)),
             entry(RerouteProcessor.TYPE, new RerouteProcessor.Factory()),

modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/RemediateProcessor.java renamed to modules/ingest-common/src/main/java/org/elasticsearch/ingest/common/RecoverFailureDocumentProcessor.java

@@ -23,11 +23,11 @@
  * - Removing the "error" and "document" fields from the root
  * - Restoring the original source fields at the root of the document
  */
-public final class RemediateProcessor extends AbstractProcessor {
+public final class RecoverFailureDocumentProcessor extends AbstractProcessor {
 
-    public static final String TYPE = "remediate";
+    public static final String TYPE = "recover_failure_document";
 
-    RemediateProcessor(String tag, String description) {
+    RecoverFailureDocumentProcessor(String tag, String description) {
         super(tag, description);
     }
 
@@ -77,14 +77,14 @@ public String getType() {
 
     public static final class Factory implements Processor.Factory {
         @Override
-        public RemediateProcessor create(
+        public RecoverFailureDocumentProcessor create(
             Map<String, Processor.Factory> registry,
             String processorTag,
             String description,
             Map<String, Object> config,
             ProjectId projectId
         ) throws Exception {
-            return new RemediateProcessor(processorTag, description);
+            return new RecoverFailureDocumentProcessor(processorTag, description);
         }
     }
 }

modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/RemediateProcessorFactoryTests.java renamed to modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/RecoverFailureDocumentProcessorFactoryTests.java

@@ -17,32 +17,32 @@
 
 import static org.hamcrest.Matchers.equalTo;
 
-public class RemediateProcessorFactoryTests extends ESTestCase {
+public class RecoverFailureDocumentProcessorFactoryTests extends ESTestCase {
 
-    private RemediateProcessor.Factory factory;
+    private RecoverFailureDocumentProcessor.Factory factory;
 
     @Before
     public void init() {
-        factory = new RemediateProcessor.Factory();
+        factory = new RecoverFailureDocumentProcessor.Factory();
     }
 
     public void testCreate() throws Exception {
-        RemediateProcessor.Factory factory = new RemediateProcessor.Factory();
+        RecoverFailureDocumentProcessor.Factory factory = new RecoverFailureDocumentProcessor.Factory();
         Map<String, Object> config = new HashMap<>();
 
         String processorTag = randomAlphaOfLength(10);
-        RemediateProcessor processor = factory.create(null, processorTag, null, config, null);
+        RecoverFailureDocumentProcessor processor = factory.create(null, processorTag, null, config, null);
 
         assertThat(processor.getTag(), equalTo(processorTag));
     }
 
     public void testCreateWithDescription() throws Exception {
-        RemediateProcessor.Factory factory = new RemediateProcessor.Factory();
+        RecoverFailureDocumentProcessor.Factory factory = new RecoverFailureDocumentProcessor.Factory();
         Map<String, Object> config = new HashMap<>();
 
         String processorTag = randomAlphaOfLength(10);
         String description = randomAlphaOfLength(20);
-        RemediateProcessor processor = factory.create(null, processorTag, description, config, null);
+        RecoverFailureDocumentProcessor processor = factory.create(null, processorTag, description, config, null);
 
         assertThat(processor.getTag(), equalTo(processorTag));
         assertThat(processor.getDescription(), equalTo(description));

modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/RemediateProcessorTests.java renamed to modules/ingest-common/src/test/java/org/elasticsearch/ingest/common/RecoverFailureDocumentProcessorTests.java

@@ -20,10 +20,10 @@
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.is;
 
-public class RemediateProcessorTests extends ESTestCase {
+public class RecoverFailureDocumentProcessorTests extends ESTestCase {
 
-    private static Processor createRemediateProcessor() {
-        return new RemediateProcessor(randomAlphaOfLength(8), null);
+    private static Processor createRecoverFailureDocumentProcessor() {
+        return new RecoverFailureDocumentProcessor(randomAlphaOfLength(8), null);
     }
 
     private static IngestDocument createFailureDoc(
@@ -55,8 +55,8 @@ private static IngestDocument createFailureDoc(
         return new IngestDocument(sourceAndMetadata, ingestMetadata);
     }
 
-    public void testRemediate_basic() throws Exception {
-        Processor processor = createRemediateProcessor();
+    public void testRecoverFailureDocument_basic() throws Exception {
+        Processor processor = createRecoverFailureDocumentProcessor();
 
         Map<String, Object> originalSource = new HashMap<>();
         originalSource.put("a", 1);
@@ -80,8 +80,8 @@ public void testRemediate_basic() throws Exception {
         assertThat(doc.hasField("document", true), is(false));
     }
 
-    public void testRemediate_withRouting() throws Exception {
-        Processor processor = createRemediateProcessor();
+    public void testRecoverFailureDocument_withRouting() throws Exception {
+        Processor processor = createRecoverFailureDocumentProcessor();
 
         Map<String, Object> originalSource = new HashMap<>();
         originalSource.put("nested", Map.of("k", "v"));
@@ -97,8 +97,8 @@ public void testRemediate_withRouting() throws Exception {
         assertThat(doc.hasField("document", true), is(false));
     }
 
-    public void testRemediate_missingDocument_throws() {
-        Processor processor = createRemediateProcessor();
+    public void testRecoverFailureDocument_missingDocument_throws() {
+        Processor processor = createRecoverFailureDocumentProcessor();
 
         Map<String, Object> sourceAndMetadata = new HashMap<>();
         sourceAndMetadata.put("_index", "failure-index");
@@ -112,8 +112,8 @@ public void testRemediate_missingDocument_throws() {
         assertThat(e.getMessage(), containsString("document"));
     }
 
-    public void testRemediate_missingSourceInsideDocument_throws() {
-        Processor processor = createRemediateProcessor();
+    public void testRecoverFailureDocument_missingSourceInsideDocument_throws() {
+        Processor processor = createRecoverFailureDocumentProcessor();
 
         Map<String, Object> sourceAndMetadata = new HashMap<>();
         sourceAndMetadata.put("_index", "failure-index");

modules/ingest-common/src/yamlRestTest/resources/rest-api-spec/test/ingest/340_remediate_processor.yml renamed to modules/ingest-common/src/yamlRestTest/resources/rest-api-spec/test/ingest/340_recover_failure_document_processor.yml

@@ -35,20 +35,20 @@ setup:
                 field: count
                 value: "not_a_number"  # This will cause a mapping failure
 
-  # Create a remediation-pipeline with remediate processor
+  # Create a remediation-pipeline with recover_failure_document processor
   - do:
       ingest.put_pipeline:
         id: "remediation_pipeline"
         body:
           description: "Pipeline to remediate failed documents"
           processors:
-            - remediate: {}
+            - recover_failure_document: {}
 
 ---
 teardown:
   - do:
       indices.delete_data_stream:
-        name: test-logs-remediate
+        name: test-logs-recover_failure_document
         ignore: 404
 
   - do:
@@ -67,11 +67,11 @@ teardown:
         ignore: 404
 
 ---
-"Test remediate processor with data stream failure store":
+"Test recover_failure_document processor with data stream failure store":
   # Create the data stream by indexing a document
   - do:
       index:
-        index: test-logs-remediate
+        index: test-logs-recover_failure_document
         routing: custom-route-123
         pipeline: failing_pipeline
         body:
@@ -82,20 +82,20 @@ teardown:
   # Wait for the failure store to be populated
   - do:
       indices.refresh:
-        index: ".fs-test-logs-remediate-*"
+        index: ".fs-test-logs-recover_failure_document-*"
 
   # Check that document went to failure store
   - do:
       search:
-        index: ".fs-test-logs-remediate-*"
+        index: ".fs-test-logs-recover_failure_document-*"
         body:
           query:
             match_all: {}
 
   - match: { hits.total.value: 1 }
   - match: { hits.hits.0._source.document.source.message: "test message" }
   - match: { hits.hits.0._source.document.source.count: "not_a_number" }
-  - match: { hits.hits.0._source.document.index: "test-logs-remediate" }
+  - match: { hits.hits.0._source.document.index: "test-logs-recover_failure_document" }
   - match: { hits.hits.0._source.document.routing: "custom-route-123" }
   - is_true: hits.hits.0._source.error
 
@@ -108,28 +108,28 @@ teardown:
         body:
           pipeline:
             processors:
-              - remediate: {}
+              - recover_failure_document: {}
           docs:
             - _source: $original_source
-              _index: "test-logs-remediate"
+              _index: "test-logs-recover_failure_document"
               _id: "${failure_doc_id}"
 
   # Check that it is using the remediated format
-  - match: { docs.0.doc._index: "test-logs-remediate" }
+  - match: { docs.0.doc._index: "test-logs-recover_failure_document" }
   - match: { docs.0.doc._routing: "custom-route-123" }
   - match: { docs.0.doc._source.message: "test message" }
   - match: { docs.0.doc._source.count: "not_a_number" }
   - is_false: docs.0.doc._source.error
   - is_false: docs.0.doc._source.document
 
 ---
-"Test remediate processor error handling - missing document field":
+"Test recover_failure_document processor error handling - missing document field":
   - do:
       ingest.simulate:
         body:
           pipeline:
             processors:
-              - remediate: {}
+              - recover_failure_document: {}
           docs:
             - _source:
                 error: "simulated failure"
@@ -141,13 +141,13 @@ teardown:
   - match: { docs.0.error.reason: "field [document] not present as part of path [document]" }
 
 ---
-"Test remediate processor error handling - missing source field":
+"Test recover_failure_document processor error handling - missing source field":
   - do:
       ingest.simulate:
         body:
           pipeline:
             processors:
-              - remediate: {}
+              - recover_failure_document: {}
           docs:
             - _source:
                 error: "simulated failure"