Skip to content

Commit

Permalink
severity_parser: update docs to correct overwrite_text name (open-tel…
Browse files Browse the repository at this point in the history
  • Loading branch information
davispuh authored and ArthurSens committed Nov 4, 2024
1 parent 6e45a0f commit 8aa93ec
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pkg/stanza/docs/types/severity.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Parser operators can parse a severity and attach the resulting value to a log en
| `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. |
| `overwrite_text` | `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`.
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_text` to `true`.

### How severity `mapping` works

Expand Down

0 comments on commit 8aa93ec

Please sign in to comment.