From 14e1618fd9a7c11d8bede318feecf512fd6cb320 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 12 Aug 2020 11:49:54 -0400 Subject: [PATCH] [DOCS] Fix case of ingest processor titles (#61024) (#61039) Converts page headings to sentence case. Adds a title abbreviation. --- docs/reference/ingest/processors/append.asciidoc | 7 ++++++- docs/reference/ingest/processors/bytes.asciidoc | 6 +++++- docs/reference/ingest/processors/circle.asciidoc | 6 +++++- docs/reference/ingest/processors/convert.asciidoc | 6 +++++- docs/reference/ingest/processors/csv.asciidoc | 6 +++++- docs/reference/ingest/processors/date-index-name.asciidoc | 5 ++++- docs/reference/ingest/processors/date.asciidoc | 5 ++++- docs/reference/ingest/processors/dissect.asciidoc | 6 +++++- docs/reference/ingest/processors/dot-expand.asciidoc | 5 ++++- docs/reference/ingest/processors/drop.asciidoc | 6 +++++- docs/reference/ingest/processors/enrich.asciidoc | 5 ++++- docs/reference/ingest/processors/fail.asciidoc | 6 +++++- docs/reference/ingest/processors/foreach.asciidoc | 5 ++++- docs/reference/ingest/processors/geoip.asciidoc | 5 ++++- docs/reference/ingest/processors/grok.asciidoc | 5 ++++- docs/reference/ingest/processors/gsub.asciidoc | 6 +++++- docs/reference/ingest/processors/html_strip.asciidoc | 6 +++++- docs/reference/ingest/processors/inference.asciidoc | 5 ++++- docs/reference/ingest/processors/join.asciidoc | 6 +++++- docs/reference/ingest/processors/json.asciidoc | 6 +++++- docs/reference/ingest/processors/kv.asciidoc | 6 +++++- docs/reference/ingest/processors/lowercase.asciidoc | 6 +++++- docs/reference/ingest/processors/pipeline.asciidoc | 6 +++++- docs/reference/ingest/processors/remove.asciidoc | 6 +++++- docs/reference/ingest/processors/rename.asciidoc | 6 +++++- docs/reference/ingest/processors/script.asciidoc | 5 ++++- .../reference/ingest/processors/set-security-user.asciidoc | 6 +++++- docs/reference/ingest/processors/set.asciidoc | 6 +++++- docs/reference/ingest/processors/sort.asciidoc | 6 +++++- docs/reference/ingest/processors/split.asciidoc | 6 +++++- docs/reference/ingest/processors/trim.asciidoc | 6 +++++- docs/reference/ingest/processors/uppercase.asciidoc | 6 +++++- docs/reference/ingest/processors/url-decode.asciidoc | 6 +++++- docs/reference/ingest/processors/user-agent.asciidoc | 5 ++++- 34 files changed, 161 insertions(+), 34 deletions(-) diff --git a/docs/reference/ingest/processors/append.asciidoc b/docs/reference/ingest/processors/append.asciidoc index 1c2dc935116..86c5eb59e23 100644 --- a/docs/reference/ingest/processors/append.asciidoc +++ b/docs/reference/ingest/processors/append.asciidoc @@ -1,5 +1,10 @@ [[append-processor]] -=== Append Processor +=== Append processor +++++ +Append +++++ + + 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. Creates an array containing the provided values if the field doesn't exist. diff --git a/docs/reference/ingest/processors/bytes.asciidoc b/docs/reference/ingest/processors/bytes.asciidoc index 5a551f8a82e..5e8c4c461c1 100644 --- a/docs/reference/ingest/processors/bytes.asciidoc +++ b/docs/reference/ingest/processors/bytes.asciidoc @@ -1,5 +1,9 @@ [[bytes-processor]] -=== Bytes Processor +=== Bytes processor +++++ +Bytes +++++ + 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 diff --git a/docs/reference/ingest/processors/circle.asciidoc b/docs/reference/ingest/processors/circle.asciidoc index 5296c5c3f02..2172b0772e5 100644 --- a/docs/reference/ingest/processors/circle.asciidoc +++ b/docs/reference/ingest/processors/circle.asciidoc @@ -1,7 +1,11 @@ [role="xpack"] [testenv="basic"] [[ingest-circle-processor]] -=== Circle Processor +=== Circle processor +++++ +Circle +++++ + Converts circle definitions of shapes to regular polygons which approximate them. [[circle-processor-options]] diff --git a/docs/reference/ingest/processors/convert.asciidoc b/docs/reference/ingest/processors/convert.asciidoc index 9c439a3c1a9..073c7933647 100644 --- a/docs/reference/ingest/processors/convert.asciidoc +++ b/docs/reference/ingest/processors/convert.asciidoc @@ -1,5 +1,9 @@ [[convert-processor]] -=== Convert Processor +=== Convert processor +++++ +Convert +++++ + 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. diff --git a/docs/reference/ingest/processors/csv.asciidoc b/docs/reference/ingest/processors/csv.asciidoc index 464a835b11c..e032fd3d9a1 100644 --- a/docs/reference/ingest/processors/csv.asciidoc +++ b/docs/reference/ingest/processors/csv.asciidoc @@ -1,5 +1,9 @@ [[csv-processor]] -=== CSV Processor +=== CSV processor +++++ +CSV +++++ + Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped. [[csv-options]] diff --git a/docs/reference/ingest/processors/date-index-name.asciidoc b/docs/reference/ingest/processors/date-index-name.asciidoc index 0d08244078b..e4607a0567c 100644 --- a/docs/reference/ingest/processors/date-index-name.asciidoc +++ b/docs/reference/ingest/processors/date-index-name.asciidoc @@ -1,5 +1,8 @@ [[date-index-name-processor]] -=== Date Index Name Processor +=== Date index name processor +++++ +Date index name +++++ 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 <>. diff --git a/docs/reference/ingest/processors/date.asciidoc b/docs/reference/ingest/processors/date.asciidoc index 78107b33a4d..17fe6794fa5 100644 --- a/docs/reference/ingest/processors/date.asciidoc +++ b/docs/reference/ingest/processors/date.asciidoc @@ -1,5 +1,8 @@ [[date-processor]] -=== Date Processor +=== Date processor +++++ +Date +++++ 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 diff --git a/docs/reference/ingest/processors/dissect.asciidoc b/docs/reference/ingest/processors/dissect.asciidoc index f2a7a42b9d6..feedb4c70cf 100644 --- a/docs/reference/ingest/processors/dissect.asciidoc +++ b/docs/reference/ingest/processors/dissect.asciidoc @@ -1,5 +1,9 @@ [[dissect-processor]] -=== Dissect Processor +=== Dissect processor +++++ +Dissect +++++ + Similar to the <>, dissect also extracts structured fields out of a single text field within a document. However unlike the <>, dissect does not use diff --git a/docs/reference/ingest/processors/dot-expand.asciidoc b/docs/reference/ingest/processors/dot-expand.asciidoc index 1e8eb7da6cf..13cc6e72145 100644 --- a/docs/reference/ingest/processors/dot-expand.asciidoc +++ b/docs/reference/ingest/processors/dot-expand.asciidoc @@ -1,5 +1,8 @@ [[dot-expand-processor]] -=== Dot Expander Processor +=== Dot expander processor +++++ +Dot expander +++++ 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. diff --git a/docs/reference/ingest/processors/drop.asciidoc b/docs/reference/ingest/processors/drop.asciidoc index e763c13be2c..18d9d311ac0 100644 --- a/docs/reference/ingest/processors/drop.asciidoc +++ b/docs/reference/ingest/processors/drop.asciidoc @@ -1,5 +1,9 @@ [[drop-processor]] -=== Drop Processor +=== Drop processor +++++ +Drop +++++ + Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition. diff --git a/docs/reference/ingest/processors/enrich.asciidoc b/docs/reference/ingest/processors/enrich.asciidoc index fee2cf79740..26fb2f1769c 100644 --- a/docs/reference/ingest/processors/enrich.asciidoc +++ b/docs/reference/ingest/processors/enrich.asciidoc @@ -1,7 +1,10 @@ [role="xpack"] [testenv="basic"] [[enrich-processor]] -=== Enrich Processor +=== Enrich processor +++++ +Enrich +++++ The `enrich` processor can enrich documents with data from another index. See <> section for more information about how to set this up. diff --git a/docs/reference/ingest/processors/fail.asciidoc b/docs/reference/ingest/processors/fail.asciidoc index c33c0b754fa..4446b941db3 100644 --- a/docs/reference/ingest/processors/fail.asciidoc +++ b/docs/reference/ingest/processors/fail.asciidoc @@ -1,5 +1,9 @@ [[fail-processor]] -=== Fail Processor +=== Fail processor +++++ +Fail +++++ + Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester. diff --git a/docs/reference/ingest/processors/foreach.asciidoc b/docs/reference/ingest/processors/foreach.asciidoc index 69bf2d85f0d..7a8c29ff24a 100644 --- a/docs/reference/ingest/processors/foreach.asciidoc +++ b/docs/reference/ingest/processors/foreach.asciidoc @@ -1,5 +1,8 @@ [[foreach-processor]] -=== Foreach Processor +=== Foreach processor +++++ +Foreach +++++ Processes elements in an array of unknown length. diff --git a/docs/reference/ingest/processors/geoip.asciidoc b/docs/reference/ingest/processors/geoip.asciidoc index b4414800629..c34e326c36d 100644 --- a/docs/reference/ingest/processors/geoip.asciidoc +++ b/docs/reference/ingest/processors/geoip.asciidoc @@ -1,5 +1,8 @@ [[geoip-processor]] -=== GeoIP Processor +=== GeoIP processor +++++ +GeoIP +++++ 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 diff --git a/docs/reference/ingest/processors/grok.asciidoc b/docs/reference/ingest/processors/grok.asciidoc index fd3e2b2c95a..70abdebfa6e 100644 --- a/docs/reference/ingest/processors/grok.asciidoc +++ b/docs/reference/ingest/processors/grok.asciidoc @@ -1,5 +1,8 @@ [[grok-processor]] -=== Grok Processor +=== Grok processor +++++ +Grok +++++ 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 diff --git a/docs/reference/ingest/processors/gsub.asciidoc b/docs/reference/ingest/processors/gsub.asciidoc index 2defa6e7cd1..96e01694416 100644 --- a/docs/reference/ingest/processors/gsub.asciidoc +++ b/docs/reference/ingest/processors/gsub.asciidoc @@ -1,5 +1,9 @@ [[gsub-processor]] -=== Gsub Processor +=== Gsub processor +++++ +Gsub +++++ + 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. diff --git a/docs/reference/ingest/processors/html_strip.asciidoc b/docs/reference/ingest/processors/html_strip.asciidoc index bd4e8e8ccd9..6e95015d253 100644 --- a/docs/reference/ingest/processors/html_strip.asciidoc +++ b/docs/reference/ingest/processors/html_strip.asciidoc @@ -1,5 +1,9 @@ [[htmlstrip-processor]] -=== HTML Strip Processor +=== HTML strip processor +++++ +HTML strip +++++ + 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. diff --git a/docs/reference/ingest/processors/inference.asciidoc b/docs/reference/ingest/processors/inference.asciidoc index f0e0acda894..f35e64755aa 100644 --- a/docs/reference/ingest/processors/inference.asciidoc +++ b/docs/reference/ingest/processors/inference.asciidoc @@ -1,7 +1,10 @@ [role="xpack"] [testenv="basic"] [[inference-processor]] -=== {infer-cap} Processor +=== {infer-cap} processor +++++ +{infer-cap} +++++ Uses a pre-trained {dfanalytics} model to infer against the data that is being ingested in the pipeline. diff --git a/docs/reference/ingest/processors/join.asciidoc b/docs/reference/ingest/processors/join.asciidoc index a31f0eee7c1..ca0bdaa8aed 100644 --- a/docs/reference/ingest/processors/join.asciidoc +++ b/docs/reference/ingest/processors/join.asciidoc @@ -1,5 +1,9 @@ [[join-processor]] -=== Join Processor +=== Join processor +++++ +Join +++++ + 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. diff --git a/docs/reference/ingest/processors/json.asciidoc b/docs/reference/ingest/processors/json.asciidoc index bbbd18e8337..6d2b141abd5 100644 --- a/docs/reference/ingest/processors/json.asciidoc +++ b/docs/reference/ingest/processors/json.asciidoc @@ -1,5 +1,9 @@ [[json-processor]] -=== JSON Processor +=== JSON processor +++++ +JSON +++++ + Converts a JSON string into a structured JSON object. [[json-options]] diff --git a/docs/reference/ingest/processors/kv.asciidoc b/docs/reference/ingest/processors/kv.asciidoc index 18181d3036a..f8e251925af 100644 --- a/docs/reference/ingest/processors/kv.asciidoc +++ b/docs/reference/ingest/processors/kv.asciidoc @@ -1,5 +1,9 @@ [[kv-processor]] -=== KV Processor +=== KV processor +++++ +KV +++++ + 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: diff --git a/docs/reference/ingest/processors/lowercase.asciidoc b/docs/reference/ingest/processors/lowercase.asciidoc index 903d6962535..2e95b1eca6c 100644 --- a/docs/reference/ingest/processors/lowercase.asciidoc +++ b/docs/reference/ingest/processors/lowercase.asciidoc @@ -1,5 +1,9 @@ [[lowercase-processor]] -=== Lowercase Processor +=== Lowercase processor +++++ +Lowercase +++++ + 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]] diff --git a/docs/reference/ingest/processors/pipeline.asciidoc b/docs/reference/ingest/processors/pipeline.asciidoc index 958ff90a451..a663b704292 100644 --- a/docs/reference/ingest/processors/pipeline.asciidoc +++ b/docs/reference/ingest/processors/pipeline.asciidoc @@ -1,5 +1,9 @@ [[pipeline-processor]] -=== Pipeline Processor +=== Pipeline processor +++++ +Pipeline +++++ + Executes another pipeline. [[pipeline-options]] diff --git a/docs/reference/ingest/processors/remove.asciidoc b/docs/reference/ingest/processors/remove.asciidoc index a3f539a6cc3..57e785c2de7 100644 --- a/docs/reference/ingest/processors/remove.asciidoc +++ b/docs/reference/ingest/processors/remove.asciidoc @@ -1,5 +1,9 @@ [[remove-processor]] -=== Remove Processor +=== Remove processor +++++ +Remove +++++ + Removes existing fields. If one field doesn't exist, an exception will be thrown. [[remove-options]] diff --git a/docs/reference/ingest/processors/rename.asciidoc b/docs/reference/ingest/processors/rename.asciidoc index 7f690367fa3..538cfb048a8 100644 --- a/docs/reference/ingest/processors/rename.asciidoc +++ b/docs/reference/ingest/processors/rename.asciidoc @@ -1,5 +1,9 @@ [[rename-processor]] -=== Rename Processor +=== Rename processor +++++ +Rename +++++ + Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown. [[rename-options]] diff --git a/docs/reference/ingest/processors/script.asciidoc b/docs/reference/ingest/processors/script.asciidoc index 04b30ae582c..3453a966133 100644 --- a/docs/reference/ingest/processors/script.asciidoc +++ b/docs/reference/ingest/processors/script.asciidoc @@ -1,5 +1,8 @@ [[script-processor]] -=== Script Processor +=== Script processor +++++ +Script +++++ Allows inline and stored scripts to be executed within ingest pipelines. diff --git a/docs/reference/ingest/processors/set-security-user.asciidoc b/docs/reference/ingest/processors/set-security-user.asciidoc index 774c1682052..cd348e2d9bc 100644 --- a/docs/reference/ingest/processors/set-security-user.asciidoc +++ b/docs/reference/ingest/processors/set-security-user.asciidoc @@ -1,5 +1,9 @@ [[ingest-node-set-security-user-processor]] -=== Set Security User Processor +=== Set security user processor +++++ +Set security user +++++ + Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest. diff --git a/docs/reference/ingest/processors/set.asciidoc b/docs/reference/ingest/processors/set.asciidoc index 22a9fb4c5cd..e445bfaf229 100644 --- a/docs/reference/ingest/processors/set.asciidoc +++ b/docs/reference/ingest/processors/set.asciidoc @@ -1,5 +1,9 @@ [[set-processor]] -=== Set Processor +=== Set processor +++++ +Set +++++ + Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one. diff --git a/docs/reference/ingest/processors/sort.asciidoc b/docs/reference/ingest/processors/sort.asciidoc index 455b32dca5a..81999d2d903 100644 --- a/docs/reference/ingest/processors/sort.asciidoc +++ b/docs/reference/ingest/processors/sort.asciidoc @@ -1,5 +1,9 @@ [[sort-processor]] -=== Sort Processor +=== Sort processor +++++ +Sort +++++ + 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. Throws an error when the field is not an array. diff --git a/docs/reference/ingest/processors/split.asciidoc b/docs/reference/ingest/processors/split.asciidoc index 60b82fdaa94..39e73b589f7 100644 --- a/docs/reference/ingest/processors/split.asciidoc +++ b/docs/reference/ingest/processors/split.asciidoc @@ -1,5 +1,9 @@ [[split-processor]] -=== Split Processor +=== Split processor +++++ +Split +++++ + Splits a field into an array using a separator character. Only works on string fields. [[split-options]] diff --git a/docs/reference/ingest/processors/trim.asciidoc b/docs/reference/ingest/processors/trim.asciidoc index ef3611161e2..5b7c80ea803 100644 --- a/docs/reference/ingest/processors/trim.asciidoc +++ b/docs/reference/ingest/processors/trim.asciidoc @@ -1,5 +1,9 @@ [[trim-processor]] -=== Trim Processor +=== Trim processor +++++ +Trim +++++ + 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. diff --git a/docs/reference/ingest/processors/uppercase.asciidoc b/docs/reference/ingest/processors/uppercase.asciidoc index 3e26cedcf9c..6d334373d9c 100644 --- a/docs/reference/ingest/processors/uppercase.asciidoc +++ b/docs/reference/ingest/processors/uppercase.asciidoc @@ -1,5 +1,9 @@ [[uppercase-processor]] -=== Uppercase Processor +=== Uppercase processor +++++ +Uppercase +++++ + 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]] diff --git a/docs/reference/ingest/processors/url-decode.asciidoc b/docs/reference/ingest/processors/url-decode.asciidoc index 268fce1c18c..5810fff90b0 100644 --- a/docs/reference/ingest/processors/url-decode.asciidoc +++ b/docs/reference/ingest/processors/url-decode.asciidoc @@ -1,5 +1,9 @@ [[urldecode-processor]] -=== URL Decode Processor +=== URL decode processor +++++ +URL decode +++++ + URL-decodes a string. If the field is an array of strings, all members of the array will be decoded. [[urldecode-options]] diff --git a/docs/reference/ingest/processors/user-agent.asciidoc b/docs/reference/ingest/processors/user-agent.asciidoc index ac5d4ef6af9..073a02fef38 100644 --- a/docs/reference/ingest/processors/user-agent.asciidoc +++ b/docs/reference/ingest/processors/user-agent.asciidoc @@ -1,5 +1,8 @@ [[user-agent-processor]] -=== User Agent processor +=== User agent processor +++++ +User agent +++++ 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.