Grafana

Grafana is a web service that serves as another client for rendering information. Specifically, in context of RTC Toolkit is Grafana used to render metrics and information stored in InfluxDB. This chapter serves as a list of all pre-prepared visualisations that are available to users and that can be imported and extended.

Note

All of the following dashboards are created using reusable components from the RTC toolkit and contain visualisations only of those metrics that are stored in InfluxDB by these components. Any of these dashboards can serve as a template and can be extended with additional visualisations, or any visualisation can be removed from it. The dashboard named Template serves purely as a template and is intended from to be copied and modified.

Important

All following dashboards and library panels are written using the SQL query language. It is therefore assumed that when importing these pre-prepared visualisations, the data source with the SQL query language will also be imported. If the imported data source is changed in any way, it will also affect the behavior of these resources.

Prepared dashboards

The RTC Toolkit includes several predefined Grafana resources stored in the $INTROOT/resources/rtctk directory. These resources include library panels, dashboards, data sources, and alerts. For your usage, we recommend copying these resources (for example, to the $INTROOT/resources/<your project> directory) and then versioning them using Git.

Among these files is a default data source named InfluxDBv3. In its configuration, this data source queries the InfluxDB service running at http://localhost:8181 and works with the elt_rtc_tk database. If your InfluxDB is running on a different server or if your database has a different name, please modify the influxdbv3.json file according to your needs. It is also possible to make these changes after importing via the GUI in Grafana.

Server status

This dashboard provides an overview of the status of the resources across the servers running the RTC system. It includes a wide range of software and hardware information, e.g. operating system versions or disk I/O operation rates.

../../_images/Grafana_Res_Server_Status.png

RTC Overview

Main dashboard displaying currently running RTC components in the system. This dashboard is special because it can serve as a navigation router. In addition to basic data on resource usage by individual components, it also contains a table with links to other running components. These links can then be used to access detailed visualisations of the given component.

../../_images/Grafana_Res_RTC_Overview.png

Data Task

Dashboard visualisation for an RTC Toolkit Data Task reusable component.

../../_images/Grafana_Res_Data_Task.png

DDT Server

Dashboard visualisation for an RTC Toolkit DDT server reusable component.

../../_images/Grafana_Res_DDT_Server.png

Deployment Daemon

Dashboard visualisation for the RTC Toolkit Deployment Daemon.

../../_images/Grafana_Res_Deployment_Daemon.png

General Component

This is a general component for any RTC component. It contains the rendering of basic common data as well as Template, but in addition there are indicators for metrics such as Buffer occupancy, Frequency estimate and Duration estimate. These metrics can be filtered using a prefix (variable in this dashboard).

Metadata Collector

Dashboard visualisation for an RTC Toolkit Metadata Collector reusable component.

MUDPI Publisher

Dashboard visualisation for an RTC Toolkit MUDPI Publisher reusable component.

../../_images/Grafana_Res_Mudpi_Publisher.png

RTC Supervisor

Dashboard visualisation for the RTC Supervisor.

../../_images/Grafana_Res_RTC_Supervisor.png

Telemetry Recorder

Dashboard visualisation for an RTC Toolkit Telemetry Recorder reusable component.

../../_images/Grafana_Res_Telemetry_Recorder.png

Telemetry Republisher

Dashboard visualisation for an RTC Toolkit Telemetry Republisher reusable component.

../../_images/Grafana_Res_Telemetry_Republisher.png

Telemetry Subscriber

Dashboard visualisation for an RTC Toolkit Telemetry Subscriber reusable component.

../../_images/Grafana_Res_Telemetry_Subscriber.png

Template

This is a basic dashboard for RTC components. It is prepared to be copied and customised according to needs of a user. Visualisations in this dashboard are only for data that RTC components have in common:

  • CPU usage,

  • memory usage,

  • disk read/write,

  • network read/write,

  • state changes,

  • and alerts.

The display of any additional data is entirely up to the user.

Prepared Library panels

All of the above dashboards use many library panels for rendering. These panels are designed to work with variables in the dashboard and can adapt accordingly. These are the following panels:

  • Alerts

  • Buffer Occupancy

  • CPU Usage

  • Disk IO

  • Duration estimate

  • Frequency estimate

  • Memory Usage

  • Network

  • RTC State diagram