pipeline: processors: content-modifier: general cleanup

.vale.ini

@@ -11,7 +11,7 @@ BasedOnStyles = FluentBit
 FluentBit.Terms = YES
 FluentBit.Titles = YES
 FluentBit.FutureTense = NO
-FluentBit.Headings = NO
+FluentBit.Headings = YES
 FluentBit.Passive = NO
 FluentBit.Subjunctive = NO
 FluentBit.Colons = NO

pipeline/processors/content-modifier.md

@@ -1,66 +1,76 @@
-# Content Modifier
+# Content modifier
 
-The **content_modifier** processor allows you to manipulate the messages, metadata/attributes and content of Logs and Traces.
+The _content modifier_ processor lets you manipulate the content, metadata, and attributes of logs and traces.
 
-Similar to the functionality exposed by filters, this processor presents a unified mechanism to perform such operations for data manipulation. The most significant difference is that processors perform better than filters, and when chaining them, there are no encoding/decoding performance penalties.
+Similar to how filters work, this processor uses a unified mechanism to perform operations for data manipulation. The most significant difference is that processors perform better than filters, and when chaining them, there are no encoding/decoding performance penalties.
 
 {% 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 %}
 
 ## Contexts
 
-The processor, works on top of what we call a __context__, meaning _the place_ where the content modification will happen. We provide different contexts to manipulate the desired information, the following contexts are available:
+The content modifier relies on _context_, meaning the place where the content modification will happen. Fluent Bit provides different contexts to manipulate the desired information.
 
-| Context Name | Signal | Description |
-| -- | -- | -- |
-| `attributes` | Logs | Modify the attributes or metadata of a Log record. |
-| `body` | Logs | Modify the content of a Log record. |
-| `span_name` | Traces | Modify the name of a Span. |
-| `span_kind` | Traces | Modify the kind of a Span. |
-| `span_status` | Traces | Modify the status of a Span. |
-| `span_attributes` | Traces | Modify the attributes of a Span. |
+The following contexts are available:
 
+| Name | Telemetry type | Description |
+| ---- | -------------- | ----------- |
+| `attributes` | Logs | Modifies the attributes or metadata of a log record. |
+| `body` | Logs | Modifies the content of a log record. |
+| `span_name` | Traces | Modifies the name of a span. |
+| `span_kind` | Traces | Modifies the kind of a span. |
+| `span_status` | Traces | Modifies the status of a span. |
+| `span_attributes` | Traces | Modifies the attributes of a span. |
 
-### OpenTelemetry Contexts
 
-In addition, we provide special contexts to operate on data that follows an __OpenTelemetry Log Schema__, all of them operates on shared data across a group of records:
+### OpenTelemetry contexts
 
-| Context Name | Signal | Description |
-| -- | -- | -- |
-| `otel_resource_attributes` | Logs | Modify the attributes of the Log Resource. |
-| `otel_scope_name` | Logs | Modify the name of a Log Scope. |
-| `otel_scope_version` | Logs | Modify version of a Log Scope. |
-| `otel_scope_attributes` | Logs | Modify the attributes of a Log Scope. |
+Additionally, Fluent Bit provides specific contexts for modifying data that follows the OpenTelemetry log schema. All of these contexts operate on shared data across a group of records.
 
-> TIP: if your data is not following the OpenTelemetry Log Schema and your backend or destination for your logs expects to be in an OpenTelemetry schema, take a look at the processor called OpenTelemetry Envelope that you can use in conjunbction with this processor to transform your data to be compatible with OpenTelemetry Log schema.
+The following contexts are available:
 
-## Configuration Parameters
+| Name | Telemetry type | Description |
+| ---- | -------------- | ----------- |
+| `otel_resource_attributes` | Logs | Modifies the attributes of the log resource. |
+| `otel_scope_name` | Logs | Modifies the name of a log scope. |
+| `otel_scope_version` | Logs | Modifies version of a log scope. |
+| `otel_scope_attributes` | Logs | Modifies the attributes of a log scope. |
+
+
+{% hint style="info" %}
+
+If your data doesn't follow the OpenTelemetry log schema, but your log destination expects to be in that format, you can use the [OpenTelemetry envelope](../pipeline/processors/opentelemetry-envelope) processor to transform your data. You can then pass that transformed data through the content modifier filter and use OpenTelemetry contexts accordingly.
+
+{% endhint %}
+
+## Configuration parameters
+
+The following configuration parameters are available:
 
 | Key         | Description |
-| :---------- | :--- |
-| context | Specify the context where the modifications will happen (more details above).The following contexts are available:  `attributes`, `body`, `span_name`, `span_kind`, `span_status`, `span_attributes`, `otel_resource_attributes`, `otel_scope_name`, `otel_scope_version`, `otel_scope_attributes`. |
-| key | Specify the name of the key that will be used to apply the modification. |
-| value | Based on the action type, `value` might required and represent different things. Check the detailed information for the specific actions. |
-| pattern | Defines a regular expression pattern. This property is only used by the `extract` action. |
-| converted_type | Define the data type to perform the conversion, the available options are: `string`, `boolean`, `int` and `double` . |
+| ----------- | ----------- |
+| `context` | Specifies the [context](#contexts) where the modifications will happen. |
+| `key` | Specifies the name of the key that will be used to apply the modification. |
+| `value` | The role of this parameter changes based on the [action](#actions) type. |
+| `pattern` | Defines a regular expression pattern. This property is only used by the `extract` [action](#actions). |
+| `converted_type` | Defines the data type to perform the conversion. Possible values: `string`, `boolean`, `int` and `double`. |
 
 ### Actions
 
-The actions specify the type of operation to run on top of a specific key or content from a Log or a Trace. The following actions are available:
+The actions specify the type of operation to run on top of a specific key or content from a log or a trace. The following actions are available:
 
 | Action  | Description                                                  |
 | ------- | ------------------------------------------------------------ |
-| `insert`  | Insert a new key with a value into the target context. The `key` and `value` parameters are required. |
-| `upsert`  | Given a specific key with a value, the `upsert` operation will try to update the value of the key. If the key does not exist, the key will be created. The `key` and `value` parameters are required. |
-| `delete`  | Delete a key from the target context. The `key` parameter is required. |
-| `rename`  | Change the name of a key. The `value` set in the configuration will represent the new name. The `key` and `value` parameters are required. |
-| `hash`    | Replace the key value with a hash generated by the SHA-256 algorithm, the binary value generated is finally set as an hex string representation. The `key` parameter is required. |
-| `extract` | Allows to extact the value of a single key as a list of key/value pairs. This action needs the configuration of a regular expression in the  `pattern` property . The `key` and `pattern` parameters are required.  For more details check the examples below. |
-| `convert` | Convert the data type of a key value. The `key` and `converted_type` parameters are required. |
+| `insert`  | Inserts a new key with a value into the target context. The `key` and `value` parameters are required. |
+| `upsert`  | Given a specific key with a value, the `upsert` operation will try to update the value of the key. If the key does not exist, a new key will be created. The `key` and `value` parameters are required. |
+| `delete`  | Deletes a key from the target context. The `key` parameter is required. |
+| `rename`  | Changes the name of a key. The `value` set in the configuration will represent the new name. The `key` and `value` parameters are required. |
+| `hash`    | Replaces the key value with a hash generated by the SHA-256 algorithm, the binary value generated is finally set as a hex string representation. The `key` parameter is required. |
+| `extract` | Extracts the value of a single key as a list of key/value pairs. This action needs the configuration of a regular expression in the  `pattern` property. The `key` and `pattern` parameters are required. |
+| `convert` | Converts the data type of a key value. The `key` and `converted_type` parameters are required. |
 
 #### Insert example
 
@@ -81,7 +91,7 @@ pipeline:
                     action: insert
                     key: "color"
                     value: "blue"
-            
+
     outputs:
         - name : stdout
           match: '*'
@@ -271,4 +281,4 @@ pipeline:
 ```
 
 {% endtab %}
-{% endtabs %}
+{% endtabs %}

vale-styles/FluentBit/Acronyms.yml

@@ -80,6 +80,7 @@ exceptions:
   - SCSS
   - SDK
   - SDS
+  - SHA
   - SIEM
   - SLA
   - SQL

vale-styles/FluentBit/Spelling-exceptions.txt

@@ -200,6 +200,7 @@ unary
 Unary
 unmuted
 unsort
+upsert
 UUIDs
 Vectra
 Vercel

vale-styles/FluentBit/WordList.yml

@@ -37,9 +37,6 @@ swap:
   cellular data: mobile data
   cellular network: mobile network
   chapter: documents|pages|sections
-  check box: checkbox
-  check: select
-  click on: click|click in
   Container Engine: Kubernetes Engine
   content type: media type
   curated roles: predefined roles
@@ -58,7 +55,6 @@ swap:
   in order to: to
   # ingest: import|load
   k8s: Kubernetes
-  long press: touch & hold
   network IP address: internal IP address
   omnibox: address bar
   open-source: open source
@@ -72,7 +68,6 @@ swap:
   synch: sync
   tablename: table name
   tablet: device
-  touch: tap
   url:  URL
   vs\.: versus
   whitelist: allowlist