Processor plugin docs updates (#2369)

* docs: prcessors: content-modifier: fix config params table

  - Add missing `action` configuration parameter
  - Sort configuration parameters alphabetically
  - Add Oxford comma in converted_type description

Applies to #2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>

* docs: processors: labels: fix config params and hash algorithm

  - Sort configuration parameters alphabetically
  - Fix hash example to say SHA-256 (not SHA-1) to match implementation

Applies to #2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>

* docs: processors: metrics-selector: fix config params table

  - Sort configuration parameters alphabetically
  - Fix context default value typo (metrics_name -> metric_name)
  - Fix context possible value (delete_label -> delete_label_value)

Applies to #2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>

* docs: processors: sampling: fix config params and descriptions

  - Add missing `debug` configuration parameter
  - Sort all configuration parameter tables alphabetically
  - Fix swapped min_spans/max_spans descriptions in span count condition
  - Add Default column to main config table
  - Normalize table separator styles

Applies to #2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>

---------

Signed-off-by: Eric D. Schabell <eric@schabell.org>

Author: eschabell

pipeline/processors/content-modifier.md

@@ -54,11 +54,12 @@ The following configuration parameters are available:
 
 | Key         | Description |
 | ----------- | ----------- |
+| `action` | Specifies the type of [action](#actions) to perform on the content. |
 | `context` | Specifies the [context](#contexts) where the modifications will happen. |
+| `converted_type` | Defines the data type to perform the conversion. Possible values: `string`, `boolean`, `int`, and `double`. |
 | `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`. |
+| `value` | The role of this parameter changes based on the [action](#actions) type. |
 
 ### Actions
 

pipeline/processors/labels.md

@@ -16,11 +16,11 @@ Only [YAML configuration files](../../administration/configuring-fluent-bit/yaml
 
 | Key | Description |
 | --- | ----------- |
-| `update` | Updates an existing key with a value into metrics. The key/value pair is required. If the specified key doesn't exist, the operation silently fails and has no effect. |
-| `insert` | Inserts a new key with a value into metrics. The key/value pair is required. |
-| `upsert` | Upserts a specific key with a value, the `upsert` operation will try to update the value of the key. If the specified key doesn't exist, a new key will be created. The key/value pair is required. |
 | `delete` | Deletes a key from the labels of metrics. The key/value pair is required. If the specified key doesn't exist, the operation silently fails and has no effect. |
 | `hash` | Replaces the key value with a hash generated by the SHA-256 algorithm from the specified label name. The generated binary value is set as a hex string. |
+| `insert` | Inserts a new key with a value into metrics. The key/value pair is required. |
+| `update` | Updates an existing key with a value into metrics. The key/value pair is required. If the specified key doesn't exist, the operation silently fails and has no effect. |
+| `upsert` | Upserts a specific key with a value, the `upsert` operation will try to update the value of the key. If the specified key doesn't exist, a new key will be created. The key/value pair is required. |
 
 ### Update example
 
@@ -124,7 +124,7 @@ pipeline:
 
 ### Hash example
 
-The following example applies the SHA-1 algorithm for the value of the key `hostname`:
+The following example applies the SHA-256 algorithm for the value of the key `hostname`:
 
 {% tabs %}
 {% tab title="fluent-bit.yaml" %}

pipeline/processors/metrics-selector.md

@@ -10,11 +10,11 @@ The metrics selector processor supports the following configuration parameters:
 
 | Key | Description | Default |
 | --- | ----------- | ------- |
-| `metric_name` | The string that determines which metrics are affected by this processor, depending on the active [matching operation](#matching-operations). | _none_ |
-| `context` | Specifies matching context. Possible values: `metric_name` or `delete_label`. | `metrics_name` |
 | `action` | Specifies whether to include or exclude matching metrics. Possible values: `INCLUDE` or `EXCLUDE`. | _none_ |
-| `operation_type` | Specifies the [matching operation](#matching-operations) to apply to the value of `metric_name`. Possible values: `PREFIX` or `SUBSTRING`. | _none_ |
+| `context` | Specifies matching context. Possible values: `metric_name` or `delete_label_value`. | `metric_name` |
 | `label` | Specifies a label key and value pair. | _none_ |
+| `metric_name` | The string that determines which metrics are affected by this processor, depending on the active [matching operation](#matching-operations). | _none_ |
+| `operation_type` | Specifies the [matching operation](#matching-operations) to apply to the value of `metric_name`. Possible values: `PREFIX` or `SUBSTRING`. | _none_ |
 
 ## Matching operations
 

pipeline/processors/sampling.md

@@ -12,11 +12,12 @@ Only [YAML configuration files](../../administration/configuring-fluent-bit/yaml
 
 This processor uses the following configuration parameters:
 
-| Key | Description |
-| --- | ----------- |
-| `type` | The type of sampling to perform. Possible values: `probabilistic` ([head sampling](#head-sampling)) or `tail` ([tail sampling](#tail-sampling)). |
-| `sampling_settings` | Contains key/value pairs for different sampling settings. These settings vary by `type`. |
-| `conditions` | An array of objects where each object specifies a different [condition](#conditions) for `tail` sampling. The possible items in each object vary by `conditions.type`. |
+| Key | Description | Default |
+| --- | ----------- | ------- |
+| `conditions` | An array of objects where each object specifies a different [condition](#conditions) for `tail` sampling. The possible items in each object vary by `conditions.type`. | _none_ |
+| `debug` | Enables debug mode, which prints the trace and its spans. | `false` |
+| `sampling_settings` | Contains key/value pairs for different sampling settings. These settings vary by `type`. | _none_ |
+| `type` | The type of sampling to perform. Possible values: `probabilistic` ([head sampling](#head-sampling)) or `tail` ([tail sampling](#tail-sampling)). | _none_ |
 
 ## Head sampling
 
@@ -98,10 +99,10 @@ This condition samples traces based on span duration. It uses `threshold_ms_low`
 The latency condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
-| `type` | Sets the condition type. For the latency condition, this value must be `latency`. | _none_ |
-| `threshold_ms_low` | Specifies the lower latency threshold. Traces with a duration less than or equal to this value will be sampled. | `0` |
+| --- | ----------- | ------- |
 | `threshold_ms_high` | Specifies the upper latency threshold. Traces with a duration greater than or equal to this value will be sampled. | `0` |
+| `threshold_ms_low` | Specifies the lower latency threshold. Traces with a duration less than or equal to this value will be sampled. | `0` |
+| `type` | Sets the condition type. For the latency condition, this value must be `latency`. | _none_ |
 
 The following example waits five seconds before making a decision. It then samples traces based on latency, capturing short traces of 200 ms or less and long traces of 3000 ms or more. Traces between 200 ms and 3000 ms won't be sampled unless another condition applies.
 
@@ -146,10 +147,10 @@ This condition samples traces that have specific span counts defined in a config
 The span count condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
+| --- | ----------- | ------- |
+| `max_spans` | Specifies the maximum number of spans a trace can have to be sampled. | _none_ |
+| `min_spans` | Specifies the minimum number of spans a trace must have to be sampled. | _none_ |
 | `type` | Sets the condition type. For the span count condition, this value must be `span_count`. | _none_ |
-| `max_spans` | Specifies the minimum number of spans a trace must have to be sampled. | _none_ |
-| `min_spans` | Specifies the maximum number of spans a trace can have to be sampled.  | _none_ |
 
 The following example configuration waits five seconds before making a decision. It then samples traces with at least three spans but no more than five spans. Traces with less than three spans or greater than five spans won't be sampled unless another condition applies.
 
@@ -194,9 +195,9 @@ This condition samples traces based on span status codes (`OK`, `ERROR`, `UNSET`
 The status code condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
-| `type` | Sets the condition type. For the status code condition, this value must be `status_code`. | _none_ |
+| --- | ----------- | ------- |
 | `status_codes` | Defines an array of span status codes (`OK`, `ERROR`, `UNSET`) to filter traces. Traces are sampled if any span matches a listed status code. For example, `status_codes: [ERROR, UNSET]` captures traces with errors or unset statuses. | _none_ |
+| `type` | Sets the condition type. For the status code condition, this value must be `status_code`. | _none_ |
 
 The following example configuration samples only spans with the `ERROR` status code.
 
@@ -240,11 +241,11 @@ This conditional lets you sample traces based on specific span or resource attri
 The string attribute condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
-| `type` | Sets the condition type. For the string attribute condition, this value must be `string_attribute`. | _none_ |
+| --- | ----------- | ------- |
 | `key` | Specifies the span or resource attribute to match (for example, `"service.name"`). | _none_ |
-| `values` | Defines an array of accepted values for the attribute. A trace is sampled if any span contains a matching key-value pair: `["payment-processing"]` | _none_ |
 | `match_type` | Defines how attributes are compared: `strict` ensures exact value matching (and is case-sensitive), `exists` checks if the attribute is present regardless of its value, and `regex` uses regular expression pattern matching. | `strict` |
+| `type` | Sets the condition type. For the string attribute condition, this value must be `string_attribute`. | _none_ |
+| `values` | Defines an array of accepted values for the attribute. A trace is sampled if any span contains a matching key-value pair: `["payment-processing"]` | _none_ |
 
 The following example configuration waits two seconds before making a decision. It then samples traces based on string matching key-value pairs:
 
@@ -313,12 +314,12 @@ This condition samples traces based on numeric attribute values of a defined key
 The numeric attribute condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
-| `type` | Sets the condition type. For the numeric attribute condition, this value must be `numeric_attribute`. | _none_ |
+| --- | ----------- | ------- |
 | `key` | Specifies the span or resource attribute to match (for example, `"service.name"`). | _none_ |
-| `min_value`| The minimum inclusive value for the numeric attribute. Traces with values greater than or equal to the `min_value` are sampled. | _none_ |
-| `max_value` | The maximum inclusive value for the numeric attribute. Traces with values less than or equal to the `max_value` are sampled. | _none_ |
 | `match_type` | This defines how attribute values are evaluated: `strict` matches exact values, `exists` checks if the attribute is present, regardless of its value. | `strict` |
+| `max_value` | The maximum inclusive value for the numeric attribute. Traces with values less than or equal to the `max_value` are sampled. | _none_ |
+| `min_value` | The minimum inclusive value for the numeric attribute. Traces with values greater than or equal to the `min_value` are sampled. | _none_ |
+| `type` | Sets the condition type. For the numeric attribute condition, this value must be `numeric_attribute`. | _none_ |
 
 The following example configuration samples only spans with the key `http.status code` with numeric values between `400` and `504` inclusive.
 
@@ -364,9 +365,9 @@ This condition samples traces based on a boolean attribute value of a defined ke
 The Boolean attribute condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
-| `type` | Sets the condition type. For the Boolean attribute condition, this value must be `boolean_attribute`. | _none_ |
+| --- | ----------- | ------- |
 | `key` | Specifies the span or resource attribute to match (for example, `"service.name"`). | _none_ |
+| `type` | Sets the condition type. For the Boolean attribute condition, this value must be `boolean_attribute`. | _none_ |
 | `value` | Expected boolean value: `true` or `false` | _none_ |
 
 The following example configuration waits two seconds before making a decision. It then samples traces that have the key `user.logged` set to `false`.
@@ -412,7 +413,7 @@ This condition samples traces based on metadata stored in the W3C `trace_state`
 The trace state condition uses the following `conditions` configuration parameters:
 
 | Key | Description | Default |
-| --- | ----------- | --------|
+| --- | ----------- | ------- |
 | `type` | Sets the condition type. For the trace state condition, this value must be `trace_state`. | _none_ |
 | `values` | Defines a list of key, value pairs to match against the `trace_state`. A trace is sampled if any of the specified values exist in the `trace_state` field. Matching follows OR logic, meaning at least one value must be present for sampling to occur. | _none_ |