Plugins 〉Tokio Console


Developer

Ben Sully

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


Data Source
community

Tokio Console

  • Overview
  • Installation
  • Change log
  • Related content

Grafana Tokio Console Data Source

This is a streaming Grafana data source which can connect to the Tokio console subscriber. It provides similar functionality to the console TUI frontend (albeit more limited at the moment!). It currently supports the 'tasks list' and 'task details' data streams.

Usage

You can create a new Tokio Console data source for each process that you want to connect to. The

Configuring the data source

Only two parameters are available for the data source:

  • URL - The address of a console-enabled process to connect to. Equivalent to the <TARGET_ADDR> argument of the console TUI.
  • Retain for - how long to continue displaying completed tasks and dropped resources after they have been closed. Equivalent to the --retain-for flag of the console TUI.

Using the data source

The easiest way to use the data source is to import the default dashboards that come with it. To do so, navigate to the data source's settings page and click the 'Dashboards' tab, then click the 'Import' button for all available dashboards.

You can also create arbitrary visualisations of the (streaming) data using Grafana's standard panels + transforms. The recommended path to doing so is to take a look at the panels in the imported dashboards and make incremental changes to a copy of the dashboard.

Installing Tokio Console on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Data Source

Use the grafana-cli tool to install Tokio Console from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Configure the Data Source

Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.

Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.

To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.0.1

Changed

  • Loosened requirements on Grafana to allow the plugin to run on any version greater than 8.4.0.

1.0.0 - 2022-05-06

Initial release.