From 86161a3321c7eb560af44d61706deacadd57a8a7 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 22 Dec 2023 14:42:08 -0700 Subject: [PATCH 01/16] Add user agent processor documentation Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 86 ++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 _ingest-pipelines/processors/user-agent.md diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md new file mode 100644 index 0000000000..81e8809d77 --- /dev/null +++ b/_ingest-pipelines/processors/user-agent.md @@ -0,0 +1,86 @@ +--- +layout: default +title: User agent +parent: Ingest processors +nav_order: 320 +--- + +# User agent processor + +The `user_agent` processor is used to . + +The following is the syntax for the `user_agent` processor: + +```json + +``` +{% include copy-curl.html %} + +## Configuration parameters + +The following table lists the required and optional parameters for the `user_agent` processor. + +Parameter | Required/Optional | Description | +|-----------|-----------|-----------| + + +## Using the processor + +Follow these steps to use the processor in a pipeline. + +### Step 1: Create a pipeline + +The following query creates a pipeline, named , that uses the `user_agent` processor to : + +```json + +``` +{% include copy-curl.html %} + +### Step 2 (Optional): Test the pipeline + +It is recommended that you test your pipeline before you ingest documents. +{: .tip} + +To test the pipeline, run the following query: + +```json + +``` +{% include copy-curl.html %} + +#### Response + +The following example response confirms that the pipeline is working as expected: + +```json + +``` + +### Step 3: Ingest a document + +The following query ingests a document into an index named `testindex1`: + +```json + +``` +{% include copy-curl.html %} + +#### Response + +The request indexes the document into the index and will index all documents with . + +```json + +``` + +### Step 4 (Optional): Retrieve the document + +To retrieve the document, run the following query: + +```json + +``` +{% include copy-curl.html %} + + \ No newline at end of file From 02b38bec59e44deb7d0449eddc1565d715e224e8 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 22 Dec 2023 14:43:51 -0700 Subject: [PATCH 02/16] Add user agent processor documentation Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 81e8809d77..4d07aab82f 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -2,7 +2,7 @@ layout: default title: User agent parent: Ingest processors -nav_order: 320 +nav_order: 330 --- # User agent processor From 8f77a67c482bb549c1b893c7ff63db669c0db4ea Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Thu, 25 Apr 2024 15:30:30 -0600 Subject: [PATCH 03/16] Add examples Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 4d07aab82f..d18e87b52f 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -7,12 +7,19 @@ nav_order: 330 # User agent processor -The `user_agent` processor is used to . +The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. The following is the syntax for the `user_agent` processor: ```json - +{ + "processor": { + "user_agent": { + "field": "user_agent", + "target_field": "user_agent_info" + } + } +} ``` {% include copy-curl.html %} @@ -22,7 +29,9 @@ The following table lists the required and optional parameters for the `user_age Parameter | Required/Optional | Description | |-----------|-----------|-----------| - +`field` | Required | The field containing the user agent string. +`target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. + ## Using the processor From 48c5aac64b5d3ddcf2840640839aab0d956bf3e4 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 22 Dec 2023 14:42:08 -0700 Subject: [PATCH 04/16] Add user agent processor documentation Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 86 ++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 _ingest-pipelines/processors/user-agent.md diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md new file mode 100644 index 0000000000..81e8809d77 --- /dev/null +++ b/_ingest-pipelines/processors/user-agent.md @@ -0,0 +1,86 @@ +--- +layout: default +title: User agent +parent: Ingest processors +nav_order: 320 +--- + +# User agent processor + +The `user_agent` processor is used to . + +The following is the syntax for the `user_agent` processor: + +```json + +``` +{% include copy-curl.html %} + +## Configuration parameters + +The following table lists the required and optional parameters for the `user_agent` processor. + +Parameter | Required/Optional | Description | +|-----------|-----------|-----------| + + +## Using the processor + +Follow these steps to use the processor in a pipeline. + +### Step 1: Create a pipeline + +The following query creates a pipeline, named , that uses the `user_agent` processor to : + +```json + +``` +{% include copy-curl.html %} + +### Step 2 (Optional): Test the pipeline + +It is recommended that you test your pipeline before you ingest documents. +{: .tip} + +To test the pipeline, run the following query: + +```json + +``` +{% include copy-curl.html %} + +#### Response + +The following example response confirms that the pipeline is working as expected: + +```json + +``` + +### Step 3: Ingest a document + +The following query ingests a document into an index named `testindex1`: + +```json + +``` +{% include copy-curl.html %} + +#### Response + +The request indexes the document into the index and will index all documents with . + +```json + +``` + +### Step 4 (Optional): Retrieve the document + +To retrieve the document, run the following query: + +```json + +``` +{% include copy-curl.html %} + + \ No newline at end of file From 33cb9ddbba867a1ef0041bf3bdc4dcd12339a65f Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 22 Dec 2023 14:43:51 -0700 Subject: [PATCH 05/16] Add user agent processor documentation Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 81e8809d77..4d07aab82f 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -2,7 +2,7 @@ layout: default title: User agent parent: Ingest processors -nav_order: 320 +nav_order: 330 --- # User agent processor From f8bc41cfa31c0db1ffc0bbf8363a2514095ce45b Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Thu, 25 Apr 2024 15:30:30 -0600 Subject: [PATCH 06/16] Add examples Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 4d07aab82f..d18e87b52f 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -7,12 +7,19 @@ nav_order: 330 # User agent processor -The `user_agent` processor is used to . +The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. The following is the syntax for the `user_agent` processor: ```json - +{ + "processor": { + "user_agent": { + "field": "user_agent", + "target_field": "user_agent_info" + } + } +} ``` {% include copy-curl.html %} @@ -22,7 +29,9 @@ The following table lists the required and optional parameters for the `user_age Parameter | Required/Optional | Description | |-----------|-----------|-----------| - +`field` | Required | The field containing the user agent string. +`target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. + ## Using the processor From f52cd78a7575fd30416a25db7bfdfd2322646946 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Thu, 25 Apr 2024 15:51:39 -0600 Subject: [PATCH 07/16] Add examples and text Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 121 +++++++++++++++++++-- 1 file changed, 110 insertions(+), 11 deletions(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index d18e87b52f..a37de9c90f 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -7,7 +7,7 @@ nav_order: 330 # User agent processor -The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. +The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. The user_agent processor is particularly useful for analyzing user behavior and identifying trends based on the devices, operating systems, and browsers used by your users. It can also be helpful for troubleshooting issues that may be specific to certain user agent configurations. The following is the syntax for the `user_agent` processor: @@ -31,7 +31,13 @@ Parameter | Required/Optional | Description | |-----------|-----------|-----------| `field` | Required | The field containing the user agent string. `target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. - +`ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | +`override_target` | Optional | Determines what happens when `target_field` exists in the document. If set to `true`, the processor overwrites the existing `target_field` value with the new value. If set to `false`, the existing value remains and the processor does not overwrite it. Default is `false`. | +`description` | Optional | A brief description of the processor. | +`if` | Optional | A condition for running the processor. | +`ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. | +`on_failure` | Optional | A list of processors to run if the processor fails. | +`tag` | Optional | An identifier tag for the processor. Useful for debugging in order to distinguish between processors of the same type. | ## Using the processor @@ -39,10 +45,21 @@ Follow these steps to use the processor in a pipeline. ### Step 1: Create a pipeline -The following query creates a pipeline, named , that uses the `user_agent` processor to : +The following query creates a pipeline named `user_agent_pipeline` that uses the `user_agent` processor to to extract user agent information: ```json - +PUT _ingest/pipeline/user_agent_pipeline +{ + "description": "User agent pipeline", + "processors": [ + { + "user_agent": { + "field": "user_agent", + "target_field": "user_agent_info" + } + } + ] +} ``` {% include copy-curl.html %} @@ -54,7 +71,17 @@ It is recommended that you test your pipeline before you ingest documents. To test the pipeline, run the following query: ```json - +POST _ingest/pipeline/user_agent_pipeline/_simulate +{ + "pipeline": "user_agent_pipeline", + "docs": [ + { + "_source": { + "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3" + } + } + ] +} ``` {% include copy-curl.html %} @@ -63,7 +90,35 @@ To test the pipeline, run the following query: The following example response confirms that the pipeline is working as expected: ```json - +{ + "docs": [ + { + "doc": { + "_index": "_index", + "_id": "_id", + "_source": { + "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3", + "user_agent_info": { + "name": "Chrome", + "original": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3", + "os": { + "name": "Windows", + "version": "10", + "full": "Windows 10" + }, + "device": { + "name": "Other" + }, + "version": "58.0.3029.110" + } + }, + "_ingest": { + "timestamp": "2024-04-25T21:41:28.744407425Z" + } + } + } + ] +} ``` ### Step 3: Ingest a document @@ -71,16 +126,31 @@ The following example response confirms that the pipeline is working as expected The following query ingests a document into an index named `testindex1`: ```json - +PUT testindex1/_doc/1?pipeline=user_agent_pipeline +{ + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" +} ``` {% include copy-curl.html %} #### Response -The request indexes the document into the index and will index all documents with . +The request indexes the document into the index `testindex1` and will index all documents with the user agent string parsed into it components: ```json - +{ + "_index": "testindex1", + "_id": "1", + "_version": 66, + "result": "updated", + "_shards": { + "total": 2, + "successful": 1, + "failed": 0 + }, + "_seq_no": 65, + "_primary_term": 47 +} ``` ### Step 4 (Optional): Retrieve the document @@ -88,8 +158,37 @@ The request indexes the document into the index and will index all To retrieve the document, run the following query: ```json - +GET testindex1/_doc/1 ``` {% include copy-curl.html %} - \ No newline at end of file +#### Response + +The response includes the original `user_agent` field and the parsed `user_agent_info` field with the device, operating system, and browser information: + +```json +{ + "_index": "testindex1", + "_id": "1", + "_version": 66, + "_seq_no": 65, + "_primary_term": 47, + "found": true, + "_source": { + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36", + "user_agent_info": { + "original": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36", + "os": { + "name": "Mac OS X", + "version": "10.15.7", + "full": "Mac OS X 10.15.7" + }, + "name": "Chrome", + "device": { + "name": "Mac" + }, + "version": "90.0.4430.212" + } + } +} +``` \ No newline at end of file From 65d10551003950708ec8005bca5928028fac63bb Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 26 Apr 2024 13:50:51 -0600 Subject: [PATCH 08/16] Update user-agent.md Signed-off-by: Melissa Vagi Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index a37de9c90f..902ecf80b5 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -32,7 +32,8 @@ Parameter | Required/Optional | Description | `field` | Required | The field containing the user agent string. `target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. `ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | -`override_target` | Optional | Determines what happens when `target_field` exists in the document. If set to `true`, the processor overwrites the existing `target_field` value with the new value. If set to `false`, the existing value remains and the processor does not overwrite it. Default is `false`. | +`regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, the default file `regexes.yaml` shipped with OpenSearch is used. You can find the default file at `regexes.yaml`. +`properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are ["name", "major", "minor", "patch", "build", "os", "os_name", "os_major", "os_minor", "device"]. `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. | @@ -191,4 +192,4 @@ The response includes the original `user_agent` field and the parsed `user_agent } } } -``` \ No newline at end of file +``` From 9ed7e91711c4124c9bf35e7ba103537ee4c7b05f Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Fri, 26 Apr 2024 13:52:30 -0600 Subject: [PATCH 09/16] Update user-agent.md Signed-off-by: Melissa Vagi Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 902ecf80b5..b7844623e1 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -33,7 +33,7 @@ Parameter | Required/Optional | Description | `target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. `ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | `regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, the default file `regexes.yaml` shipped with OpenSearch is used. You can find the default file at `regexes.yaml`. -`properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are ["name", "major", "minor", "patch", "build", "os", "os_name", "os_major", "os_minor", "device"]. +`properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. | From 15403cdf06a0778356fbf2dc30635a29b4b7d220 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:26:17 -0600 Subject: [PATCH 10/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index b7844623e1..f9146900f9 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -7,7 +7,7 @@ nav_order: 330 # User agent processor -The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. The user_agent processor is particularly useful for analyzing user behavior and identifying trends based on the devices, operating systems, and browsers used by your users. It can also be helpful for troubleshooting issues that may be specific to certain user agent configurations. +The `user_agent` processor is used to extract information from the user agent string, such as the browser, device, and operating system used by the client. The `user_agent` processor is particularly useful for analyzing user behavior and identifying trends based on user devices, operating systems, and browsers. It can also be helpful for troubleshooting issues specific to certain user agent configurations. The following is the syntax for the `user_agent` processor: From dba795d5a380e0614df955f20e841876bfe71178 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:26:27 -0600 Subject: [PATCH 11/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index f9146900f9..88c4c668b9 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -30,7 +30,7 @@ The following table lists the required and optional parameters for the `user_age Parameter | Required/Optional | Description | |-----------|-----------|-----------| `field` | Required | The field containing the user agent string. -`target_field` | Optional | The field to store the extracted user agent information. If not specified, the information is stored in the `user_agent` field. +`target_field` | Optional | The field in which to store the extracted user agent information. If not specified, then the information is stored in the `user_agent` field. `ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | `regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, the default file `regexes.yaml` shipped with OpenSearch is used. You can find the default file at `regexes.yaml`. `properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. From 1cec2d65e5a98a7281b15cce7e7f2ae22b4429f1 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:26:46 -0600 Subject: [PATCH 12/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 88c4c668b9..86d3c60f88 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -32,7 +32,7 @@ Parameter | Required/Optional | Description | `field` | Required | The field containing the user agent string. `target_field` | Optional | The field in which to store the extracted user agent information. If not specified, then the information is stored in the `user_agent` field. `ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | -`regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, the default file `regexes.yaml` shipped with OpenSearch is used. You can find the default file at `regexes.yaml`. +`regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, then the default file `regexes.yaml` is used. `properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | From 8829705ff836f0865d0fbb53f92ac28b6c42262d Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:26:55 -0600 Subject: [PATCH 13/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 86d3c60f88..492618bf93 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -33,7 +33,7 @@ Parameter | Required/Optional | Description | `target_field` | Optional | The field in which to store the extracted user agent information. If not specified, then the information is stored in the `user_agent` field. `ignore_missing` | Optional | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. | `regex_file` | Optional | A file containing regular expression patterns used to parse the user agent string. This file should be located in the `config/ingest-user-agent` directory within the OpenSearch package. If not specified, then the default file `regexes.yaml` is used. -`properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. +`properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, then the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. | From 7fcac9333019aa266300bb8863aa1a6f14e4225b Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:36:21 -0600 Subject: [PATCH 14/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 492618bf93..bc05472b55 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -36,7 +36,7 @@ Parameter | Required/Optional | Description | `properties` | Optional | A list of properties to be extracted from the user agent string and added to the `target_field`. If not specified, then the default properties are `name`, `major`, `minor`, `patch`, `build`, `os`, `os_name`, `os_major`, `os_minor`, and `device`. `description` | Optional | A brief description of the processor. | `if` | Optional | A condition for running the processor. | -`ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. | +`ignore_failure` | Optional | Specifies whether the processor continues to run even if it encounters an error. If set to `true`, then failures are ignored. Default is `false`. | `on_failure` | Optional | A list of processors to run if the processor fails. | `tag` | Optional | An identifier tag for the processor. Useful for debugging in order to distinguish between processors of the same type. | From 933bca98b2ca7de9c1213866d9926b79d0213623 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 11:36:29 -0600 Subject: [PATCH 15/16] Update _ingest-pipelines/processors/user-agent.md Co-authored-by: Nathan Bower Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index bc05472b55..038de54a75 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -46,7 +46,7 @@ Follow these steps to use the processor in a pipeline. ### Step 1: Create a pipeline -The following query creates a pipeline named `user_agent_pipeline` that uses the `user_agent` processor to to extract user agent information: +The following query creates a pipeline named `user_agent_pipeline` that uses the `user_agent` processor to extract user agent information: ```json PUT _ingest/pipeline/user_agent_pipeline From 7a9ff8d04737025fa2bf63adf584b10aed9c7128 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 30 Apr 2024 12:03:57 -0600 Subject: [PATCH 16/16] Update user-agent.md Signed-off-by: Melissa Vagi Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/user-agent.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_ingest-pipelines/processors/user-agent.md b/_ingest-pipelines/processors/user-agent.md index 038de54a75..c4ece62ac5 100644 --- a/_ingest-pipelines/processors/user-agent.md +++ b/_ingest-pipelines/processors/user-agent.md @@ -136,7 +136,7 @@ PUT testindex1/_doc/1?pipeline=user_agent_pipeline #### Response -The request indexes the document into the index `testindex1` and will index all documents with the user agent string parsed into it components: +The preceding request parses the `user_agent` string into its components and indexes the document, along with all documents containing those components, into the `testindex1` index, as shown in the following response: ```json { @@ -165,7 +165,7 @@ GET testindex1/_doc/1 #### Response -The response includes the original `user_agent` field and the parsed `user_agent_info` field with the device, operating system, and browser information: +The response includes the original `user_agent` field and the parsed `user_agent_info` field containing the device, operating system, and browser information: ```json {