This web page is regarding how to use BGPMon properly. All the BGPMon users can be divided into three main groups. Each group will use BGPMon in a defferent level. We organize the user guide into three sections which each section is for a specifc group. So If you are a potential user of BGPMon, the first thing is to find which user group you are in. After that, you can find the most appropriate user guide to read.

Here are the three user groups of BGPmon.

1) people who want to download BGPMon and run it themselves.
2) people who can provide us with peering.
3) people who want to use the data we are collecting.

1. System requirement
Update gcc to 4.1.1, and make sure libxml and libbz2 are installed. BGPMon uses packed structures for all the source file except XMLUtil.c which works together libxml. The reason is that the libxml cannot work with the compile option'-fpack-struct in a 64bit machine.

2.Download
Download the BGPMon source package here.

3. Compile
You can extract the downloaded BGPMon source package to anywhere you like. Then go to the directory you just extracted the package.
> cd <some-directory-of-you-extract-package>
> make clean
> make
"make clean" is used to clean all existing object files. "make" compiles bgpmon and bgpmonclient. bgpmonclient is a sample client.

4. Run
4-1. Start the bgpmon
> cd <some-directory-of-you-extract-package>
> bgpmon -f config.xml -d
Before start the bgpmon, please create your own config.xml at first. You can create your own config.xml based on bgpmon_sample_conf.xml.
'-d' is a optional parameter. It means all the debug info output to screen. Otherwise all the debug info will be outputed to system log. Then you can check the two folders which are specified in config.xml.

4-2. Start the bgpmonclinent in order to the bgpmon is working.
> cd <some-directory-of-you-extract-package>
> bgpmonclient bgpmon-ip bgpmon-port request_type
Notes:
bgpmon-ip = ip address of the running bgpmon
bgpmon-port = port number for the running bgpmon
request_type = summary, message, table
*summary is not implemented yet.
*table needs the 2 following parameters:
peer-ip = ip address of a bgp peer monitored by bgpmon
peer-as = as number of the bgp peer

5. Build your own client
If you want to build you own client, you can built it based on the sample client ' bgpmonclinent'. Please remember that you are monitoring a real-time
stream and need to process it in real-time! Slow clients will be terminated! The requests are sent to the bgpmon in XML format. For the details of request format, refer to the BGPMon XML interface.

1. BGPMon(release 4) is running at machine 129.82.138.6. It is ready to peer with other BGP speakers not requesting MD5 authentication.

2. If you are interested in peering with us, please send me a email including the IP and As of your BGP peer.

3. Any questions, please feel free to contact me.

1. BGPMon(release 4) is running at machine 129.82.138.6. It is ready to accept request from clients now. The port number is 17900.

2. You can download clients here, now query client is available and log client is comming soon.

3. You also can build you own client based on the sample client ' bgpmonclinent'. For the XML interface between BGPMon and clients, please refer here. For the BGPMon data format in XML, please refer here.