pipeline: processors: opentelemetry-envelope

Signed-off-by: Alexa Kreizinger <[email protected]>

Author: alexakreizinger

pipeline/processors/opentelemetry-envelope.md

@@ -1,25 +1,22 @@
-# OpenTelemetry Envelope
+# OpenTelemetry envelope
 
-The _OpenTelemetry Envelope_ processor is used to transform your data to be compatible with the OpenTelemetry Log schema. If your data was __not__ generated by [OpenTelemetry input](../inputs/opentelemetry.md) and your backend or destination for your logs expects to be in an OpenTelemetry schema.
+The _OpenTelemetry envelope_ processor transforms your data to be compatible with the OpenTelemetry log schema. If your data wasn't generated by the [OpenTelemetry input plugin](../inputs/opentelemetry.md), you can use this processor before sending that data to a destination that expects an OpenTelemetry-compatible schema.
 
-![](../../.gitbook/assets/processor_opentelemetry_envelope.png)
+![OpenTelemetry envelope transformation](../../.gitbook/assets/processor_opentelemetry_envelope.png)
 
 {% hint style="info" %}
 
-**Note:** Both processors and this specific component can be enabled only by using
-the YAML configuration format. Classic mode configuration format doesn't support processors.
+Only [YAML configuration files](../administration/configuring-fluent-bit/yaml/README.md) support processors.
 
 {% endhint %}
 
-## Configuration Parameters
+## Configuration parameters
 
-The processor does not provide any extra configuration parameter, it can be used directly in your _processors_ Yaml directive.
+The OpenTelemetry envelope processor doesn't use configuration parameters.
 
-## Usage Example
+## Examples
 
-In this example, we will use the Dummy input plugin to generate a sample message per second, right after is created the processor `opentelemetry_envelope` is used to transform the data to be compatible with the OpenTelemetry Log schema. The output is sent to the standard output and also to an OpenTelemetry collector which is receiving data in port 4318.
-
-Example Fluent Bit and OpenTelemetry collector configuration files:
+The following example uses the `dummy` input plugin to generate one sample message per second, then transforms those messages by using the `opentelemetry_envelope` processor. The resulting transformed data is sent to `stdout` and the `opentelemetry` output plugin.
 
 {% tabs %}
 {% tab title="fluent-bit.yaml" %}
@@ -77,9 +74,9 @@ service:
 {% endtab %}
 {% endtabs %}
 
- You will notice in the standard output of Fluent Bit will print the raw representation of the schema, however, the OpenTelemetry collector will receive the data in the OpenTelemetry Log schema.
+The standard output of Fluent Bit prints the raw representation of the schema. However, the OpenTelemetry collector receives the data in an OpenTelemetry-compatible format.
 
-Inspecting the output file `out.json` you will see the data in the OpenTelemetry Log schema:
+If you inspect the `out.json` output file, you will see OpenTelemetry-compatible data, similar to the following:
 
 
 ```json
@@ -107,7 +104,7 @@ Inspecting the output file `out.json` you will see the data in the OpenTelemetry
 }
 ```
 
-While OpenTelemetry Envelope enrich your logs with the Schema, you might be interested into take a step further and use the [Content Modifier](../processors/content-modifier.md) processor to modify the content of your logs. Here is a quick example that will allow you to add some resource and scope attributes to your logs:
+If you're interested in additional transformations, you can also use the [content modifier](../processors/content-modifier.md) processor to modify the content of your logs. The following example shows how to add resource and scope attributes to logs:
 
 {% tabs %}
 {% tab title="fluent-bit.yaml" %}
@@ -145,7 +142,7 @@ pipeline:
 {% endtab %}
 {% endtabs %}
 
-The collector JSON output will look like this:
+The collector JSON output will resemble the following:
 
 ```json
 {
@@ -181,4 +178,4 @@ The collector JSON output will look like this:
 }
 ```
 
-For more details about further processing, read the [Content Modifier](../processors/content-modifier.md) processor documentation.
+For more details about further processing, read the [content modifier](../processors/content-modifier.md) processor documentation.