Plugins 〉Pixie Grafana Datasource Plugin
Pixie Grafana Datasource Plugin
What is Pixie?
Pixie is an observability platform for Kubernetes. It allows developers to debug, monitor, and explore their applications. Pixie uses eBPF to automatically capture telemetry data without the need for manual instrumentation.
This plugin allows Grafana users to use Pixie as a datasource in their Grafana dashboards. It can be used to visualize the following data automatically collected in Pixie:
Protocol tracing and metrics: Pixie automatically collects full-body messages between the pods of your applications. Supports protocols such as HTTP, MySQL, DNS, and Redis. You can also expose application metrics such as request latency, error rate, and throughput.
Resource metrics: CPU, memory and I/O metrics for your pods. For more information, see the Infra Health tutorial.
Network metrics: Network-layer and connection-level RX/TX statistics. For more information, see the Network Monitoring tutorial.
JVM metrics: JVM memory management metrics for Java applications.
Application CPU profiles: Sampled stack traces from your application.
<img src=".readme_assets/service-throughput.png" alt="Service throughput" width="525">
<img src=".readme_assets/http-errors.png" alt="HTTP errors by service" width="525">
Install Pixie on your Kubernetes cluster.
Installing the Plugin
On Grafana Cloud
The Pixie datasource plugin is available on Grafana Cloud, which makes it easy to install Grafana plugins to your Grafana Cloud instance.
On a local Grafana instance
In order to deploy to a local Grafana instance, you can run the following command:
grafana-cli plugins install pixie-pixie-datasource
Using the plugin
Check out the Grafana plugin tutorial on Pixie's docs.
Pixie's data can be accessed using PxL, the query language for the data it collects. This datasource allows Grafana users to enter a PxL script when using Pixie as a datasource for a panel in their dashboard.
If you want to add a new feature to the plugin, check out
CONTRIBUTING.md. We welcome the contributions of the community!
Clone the repo
git clone firstname.lastname@example.org:pixie-io/grafana-plugin.git
Building from source: front-end
Once the repo has been cloned, please:
Build plugin in development mode or run in watch mode
Build plugin in production mode
Building from source: back-end
Update Grafana plugin SDK for Go dependency to the latest minor version:
go get -u github.com/grafana/grafana-plugin-sdk-go
Build backend plugin binaries for Linux, Windows and Darwin:
Installing the dev version of the plugin
Installing Pixie Grafana Datasource Plugin 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.
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 Pixie Grafana Datasource Plugin 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. 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.
Initial release. This plugin supports Pixie as a backend datasource for Grafana. Both time range and interval macros are supported.