Skip to content

Commit

Permalink
docs: document single argument variant of tracingBaggageToTag
Browse files Browse the repository at this point in the history
Implementation allows single argument variant which
is used in the wild so document it.

Follow up on #1160 and #1168

Signed-off-by: Alexander Yastrebov <[email protected]>
  • Loading branch information
AlexanderYastrebov committed Sep 24, 2024
1 parent ce501f8 commit b936b96
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/reference/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3303,11 +3303,19 @@ Syntax:
tracingBaggageToTag("<baggage_item_name>", "<tag_name>")
```
Example: If a trace consists of baggage item named `foo` with a value `bar`. Adding below filter will add a tag named `baz` with value `bar`
Example:
If a trace consists of a baggage item named `foo` with a value of `bar`,
then adding the filter below will add a tag named `baz` with the value `bar`:
```
tracingBaggageToTag("foo", "baz")
```
A single-argument variant uses the baggage item name as the tag name, i.e., it will add a tag named `foo` with the value `bar`:
```
tracingBaggageToTag("foo")
```
### stateBagToTag
This filter sets an opentracing tag from the filter context (state bag).
Expand Down

0 comments on commit b936b96

Please sign in to comment.