elasticsearch/docs/reference/ingest/processors.asciidoc
David Kyle b588d2ddd7
Redact Ingest Processor (#92951)
The Redact processor uses the Grok rules engine to
redact text in the input document that matches the
Grok pattern. For example Email or IP addresses can
be redacted using the definitions from the standard
Grok pattern bank. New patterns can be defined in
the processor configuration
2023-02-07 17:10:07 +00:00

76 lines
2.5 KiB
Text

[[processors]]
== Ingest processor reference
++++
<titleabbrev>Processor reference</titleabbrev>
++++
{es} includes several configurable processors. To get a list of available
processors, use the <<cluster-nodes-info,nodes info>> API.
[source,console]
----
GET _nodes/ingest?filter_path=nodes.*.ingest.processors
----
The pages in this section contain reference documentation for each processor.
[discrete]
[[ingest-process-plugins]]
=== Processor plugins
You can install additional processors as {plugins}/ingest.html[plugins].
You must install any plugin processors on all nodes in your cluster. Otherwise,
{es} will fail to create pipelines containing the processor.
Mark a plugin as mandatory by setting `plugin.mandatory` in
`elasticsearch.yml`. A node will fail to start if a mandatory plugin is not
installed.
[source,yaml]
----
plugin.mandatory: my-ingest-plugin
----
include::processors/append.asciidoc[]
include::processors/attachment.asciidoc[]
include::processors/bytes.asciidoc[]
include::processors/circle.asciidoc[]
include::processors/community-id.asciidoc[]
include::processors/convert.asciidoc[]
include::processors/csv.asciidoc[]
include::processors/date.asciidoc[]
include::processors/date-index-name.asciidoc[]
include::processors/dissect.asciidoc[]
include::processors/dot-expand.asciidoc[]
include::processors/drop.asciidoc[]
include::processors/enrich.asciidoc[]
include::processors/fail.asciidoc[]
include::processors/fingerprint.asciidoc[]
include::processors/foreach.asciidoc[]
include::processors/geo-grid.asciidoc[]
include::processors/geoip.asciidoc[]
include::processors/grok.asciidoc[]
include::processors/gsub.asciidoc[]
include::processors/html_strip.asciidoc[]
include::processors/inference.asciidoc[]
include::processors/join.asciidoc[]
include::processors/json.asciidoc[]
include::processors/kv.asciidoc[]
include::processors/lowercase.asciidoc[]
include::processors/network-direction.asciidoc[]
include::processors/pipeline.asciidoc[]
include::processors/redact.asciidoc[]
include::processors/registered-domain.asciidoc[]
include::processors/remove.asciidoc[]
include::processors/rename.asciidoc[]
include::processors/script.asciidoc[]
include::processors/set.asciidoc[]
include::processors/set-security-user.asciidoc[]
include::processors/sort.asciidoc[]
include::processors/split.asciidoc[]
include::processors/trim.asciidoc[]
include::processors/uppercase.asciidoc[]
include::processors/url-decode.asciidoc[]
include::processors/uri-parts.asciidoc[]
include::processors/user-agent.asciidoc[]