Converts page headings to sentence case. Adds a title abbreviation.
This commit is contained in:
parent
32173a82c8
commit
14e1618fd9
|
@ -1,5 +1,10 @@
|
||||||
[[append-processor]]
|
[[append-processor]]
|
||||||
=== Append Processor
|
=== Append processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Append</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
|
|
||||||
Appends one or more values to an existing array if the field already exists and it is an array.
|
Appends one or more values to an existing array if the field already exists and it is an array.
|
||||||
Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.
|
Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.
|
||||||
Creates an array containing the provided values if the field doesn't exist.
|
Creates an array containing the provided values if the field doesn't exist.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[bytes-processor]]
|
[[bytes-processor]]
|
||||||
=== Bytes Processor
|
=== Bytes processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Bytes</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.
|
Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.
|
||||||
|
|
||||||
Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if
|
Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if
|
||||||
|
|
|
@ -1,7 +1,11 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="basic"]
|
[testenv="basic"]
|
||||||
[[ingest-circle-processor]]
|
[[ingest-circle-processor]]
|
||||||
=== Circle Processor
|
=== Circle processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Circle</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts circle definitions of shapes to regular polygons which approximate them.
|
Converts circle definitions of shapes to regular polygons which approximate them.
|
||||||
|
|
||||||
[[circle-processor-options]]
|
[[circle-processor-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[convert-processor]]
|
[[convert-processor]]
|
||||||
=== Convert Processor
|
=== Convert processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Convert</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a field in the currently ingested document to a different type, such as converting a string to an integer.
|
Converts a field in the currently ingested document to a different type, such as converting a string to an integer.
|
||||||
If the field value is an array, all members will be converted.
|
If the field value is an array, all members will be converted.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[csv-processor]]
|
[[csv-processor]]
|
||||||
=== CSV Processor
|
=== CSV processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>CSV</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.
|
Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.
|
||||||
|
|
||||||
[[csv-options]]
|
[[csv-options]]
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[date-index-name-processor]]
|
[[date-index-name-processor]]
|
||||||
=== Date Index Name Processor
|
=== Date index name processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Date index name</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The purpose of this processor is to point documents to the right time based index based
|
The purpose of this processor is to point documents to the right time based index based
|
||||||
on a date or timestamp field in a document by using the <<date-math-index-names, date math index name support>>.
|
on a date or timestamp field in a document by using the <<date-math-index-names, date math index name support>>.
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[date-processor]]
|
[[date-processor]]
|
||||||
=== Date Processor
|
=== Date processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Date</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.
|
Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.
|
||||||
By default, the date processor adds the parsed date as a new field called `@timestamp`. You can specify a
|
By default, the date processor adds the parsed date as a new field called `@timestamp`. You can specify a
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[dissect-processor]]
|
[[dissect-processor]]
|
||||||
=== Dissect Processor
|
=== Dissect processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Dissect</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
|
|
||||||
Similar to the <<grok-processor,Grok Processor>>, dissect also extracts structured fields out of a single text field
|
Similar to the <<grok-processor,Grok Processor>>, dissect also extracts structured fields out of a single text field
|
||||||
within a document. However unlike the <<grok-processor,Grok Processor>>, dissect does not use
|
within a document. However unlike the <<grok-processor,Grok Processor>>, dissect does not use
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[dot-expand-processor]]
|
[[dot-expand-processor]]
|
||||||
=== Dot Expander Processor
|
=== Dot expander processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Dot expander</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Expands a field with dots into an object field. This processor allows fields
|
Expands a field with dots into an object field. This processor allows fields
|
||||||
with dots in the name to be accessible by other processors in the pipeline.
|
with dots in the name to be accessible by other processors in the pipeline.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[drop-processor]]
|
[[drop-processor]]
|
||||||
=== Drop Processor
|
=== Drop processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Drop</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Drops the document without raising any errors. This is useful to prevent the document from
|
Drops the document without raising any errors. This is useful to prevent the document from
|
||||||
getting indexed based on some condition.
|
getting indexed based on some condition.
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,10 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="basic"]
|
[testenv="basic"]
|
||||||
[[enrich-processor]]
|
[[enrich-processor]]
|
||||||
=== Enrich Processor
|
=== Enrich processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Enrich</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The `enrich` processor can enrich documents with data from another index.
|
The `enrich` processor can enrich documents with data from another index.
|
||||||
See <<ingest-enriching-data,enrich data>> section for more information about how to set this up.
|
See <<ingest-enriching-data,enrich data>> section for more information about how to set this up.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[fail-processor]]
|
[[fail-processor]]
|
||||||
=== Fail Processor
|
=== Fail processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Fail</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Raises an exception. This is useful for when
|
Raises an exception. This is useful for when
|
||||||
you expect a pipeline to fail and want to relay a specific message
|
you expect a pipeline to fail and want to relay a specific message
|
||||||
to the requester.
|
to the requester.
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[foreach-processor]]
|
[[foreach-processor]]
|
||||||
=== Foreach Processor
|
=== Foreach processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Foreach</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Processes elements in an array of unknown length.
|
Processes elements in an array of unknown length.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[geoip-processor]]
|
[[geoip-processor]]
|
||||||
=== GeoIP Processor
|
=== GeoIP processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>GeoIP</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The `geoip` processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases.
|
The `geoip` processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases.
|
||||||
This processor adds this information by default under the `geoip` field. The `geoip` processor can resolve both IPv4 and
|
This processor adds this information by default under the `geoip` field. The `geoip` processor can resolve both IPv4 and
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[grok-processor]]
|
[[grok-processor]]
|
||||||
=== Grok Processor
|
=== Grok processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Grok</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Extracts structured fields out of a single text field within a document. You choose which field to
|
Extracts structured fields out of a single text field within a document. You choose which field to
|
||||||
extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular
|
extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[gsub-processor]]
|
[[gsub-processor]]
|
||||||
=== Gsub Processor
|
=== Gsub processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Gsub</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a string field by applying a regular expression and a replacement.
|
Converts a string field by applying a regular expression and a replacement.
|
||||||
If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception.
|
If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[htmlstrip-processor]]
|
[[htmlstrip-processor]]
|
||||||
=== HTML Strip Processor
|
=== HTML strip processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>HTML strip</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array.
|
Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array.
|
||||||
|
|
||||||
NOTE: Each HTML tag is replaced with a `\n` character.
|
NOTE: Each HTML tag is replaced with a `\n` character.
|
||||||
|
|
|
@ -1,7 +1,10 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="basic"]
|
[testenv="basic"]
|
||||||
[[inference-processor]]
|
[[inference-processor]]
|
||||||
=== {infer-cap} Processor
|
=== {infer-cap} processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>{infer-cap}</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Uses a pre-trained {dfanalytics} model to infer against the data that is being
|
Uses a pre-trained {dfanalytics} model to infer against the data that is being
|
||||||
ingested in the pipeline.
|
ingested in the pipeline.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[join-processor]]
|
[[join-processor]]
|
||||||
=== Join Processor
|
=== Join processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Join</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Joins each element of an array into a single string using a separator character between each element.
|
Joins each element of an array into a single string using a separator character between each element.
|
||||||
Throws an error when the field is not an array.
|
Throws an error when the field is not an array.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[json-processor]]
|
[[json-processor]]
|
||||||
=== JSON Processor
|
=== JSON processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>JSON</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a JSON string into a structured JSON object.
|
Converts a JSON string into a structured JSON object.
|
||||||
|
|
||||||
[[json-options]]
|
[[json-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[kv-processor]]
|
[[kv-processor]]
|
||||||
=== KV Processor
|
=== KV processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>KV</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.
|
This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.
|
||||||
|
|
||||||
For example, if you have a log message which contains `ip=1.2.3.4 error=REFUSED`, you can parse those fields automatically by configuring:
|
For example, if you have a log message which contains `ip=1.2.3.4 error=REFUSED`, you can parse those fields automatically by configuring:
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[lowercase-processor]]
|
[[lowercase-processor]]
|
||||||
=== Lowercase Processor
|
=== Lowercase processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Lowercase</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted.
|
Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted.
|
||||||
|
|
||||||
[[lowercase-options]]
|
[[lowercase-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[pipeline-processor]]
|
[[pipeline-processor]]
|
||||||
=== Pipeline Processor
|
=== Pipeline processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Pipeline</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Executes another pipeline.
|
Executes another pipeline.
|
||||||
|
|
||||||
[[pipeline-options]]
|
[[pipeline-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[remove-processor]]
|
[[remove-processor]]
|
||||||
=== Remove Processor
|
=== Remove processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Remove</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Removes existing fields. If one field doesn't exist, an exception will be thrown.
|
Removes existing fields. If one field doesn't exist, an exception will be thrown.
|
||||||
|
|
||||||
[[remove-options]]
|
[[remove-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[rename-processor]]
|
[[rename-processor]]
|
||||||
=== Rename Processor
|
=== Rename processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Rename</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.
|
Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.
|
||||||
|
|
||||||
[[rename-options]]
|
[[rename-options]]
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[script-processor]]
|
[[script-processor]]
|
||||||
=== Script Processor
|
=== Script processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Script</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Allows inline and stored scripts to be executed within ingest pipelines.
|
Allows inline and stored scripts to be executed within ingest pipelines.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[ingest-node-set-security-user-processor]]
|
[[ingest-node-set-security-user-processor]]
|
||||||
=== Set Security User Processor
|
=== Set security user processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Set security user</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Sets user-related details (such as `username`, `roles`, `email`, `full_name`,
|
Sets user-related details (such as `username`, `roles`, `email`, `full_name`,
|
||||||
`metadata`, `api_key`, `realm` and `authentication_type`) from the current
|
`metadata`, `api_key`, `realm` and `authentication_type`) from the current
|
||||||
authenticated user to the current document by pre-processing the ingest.
|
authenticated user to the current document by pre-processing the ingest.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[set-processor]]
|
[[set-processor]]
|
||||||
=== Set Processor
|
=== Set processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Set</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Sets one field and associates it with the specified value. If the field already exists,
|
Sets one field and associates it with the specified value. If the field already exists,
|
||||||
its value will be replaced with the provided one.
|
its value will be replaced with the provided one.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[sort-processor]]
|
[[sort-processor]]
|
||||||
=== Sort Processor
|
=== Sort processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Sort</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted
|
Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted
|
||||||
numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.
|
numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.
|
||||||
Throws an error when the field is not an array.
|
Throws an error when the field is not an array.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[split-processor]]
|
[[split-processor]]
|
||||||
=== Split Processor
|
=== Split processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Split</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Splits a field into an array using a separator character. Only works on string fields.
|
Splits a field into an array using a separator character. Only works on string fields.
|
||||||
|
|
||||||
[[split-options]]
|
[[split-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[trim-processor]]
|
[[trim-processor]]
|
||||||
=== Trim Processor
|
=== Trim processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Trim</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Trims whitespace from field. If the field is an array of strings, all members of the array will be trimmed.
|
Trims whitespace from field. If the field is an array of strings, all members of the array will be trimmed.
|
||||||
|
|
||||||
NOTE: This only works on leading and trailing whitespace.
|
NOTE: This only works on leading and trailing whitespace.
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[uppercase-processor]]
|
[[uppercase-processor]]
|
||||||
=== Uppercase Processor
|
=== Uppercase processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>Uppercase</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted.
|
Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted.
|
||||||
|
|
||||||
[[uppercase-options]]
|
[[uppercase-options]]
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
[[urldecode-processor]]
|
[[urldecode-processor]]
|
||||||
=== URL Decode Processor
|
=== URL decode processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>URL decode</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
URL-decodes a string. If the field is an array of strings, all members of the array will be decoded.
|
URL-decodes a string. If the field is an array of strings, all members of the array will be decoded.
|
||||||
|
|
||||||
[[urldecode-options]]
|
[[urldecode-options]]
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[user-agent-processor]]
|
[[user-agent-processor]]
|
||||||
=== User Agent processor
|
=== User agent processor
|
||||||
|
++++
|
||||||
|
<titleabbrev>User agent</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.
|
The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.
|
||||||
This processor adds this information by default under the `user_agent` field.
|
This processor adds this information by default under the `user_agent` field.
|
||||||
|
|
Loading…
Reference in New Issue