EXPAND ALL
  • Home
Open Source Docs

Grafana Datasource Plugin

The Pixie Datasource plugin allows you to visualize data from the Pixie observability platform in Grafana.

Installation

Instructions for installing the plugin can be found here.

Usage

To get started using the plugin, check out the tutorial.

Configuration

The plugin requires a Pixie API key and cluster ID to execute queries. Grafana encrypts these values.

  • To create an API key, follow the directions here.
  • To find your cluster's ID, follow the directions here.

Queries

The plugin uses the Pixie Language (PxL) to query telemetry data collected by the Pixie platform.

  • Learn more about the PxL language here.
  • Learn how to write a PxL script here.

If there are syntax errors in your PxL query, Grafana will display an error message.

If an output table has a column containing timestamps, the plugin will sort the table by the first timestamp column.

Grafana requires wide table format to visualize data in a Graph or Time series. If a query output table has a column of timestamps with the heading time_, it will automatically convert the table to wide if necessary.

Macros

Grafana uses macros to add dashboard context to a query. The following macros are supported for PxL queries executed by plugin:

  • __time_from will be replaced by the start of the currently active time selection. Example usage:
df = px.DataFrame(table='http_events', start_time= __time_from)
  • __time_to will be replaced by the end of the currently active time selection. Example usage:
df = px.DataFrame(table='http_events', start_time= __time_from, end_time=__time_to)
  • __interval will be replaced by the suggested duration between time points. Interval is set by the Grafana UI in the Query options section in the Query tab. Example usage:
df.timestamp = px.bin(df.time_, __interval)

Develop

The plugin source code can be found on GitHub. To contribute to the Grafana Pixie Datasource plugin, please check out our Contribution Guidelines.

Get Help

© 2018-21 New Relic, Inc. All Rights Reserved.
This site uses cookies to provide you with a better user experience. By using Pixie, you consent to our use of cookies.