Add OTel trace group processor to doc website. (#3236)

* Add otel trace group processor. Signed-off-by: carolxob <[email protected]> * Copy edits to improve table formatting. Signed-off-by: carolxob <[email protected]> * Incorporated doc review feedback. Signed-off-by: carolxob <[email protected]> * Minor updates. Signed-off-by: carolxob <[email protected]> * Minor updates. Signed-off-by: carolxob <[email protected]> * Minor updates. Signed-off-by: carolxob <[email protected]> * Minor updates. Signed-off-by: carolxob <[email protected]> * Tech review updates. Signed-off-by: carolxob <[email protected]> * Content modifications based on tech feedback. Signed-off-by: carolxob <[email protected]> * Content updates. Signed-off-by: carolxob <[email protected]> * Removed unnecessary link. Signed-off-by: carolxob <[email protected]> * Removed markdown comments. Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Changed processor name references to remove tic marks. Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Minor edits to fix links. Signed-off-by: carolxob <[email protected]> * Removed common metrics from Metrics section and updated default value for . Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Updated OpenSearch security link. Signed-off-by: carolxob <[email protected]> * Removed unnecessary column in Metrics table. Signed-off-by: carolxob <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Caroline <[email protected]> * Minor update to title for accuracy. Signed-off-by: carolxob <[email protected]> * Removed optional from each item in the Configuration table. All items are optional. Signed-off-by: carolxob <[email protected]> * Updated links for OS security and service. Signed-off-by: carolxob <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Updates made based on editorial feedback. Signed-off-by: carolxob <[email protected]> * Minor update to phrasing. Signed-off-by: carolxob <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> * Update _data-prepper/pipelines/configuration/processors/otel-trace-group.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Caroline <[email protected]> --------- Signed-off-by: carolxob <[email protected]> Signed-off-by: Caroline <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Apr 25, 2023 · ab10e6a · ab10e6a
1 parent ec668fd
commit ab10e6a
Showing 1 changed file with 79 additions and 0 deletions.
diff --git a/_data-prepper/pipelines/configuration/processors/otel-trace-group.md b/_data-prepper/pipelines/configuration/processors/otel-trace-group.md
@@ -0,0 +1,79 @@
+---
+layout: default
+title: otel_trace_group processor
+parent: Processors
+grand_parent: Pipelines
+nav_order: 45
+---
+
+# otel_trace_group processor
+
+The `otel_trace_group` processor completes missing trace-group-related fields in the collection of [span](https://github.com/opensearch-project/data-prepper/blob/834f28fdf1df6d42a6666e91e6407474b88e7ec6/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/trace/Span.java) records by looking up the OpenSearch backend. The `otel_trace_group` processor identifies the missing trace group information for a `spanId` by looking up the relevant fields in its root `span` stored in OpenSearch.
+
+## OpenSearch
+
+When you connect to an OpenSearch cluster using your username and password, use the following example `pipeline.yaml` file to configure the `otel_trace_group` processor:
+
+``` YAML
+pipeline:
+  ...
+  processor:
+    - otel_trace_group:
+        hosts: ["https://localhost:9200"]
+        cert: path/to/cert
+        username: YOUR_USERNAME_HERE
+        password: YOUR_PASSWORD_HERE
+```
+
+See [OpenSearch security]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/sinks/opensearch/#opensearch-cluster-security) for a more detailed explanation of which OpenSearch credentials and permissions are required and how to configure those credentials for the OTel trace group processor.
+
+### Amazon OpenSearch Service
+
+When you use [Amazon OpenSearch Service]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/sinks/opensearch/#amazon-opensearch-service-domain-security), use the following example `pipeline.yaml` file to configure the `otel_trace_group` processor:
+
+``` YAML
+pipeline:
+  ...
+  processor:
+    - otel_trace_group:
+        hosts: ["https://your-amazon-opensearch-service-endpoint"]
+        aws_sigv4: true
+        cert: path/to/cert
+        insecure: false
+```
+
+## Configuration
+
+You can configure the `otel_trace_group` processor with the following options.
+
+| Name | Description | Default value |
+| -----| ----| -----------|
+| `hosts`| A list of IP addresses of OpenSearch nodes. Required. | No default value. | 
+| `cert` | A certificate authority (CA) certificate that is PEM encoded. Accepts both .pem or .crt. This enables the client to trust the CA that has signed the certificate that OpenSearch is using. | `null` |
+| `aws_sigv4` | A Boolean flag used to sign the HTTP request with AWS credentials. Only applies to Amazon OpenSearch Service. See [OpenSearch security](https://github.com/opensearch-project/data-prepper/blob/129524227779ee35a327c27c3098d550d7256df1/data-prepper-plugins/opensearch/security.md) for details. | `false`. |
+| `aws_region` | A string that represents the AWS Region of the Amazon OpenSearch Service domain, for example, `us-west-2`. Only applies to Amazon OpenSearch Service. | `us-east-1` |
+| `aws_sts_role_arn`| An AWS Identity and Access Management (IAM) role that the sink plugin assumes to sign the request to Amazon OpenSearch Service. If not provided, the plugin uses the [default credentials](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/DefaultCredentialsProvider.html). | `null` |
+| `aws_sts_header_overrides` | A map of header overrides that the IAM role assumes for the sink plugin. | `null` |
+| `insecure` | A Boolean flag used to turn off SSL certificate verification. If set to `true`, CA certificate verification is turned off and insecure HTTP requests are sent. | `false` |
+| `username` | A string that contains the username and is used in the [internal users](https://opensearch.org/docs/latest/security/access-control/users-roles/) `YAML` configuration file of your OpenSearch cluster. | `null` |
+| `password` | A string that contains the password and is used in the [internal users](https://opensearch.org/docs/latest/security/access-control/users-roles/) `YAML` configuration file of your OpenSearch cluster. | `null` |
+
+## Configuration option examples
+
+You can define the configuration option values in the `aws_sts_header_overrides` option. See the following example:
+
+```
+aws_sts_header_overrides:
+  x-my-custom-header-1: my-custom-value-1
+  x-my-custom-header-2: my-custom-value-2
+```
+
+## Metrics
+
+The following table describes custom metrics specific to the `otel_trace_group` processor.
+
+| Metric name | Type | Description |
+| ------------- | ---- | ----------- |
+| `recordsInMissingTraceGroup` | Counter | The number of ingress records missing trace group fields. |
+| `recordsOutFixedTraceGroup` | Counter | The number of egress records with successfully completed trace group fields. |
+| `recordsOutMissingTraceGroup` | Counter | The number of egress records missing trace group fields. |