New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Enrich processor Fingerprint processor »
Elastic Docs ›Elasticsearch Guide [8.0] ›Ingest pipelines ›Ingest processor reference

Fail processor

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Fail processor

edit

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

Table 17. 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}}}"
  }
}
« Enrich processor Fingerprint processor »
Was this helpful?
Feedback