elasticsearch/docs/reference/enrich-processor/fail-processor.md
Colleen McGinnis 9bcd59596d
[docs] Prepare for docs-assembler (#125118)
* reorg files for docs-assembler and create toc.yml files

* fix build error, add redirects

* only toc

* move images
2025-03-20 12:09:12 -05:00

1.5 KiB

navigation_title mapped_pages
Fail
https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html

Fail processor [fail-processor]

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

$$$fail-options$

Name Required Default Description
message yes - The error message thrown by the processor. Supports template snippets.
description no - Description of the processor. Useful for describing the purpose of the processor or its configuration.
if no - Conditionally execute the processor. See Conditionally run a processor.
ignore_failure no false Ignore failures for the processor. See Handling pipeline failures.
on_failure no - Handle failures for the processor. See Handling pipeline failures.
tag no - Identifier for the processor. Useful for debugging and metrics.
{
  "fail": {
    "if" : "ctx.tags.contains('production') != true",
    "message": "The production tag is not present, found tags: {{{tags}}}"
  }
}