File: MSGLOG_DUMP_FORMATS

package info (click to toggle)
pmacct 1.7.6-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 11,548 kB
  • sloc: ansic: 106,538; sh: 4,876; cpp: 4,340; python: 3,631; makefile: 502
file content (233 lines) | stat: -rw-r--r-- 5,914 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
Following are documented the up-to-date BGP, BMP and Streaming Telemetry msglog
(real-time logging) and dump (snapshot at regular, configurable, time intervals)
formats. When upgrading from an earlier version, you may want to check out the
UPGRADE document to verify if any impacting changes to the message formats were
introduced.

BGP msglog format:
- log_init message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "log_init"
  }

- log message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "log",
    "afi": <afi>,
    "safi": <safi>,
    "log_type": <"update", "withdraw", "delete">,
    <BGP NLRI, attributes, ..>
  }

- log_close message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "log_close"
  }


BGP dump format:
- dump_init message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "dump_init",
    "dump_period": <bgp_table_dump_refresh_time>
  }

- dump message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "dump",
    "afi": <afi>,
    "safi": <safi>,
    <BGP NLRI, attributes, ..>
  }

- dump_close message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "peer_ip_src": <IP address>,
    "event_type": "dump_close",
    "tables": <number of RIBs>,
    "entries": <number of NLRIs>
  }


BMP msglog format:
- log_init message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "bmp_router": <IP address>,
    "event_type": "log_init"
  }

- log routes message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <BMP timestamp>,
    "bmp_router": <IP address>,
    "event_type": "log",
    "afi": <afi>,
    "safi": <safi>,
    "bmp_msg_type": "route_monitor", "log_type": <"update", "withdraw", "delete">,
    "peer_ip": <IP address>,
    <BGP NLRI, attributes, ..>
  }

- log events message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <BMP timestamp>,
    "bmp_router": <IP address>,
    "event_type": "log",
    "bmp_msg_type": <"init", "term", "peer_up", "stats", "peer_down">,
    "peer_ip": <IP address>,
    <BMP message data>
  }

- log_close message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "bmp_router": <IP address>,
    "event_type": "log_close"
  }


BMP dump format:
- dump_init message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "bmp_router": <IP address>,
    "event_type": "dump_init",
    "dump_period": <bmp_dump_refresh_time>
  }

- dump routes message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "bmp_router": <IP address>,
    "bmp_msg_type": "route_monitor",
    "event_type": "dump",
    "afi": <afi>,
    "safi": <safi>,
    "peer_ip": <IP address>,
    <BGP NLRI, attributes, ..>
  }

- dump events message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "bmp_router": <IP address>,
    "event_type": "dump",
    "event_timestamp": <BMP timestamp>,
    "bmp_msg_type": <"init", "term", "peer_up", "stats", "peer_down">,
    "peer_ip": <IP address>,
    <BMP message data>
  }

- dump_close message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "bmp_router": <IP address>,
    "event_type": "dump_close"
    "tables": <number of BGP peers>,
    "entries": <number of NLRIs>
  }


Streaming Telemetry msglog format:
- log_init message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "log_init"
  }

- log message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "log",
    "telemetry_port": <TCP/UDP port>,
    "serialization": <"json" | "gpb">,
    "telemetry_data": <JSON or base64'd GPB telemetry data>
  }

- log_close message:
  {
    "seq": <seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "log_close"
  }

Streaming Telemetry dump format:
- dump_init message:
  {
    "seq": <dump event seq>,
    "timestamp": <dump event timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "dump_init",
    "dump_period": <bmp_dump_refresh_time>
  }

- dump message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "dump",
    "telemetry_port": <TCP/UDP port>,
    "serialization": <"json" | "gpb">,
    "telemetry_data": <JSON or base64'd GPB telemetry data>
  }

- dump_close message:
  {
    "seq": <dump event seq>,
    "writer_id": <core_proc_name>"/"<writer_pid> (*),
    "timestamp": <dump event timestamp>,
    "telemetry_node": <IP address>,
    "event_type": "dump_close"
  }

(*) Field included only when writing to a RabbitMQ or Kafka broker