Message Tags¶
Tags are key-value metadata attached to messages: where a message came from
(eg. the BGP peer and the route collector), and what stages found out about it
(eg. its RPKI status). They travel with the message through the pipeline, are
written as the last element of the JSON format, and can be
matched in filters with tag[KEY].
Conventions¶
- ALL-CAPS keys are the well-known tags below. They describe the source of
a message, are set by the stages that read it, and are used by the stages
that write it (eg. the MRT and BMP writers put
PEER_IPandPEER_ASinto their headers). - Lowercase keys are all other tags, by convention
stage/namefor tags set by a stage (eg.rov/status), and anything else for your own tags. - An empty value means no tag.
Internally, the well-known tags are kept as typed values (eg. PEER_IP as an
IP address), so they are cheap to set and use, and are always valid: an
invalid value (eg. PEER_AS of abc) is dropped.
Well-known Tags¶
| Tag | Description | Set by |
|---|---|---|
PEER_IP |
IP address of the BGP peer | read (MRT), bmp, ris-live, rv-live |
PEER_AS |
AS number of the BGP peer | read (MRT), bmp, ris-live, rv-live |
PEER_ID |
BGP Identifier of the peer | bmp |
LOCAL_IP |
Local (collector) IP address of the BGP session | read (MRT update dumps) |
LOCAL_AS |
Local (collector) AS number of the BGP session | read (MRT update dumps) |
COLLECTOR |
Route collector name (eg. rrc01, linx) |
ris-live, rv-live, bmp (OpenBMP) |
ROUTER |
BMP router: its sysName, or IP address | bmp |
SRC |
Name of the stage the message came from | tag --src |
combine and mrai identify a BGP peer by
COLLECTOR, ROUTER, PEER_IP and PEER_AS (and the BMP view: bmp/rib, bmp/rd).
Stage Tags¶
| Tag | Description | Set by |
|---|---|---|
rov/status, rov/<prefix> |
RPKI ROV result: VALID, INVALID, NOT_FOUND (eg. rov/192.0.2.0/24) |
rov |
aspa/status, aspa/invalid-hop |
ASPA verification result | aspa |
bmp/rib |
RIB view: in-post, out-pre, out-post, or loc (not set for pre-policy Adj-RIB-In) |
bmp |
bmp/rd |
Peer distinguisher (hex), for RD and local instance peers, or if non-zero | bmp |
bmp/type |
rd or local for RD and local instance peers (not set for global peers) |
bmp |
mrt/interface |
Interface index, when present | read (MRT update dumps) |
ris-live/host |
RIS collector hostname (eg. rrc01.ripe.net) |
ris-live |
ris-live/id |
RIS message ID | ris-live |
rv-live/collector |
RouteViews internal BMP machine name (eg. bmp1) |
rv-live |
websocket/remote |
Remote address of the WebSocket peer | websocket |
Using Tags¶
Match tags in filters, eg. in grep or the
--if option of any stage:
bgpipe -o -- ris-live -- grep 'tag[PEER_AS] == 13335 && tag[COLLECTOR] == rrc01'
bgpipe -- bmp --listen :11019 -- grep 'tag[bmp/rib] == in-post' -- write 'bmp.$TIME.mrt.gz'
Add or drop tags with the tag stage, eg. to mark messages from a given source, or to drop tags that should not be stored:
Tags are saved in JSON files, and restored when such a file is read:
MRT and BMP have no place for tags, except the peer headers: the
write stage with MRT output, and bmp --write,
fill them in from PEER_IP, PEER_AS, LOCAL_IP and LOCAL_AS, which
read and bmp restore from there.