Plugins 〉Compass
Compass
Compass Panel
Overview / Introduction
Compass is a Grafana visualization plugin for displaying heading or orientation data on a compass dial.
It is especially useful for ship navigation, robotics, UAVs, or any time-series data representing direction in degrees (0–360).
Optionally the panel can display true and/or apparent wind angle.
Features
- Smoothly animated compass dial that rotates with heading values.
- Multiple needle types:
- Default: classic north/south needle with red tip.
- Arrow: bold arrow-style needle.
- Ship: minimal ship silhouette pointing forward.
- Custom SVG: load your own vector as a needle.
- Custom PNG: load your own bitmap as a needle.
- Cardinal direction labels (N/E/S/W).
- Configurable colors for bezel, dial, text, needle, and tail.
- Minor and major tick marks for easy orientation.
- Optional numeric heading readout (e.g.
273°
). - Optional indicator and numeric heading for true wind direction.
- Optional indicator and numeric heading for apparent wind direction.
Getting Started
- Install the plugin by copying it into Grafana’s plugin directory or installing from the Grafana Marketplace.
- Restart Grafana.
- Add a new panel and select Compass as the visualization.
- Configure the data source and select the field representing heading (0–360 degrees).
Options
Data Options
- Heading Field: Select the numeric field in your series that represents heading in degrees.
Display Options
- Show Labels: Toggle cardinal direction labels (N/E/S/W).
- Show Numeric Heading: Display a numeric degree readout below the compass.
Needle Options
Needle Type
Default
– red-tipped classic compass needleArrow
– stylized arrow needleShip
– simplified vessel silhouette (points to heading)SVG
– load a custom vector (provide URL or relative path)PNG
– load a custom image (provide URL or relative path)
Needle Color: Color of the primary needle.
Tail Color: Color of the tail (for default needle).
Custom SVG: Path/URL to your own SVG asset.
Custom PNG: Path/URL to your own PNG asset.
Colors
- Dial Color – background of compass dial.
- Bezel Color – outer rim.
- Text Color – labels, ticks, numeric heading.
- True Wind Color: Color of the true wind indicator.
- Apparent Wind Color: Color of the apparent wind indicator.
Screenshots
Arrow needle with labels and numeric heading enabled
Arrow needle with labels and numeric heading enabled
Ship silhouette needle for vessel heading visualization
Standard needle compass with custom styling
North up orientation for wind dial visualization
Bow up orientation for wind dial visualization
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Compass on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
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 Panel
Use the grafana-cli tool to install Compass 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.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
Changelog
1.0.0 (Unreleased)
Initial release.