Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Add documenation for severity parser's 'overwrite_with' setting #35074

Merged
merged 2 commits into from
Oct 10, 2024
Merged

[chore] Add documenation for severity parser's 'overwrite_with' setting #35074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a4dd95
[chore] Add documenation for severity parser's 'overwrite_with' setting
djaglowski Sep 9, 2024
ecf173b
Merge branch 'main' into doc-overwrite-text
djaglowski Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions pkg/stanza/docs/operators/severity_parser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ The `severity_parser` operator sets the severity on an entry by parsing a value

### Configuration Fields

| Field | Default | Description |
| --- | --- | --- |
| `id` | `severity_parser` | A unique identifier for the operator. |
| `output` | Next in pipeline | The `id` for the operator to send parsed entries to. |
| `parse_from` | required | The [field](../types/field.md) from which the value will be parsed. |
| `on_error` | `send` | The behavior of the operator if it encounters an error. See [on_error](../types/on_error.md). |
| `preset` | `default` | A predefined set of values that should be interpreted at specific severity levels. |
| `mapping` | | A formatted set of values that should be interpreted as severity levels. |
| `if` | | An [expression](../types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |

| Field | Default | Description |
| --- | --- | --- |
| `id` | `severity_parser` | A unique identifier for the operator. |
| `output` | Next in pipeline | The `id` for the operator to send parsed entries to. |
| `parse_from` | required | The [field](../types/field.md) from which the value will be parsed. |
| `on_error` | `send` | The behavior of the operator if it encounters an error. See [on_error](../types/on_error.md). |
| `preset` | `default` | A predefined set of values that should be interpreted at specific severity levels. |
| `mapping` | | A formatted set of values that should be interpreted as severity levels. |
| `overwrite_with` | `false` | If `true`, the severity text will be set to the [standard short name](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#displaying-severity) corresponding to the severity number. |
| `if` | | An [expression](../types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |

### Example Configurations

Expand Down
14 changes: 8 additions & 6 deletions pkg/stanza/docs/types/severity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ Severity is represented as a number from 1 to 24. The meaning of these severity

Parser operators can parse a severity and attach the resulting value to a log entry.

| Field | Default | Description |
| --- | --- | --- |
| `parse_from` | required | The [field](../types/field.md) from which the value will be parsed. |
| `preset` | `default` | A predefined set of values that should be interpretted at specific severity levels. |
| `mapping` | | A custom set of values that should be interpretted at designated severity levels. |

| Field | Default | Description |
| --- | --- | --- |
| `parse_from` | required | The [field](../types/field.md) from which the value will be parsed. |
| `preset` | `default` | A predefined set of values that should be interpretted at specific severity levels. |
| `mapping` | | A custom set of values that should be interpretted at designated severity levels. |
| `overwrite_with` | `false` | If `true`, the severity text will be set to the [recommeneded short name](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#displaying-severity) corresponding to the severity number. |

Note that by default the severity _text_ will be set to the original value which was interpreted into a severity number. In order to set the severity text to a standard short name (e.g. `ERROR`, `INFO3`, etc.), set `overwrite_with` to `true`.

### How severity `mapping` works

Expand Down