Grafana
Basics
Users can monitor the visibility and status of their BGP resources in Grafana using our dashboards, which use the user's Prometheus and Loki instances to show both real-time and historical data. The latter can yield useful insights about the stability of the network up to 7 days ago. Each dashboard comes with some preconfigured panels, but we want to encourage our users to create their own panels if they need additional visuals, using PromQL and LogQL queries accordingly.
We offer access to a Grafana (dashboards) endpoint under https://<tenant>-api.codebgp.com/visualization/dashboards
. To access, you first need to get the corresponding credentials from Code BGP. For a full documentation of Grafana please check this page.
Dashboards
Code BGP Dashboard
The Code BGP Dashboard is our main dashboard, that provides information about the status and visibility of the user's resources. The first panel (BGP Updates over time) presents the number of BGP updates that the platform has collected, from the available data services, over a defined period of time.
The next row (Visibility) contains panels that provide insights about the visibility of the user's resources. First the Monitors per Prefix panel presents the number of monitors that currently "see" each user's prefix, meaning the number of monitors that have received a BGP update for the prefix and have not yet withdrawn it. On the other side, the Monitors per ASN panel presents the number of monitors that currently "see" each user's autonomous system, as it belongs to the AS-PATH
of any given BGP update, which is still active.
The last row (Status) contains panels that present the status of the user's resources. The first panel, Announced prefixes per ASN, presents the number of prefixes that have been announced by each user's autonomous system. The other panel, Announced prefixes per Peering, presents the number of prefixes that were announced by the user's autonomous systems over each adjacent peering.
Prefix monitoring
This dashboard is used for showing useful information about specific prefixes. The user needs to input a prefix she wants to monitor, or simply select it from the first panel of the dashboard.
Upon selecting the prefix, the user can see the number of Code BGP monitors that currently see or do not see it around the world (have received BGP updates for this prefix which has not been withdrawn yet). Besides, the user can see the visibility of the prefix, in each country, computed as the ratio of the Code BGP monitors that currently see the prefix in this country, over all the available Code BGP monitors in the country.
The last panel presents the number of BGP announcements and withdrawals that are associated with the selected prefix, over a defined period of time.
Update logs
This dashboard provides raw information about the updates that have been collected by our platform. The first panel (Updates rate) presents the number of announcements and withdrawals we have collected from the available data services.
The user can also see the raw BGP announcements (Announcements panel) and withdrawals (Withdrawals panel) , which can be filtered for specific prefixes, origin AS and peer AS, inputting the corresponding values to the grafana variables.