Browse Source

[DOCS] Document `on_failure` param for create pipeline API (#70679)

James Rodewig 4 years ago
parent
commit
d7144dedf8
2 changed files with 12 additions and 1 deletions
  1. 3 1
      docs/reference/ingest.asciidoc
  2. 9 0
      docs/reference/ingest/apis/put-pipeline.asciidoc

+ 3 - 1
docs/reference/ingest.asciidoc

@@ -508,7 +508,9 @@ PUT _ingest/pipeline/my-pipeline
 }
 ----
 
-You can also specify `on_failure` for a pipeline.
+You can also specify `on_failure` for a pipeline. If a processor without an
+`on_failure` value fails, {es} uses this pipeline-level parameter as a fallback.
+{es} will not attempt to run the pipeline's remaining processors.
 
 [source,console]
 ----

+ 9 - 0
docs/reference/ingest/apis/put-pipeline.asciidoc

@@ -57,6 +57,15 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 (Optional, string)
 Description of the ingest pipeline.
 
+`on_failure`::
+(Optional, array of <<processors,processor>> objects)
+Processors to run immediately after a processor failure.
++
+Each processor supports a processor-level `on_failure` value. If a processor
+without an `on_failure` value fails, {es} uses this pipeline-level parameter as
+a fallback. The processors in this parameter run sequentially in the order
+specified. {es} will not attempt to run the pipeline's remaining processors.
+
 `processors`::
 (Required, array of <<processors,processor>> objects)
 Processors used to preform transformations on documents before indexing.