ris-live-rs

Rust

Provides parsing functions for RIS-Live real-time BGP message stream JSON data.

The main parsing function, parse_ris_live_message converts a JSON-formatted message string into a vector of BgpElems.

Example

```rust use serdejson::json; use tungstenite::{connect, Message}; use url::Url; use rislivers::error::ParserRisliveError; use rislivers::parserislivemessage;

const RISLIVEURL: &str = "ws://ris-live.ripe.net/v1/ws/?client=rust-bgpkit-parser";

/// This is an example of subscribing to RIS-Live's streaming data. /// /// For more RIS-Live details, check out their documentation at https://ris-live.ripe.net/manual/ fn main() { // connect to RIPE RIS Live websocket server let (mut socket, response) = connect(Url::parse(RISLIVE_URL).unwrap()) .expect("Can't connect to RIS Live websocket server");

// subscribe to messages from one collector
let msg = json!({"type": "ris_subscribe", "data": null}).to_string();
socket.write_message(Message::Text(msg)).unwrap();

loop {
    let msg = socket.read_message().expect("Error reading message").to_string();
    if msg.is_empty() {
        continue
    }
    match parse_ris_live_message(msg.as_str()) {
        Ok(elems) => {
            for e in elems {
                println!("{}", e);
            }
        }
        Err(error) => {
            if let ParserRisliveError::ElemEndOfRibPrefix = error {
                println!("{:?}", &error);
                println!("{}", msg);
                continue
            }
            break;
        }
    }
}

} ```

Filtering

ris-live-rs support filtering message by composing customized ris-live subscription message. Use the compose_subscription_message function to create a filtering message.

```rust pub fn composesubscriptionmessage( host: Option, msgtype: Option, require: Option, peer: Option, prefix: Option, path: Option, morespecific: bool, less_specific: bool, ) -> String { ... }

// subscribe to messages from one collector let msg = composesubscriptionmessage( opts.host, opts.msgtype, opts.require, opts.peer, opts.prefix, opts.path, opts.morespecific, opts.lessspecific ); println!("{}", &msg); socket.writemessage(Message::Text(msg)).unwrap(); ```

ris-live-reader

ris-live-rs library also comes with a simple command-line program that supports filtering and different output formats: ris-live-reader.

asciicast

Full command-line options are: ``` ris-live-rs 0.1.0

Mingwei Zhang mingwei@bgpkit.com

ris-live-reader is a simple cli tool that can stream BGP data from RIS-Live project with websocket

USAGE: ris-live-reader [OPTIONS]

OPTIONS: --client client name to identify the stream [default: ris-live-rs] -h, --help Print help information --host Filter by RRC host: e.g. rrc01 --json Output as JSON objects --less-specific Match prefixes that are less specific (contain) prefix --more-specific Match prefixes that are more specific (part of) prefix --msg-type Only include messages of a given BGP or RIS type: UPDATE, OPEN, NOTIFICATION, KEEPALIVE, or RISPEERSTATE --path ASN or pattern to match against the AS PATH attribute --peer Only include messages sent by the given BGP peer --prefix Filter UPDATE messages by prefixes in announcements or withdrawals --pretty Pretty-print JSON output --raw Print out raw message without parsing --require Only include messages containing a given key -V, --version Print version information ```

Installation

Install via cargo by: bash cargo install ris-live-rs

Or checkout the repo and run: bash cargo install --path .

The program ris-live-reader will be installed to your $CARGO_HOME/bin (e.g. ~/.cargo/bin).

Run with Docker

bash docker run --rm -it bgpkit/ris-live-reader --help

Minimum Supported Rust Version (MSRV)

1.46.0

Built with ❤️ by BGPKIT Team

BGPKIT is a small-team start-up that focuses on building the best tooling for BGP data in Rust. We have 10 years of experience working with BGP data and believe that our work can enable more companies to start keeping tracks of BGP data on their own turf. Learn more about what services we provide at https://bgpkit.com.

https://bgpkit.com/favicon.ico