TimeBase Grafana plugin allows visualizing TimeBase streams data in Grafana.
Link to QQL (TimeBase Query language) tutorial
This plugin provides a wide range of instruments for time-series data analysis and processing, including functions from financial analysis domain, statistics, etc.
TimeBase plugin uses TimeBase Web Admin REST API - the required component.
IMPORTANT NOTICE
Supported TimeBase versions: [5.5.6, 5.7.*, 6.*]
Supported TimeBase Web Admin versions: [0.5.5, 1.2.*]
Supported Grafana versions: [10.2.0+, 11+]
Other versions are rather incompatible or partially incompatible.
To build the plugin NodeJS >= 20 and Yarn >= 1.22 are required.
Preferred with Docker/Kubernetes.
- Set environment variable
GF_INSTALL_PLUGINS=https://github.com/epam/TimeBaseGrafanaPlugin/releases/download/1.0.11/epam-timebase-datasource.zip;epam-timebase-datasourceandGF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=epam-timebase-datasource. - Restart grafana server.
- Run command
grafana-cli --pluginUrl https://github.com/epam/TimeBaseGrafanaPlugin/releases/download/1.0.11/epam-timebase-datasource.zip plugins install epam-timebase-datasource - Restart Grafana server.
To work with TimeBase WebAdmin, where SSO is enabled, Grafana should be connected to the same SSO provider. After that switch "Forward OAuth Identity" should be used to log in to TimeBase WebAdmin.
Following sections describe TimeBase plugin functionality. See Grafana Docs for more in depth information about all the features and tools offered by Grafana.
Refer to Grafana Docs for more in depth information about all the supported features and tools.
Grafana plugin uses TimeBase as a data source. You can use more than one TimeBase instance as Grafana plugin data source.
- In the Configuration menu select Data Source.
- Click Add Data Source and find your TimeBase Plugin.
- Configure plugin settings
- Name - Plugin name
- URL - TimeBase Web Admin URL
- User - TimeBase Web Admin user Username
- Password - TimeBase Web Admin user Password
- Click Test to check the connection with TimeBase. You will see a confirmation message in case the connection is successful.
- Set toggle to Default to make the current selection a default data source.
You can import standard Dashboards from the public repository.
TimeBase Overview - displays all the available streams (count, names, stream schemas, description), QQL stateful and stateless functions, stream classes messages and fields.
Market Data - visualization of streams with the available market data.
Refer to Grafana Docs for more in depth information about all the supported features and tools.
- Go to Create menu and click Dashboard.
- Click Add new panel to create a dashboard.
The Plugin allows running TimeBase QQL queries in visual editor and raw query modes. Click Edit icon to switch between two modes.
Refer to Grafana Docs for more in depth information about all the supported features and tools.
In this mode you can use built-in UI elements to create and run QQL queries to the selected data source and visualize them on the dashboard.
- In Query tab select TimeBase plugin in the drop down list. Each custom plugin has own set of parameters.
- You may create just one or a combination of several queries. Click + Query to add another query.
In this mode you switch from the UI to the raw QQL query format. Refer to QQL Tutorial to learn more about the TimeBase query language called QQL.
TimeBase plugin offers the following categories of parameters you can use to make data queries:
Time-series data is stored in streams. Each TimeBase instance can be seen as a collection of streams. Here you can select a specific stream to visualize data that it stores.
- Select a stream you wish to place a query to.
- Use WHERE/AND clauses to extract data that meets specific conditions.
Available streams are determined by the TimeBase Web Admin back end.
Time-series data is recorded in streams in a form of Messages. Each message has a timestamp (time and date of a message) and symbol (specific identifier of a data source like sensor id, trading instrument name etc) that serve for data indexing. You can select a specific symbol to sort stream data by, for example display all readings for a specific IoT sensor (sensor id is a symbol value in this case).
- Use drop down list of symbols to select a specific symbol for your query or select All() to display data for all the available symbols.
Available symbols are determined by the TimeBase Web Admin back end.
In this section you can select specific message fields to filter your query, perform different data aggregations and computations using available fields and functions.
Field
TimeBase messages may be of different types (classes). Each message class has a specific set of attributes (fields). In Grafana UI it is visualized as class:field in the Fields section. Imagine a water meter, meter id is a symbol, meter reading is a field. Another example of a field may be a trading instrument price and quantity (trading instrument name is a symbol, price and quantity are fields).
- Select at least one Field from the drop down list of available fields. Available fields are determined by message types (classes) in your stream. The selected data is displayed on the dashboard and is changed as you add more fields and perform any additional manipulations with data.
- On the dashboard, you can select between fields you wish to display.
Functions
You can perform various manipulations with your data set using mathematical, financial and/or statistical functions. Hover over each function to see details. You can use combinations of functions.
Available functions are determined by the TimeBase Web Admin back end.
Aggregations
Use a set of available aggregations and aliases to manipulate with the selected data. You can use a combination of aggregations.
Aggregations cannot be applied to aggregation functions (e.g. bars functions).
Available aggregations are determined by the TimeBase Web Admin back end.
Use this section to set time intervals and to make additional groupings of the selected data. For example, in case you have selected All() symbols from your stream, you can use group by symbol to view data for each symbol in the stream. Use a predefined time range options or manually input time range (e.g. 45s) to sort data in time.
Option
This option is enabled in case you select at least one specific field to Group By your data set. In this case, the selected field(s) serves as a key. You can arrange data with this key either placed in table column or row.
Grafana supports DATAFRAME and TIMESERIES visualization formats. Select the format that your plugin supports.
Additional Information