Configuration: OCS Dashboard

Overview

Apache Superset is a modern data visualisation platform, providing an easy to use environment for creating dashboards and generating and downloading tabular data.

Apache Superset is not OCS-specific, however this page describes the setup of Apache Superset to query data from the OCS reporting database.

Pre-Requisites

Prior to configuring Apache Superste for OCS data processing, ensure that both it and the OCS reporting database are installed. OCS specific installation instructions are included in this documentation.

Dashboard Access

Once installed, Apache Superset will be accessible on the reporting server at the URL: https://n2ocs-reporting-server/superset, or alternatively if Superset is not proxied, at http://n2ocs-reporting-server:8088/superset.

Apache Superset has both authentication and authorization. To access, use the administration username and password defined when installing Superset and running:

superset fab create-admin

Once logged in, a configured system will show a list of dashboards:

Database Connection Configuration

To access the OCS reporting data, Superset must be configured to access the OCS database. To do this, use the databases link in the Data menu to create the database link:

Using the [+] icon in the top-right of the databases page, create a new database connection to the OCS reporting database. In this configuration screen no OCS specific requirements exist (the connection is simply a standard database connection to PostgreSQL):

Once the database connection is saved and the connection successfully completes, the database’s data model is read as metadata into Superset and database tables become available as Superset datasets. Selecting the Datasets option in the Data menu shows these datasets:

Example Dashboard

With the OCS reporting database connection configured, charts and dashboards can be created. Using the Import Dashboard button, provided dashboards can be loaded:

Example dashboards are installed when installing the OCS, in the directory /opt/nsquared/ocs/etc/superset.