tag¶
Add or remove message tags.
Synopsis¶
Description¶
The tag stage manipulates key-value pairs (tags) attached to BGP messages as they flow through the pipeline. Tags are metadata that travel with messages but are not part of the BGP wire format. They appear as the last element of the JSON representation. See Message Tags for the common tags and naming conventions.
Tags are useful for:
- Annotating messages with pipeline context (e.g., source collector, timestamp)
- Passing information between stages (e.g., from rov to grep)
- Filtering based on custom criteria using
tag[key]in filter expressions
It applies to the messages it reads (see direction), or to both
directions with -LR.
Options¶
| Option | Type | Default | Description |
|---|---|---|---|
--add |
strings | Add tags in key=value format |
|
--drop |
strings | Drop tags by key; use * to drop all tags |
|
--src |
bool | false |
Add a SRC tag with the source stage name |
Examples¶
Add a tag to all messages:
bgpipe \
-- connect 192.0.2.1 \
-- tag --add source=upstream1 \
-- write -LR session.json \
-- connect 10.0.0.1
Strip all tags before writing:
Tag and filter: add environment tag, then filter on it downstream: