Statistics
| Branch: | Revision:

iof-docs / csvSpecs / firstSpec.md @ 30b88ef4

History | View | Annotate | Download (1.46 KB)

1
# first spec for the csv format of IoF
2

    
3
## conjectures
4

    
5
Each BGP Bird node will log on a specific file
6
This file could be interpreted by a script removing everything is not concerning IoF
7

    
8
Each physical node is enough powerful to mange this load
9

    
10
The *AS_ID* will be catch by the name of the file 
11

    
12
## Format of the final CSV file
13

    
14
The output of the processing of the log will be a csv with this sequence of fields:
15

    
16
The separator between fields will be the pipe character '|'
17

    
18
Field | Meaning | 
19
---| --- |
20
Time | Time of the event formatted like follow: 'YYYY-MM-DD HH:MM:SS.MS' | 
21
Event_type | For now we selected 3 type of events, 'Best route change, Update received'|
22
Dest | Destination of the event |
23
AS_Path | As path to the destination, it needs to be a string with the AS separated by a ';'|
24
NH| Next Hop chosen for the destination |
25
~~ NumberOfMessagesSent | number of messages sent on this link |~~
26
MessageFromWho | From who I receive the message that fire the event |
27
MessageToWho | To who I sent the message that fire the event |
28
If the output is to huge for a big network is possible to compact the message receive/sent fields to only one line of the CSV at the end of the file.
29
The daemon should write this lines before the shutdown.
30

    
31
**NB:** changelog: 
32

    
33
1. the same Update could be logged at both RX or TX side. We chose RX side
34
2. The number of sent/received messages is not explicitly logged by nodes. We will compute these counters
35
if necessary, offline at data-processing time.