Pixie's primary focus is to build a real-time debugging platform, not a full-fledged observability solution. Use the plugin system to integrate with external tools to enable capabilities like long-term data retention and alerting.
Long-term Data Retention: Pixie retains up to 24 hours of data. Leverage an external datastore for long-term data retention by sending Pixie data in the OpenTelemetry format. Future support will be added for querying long-term data from within the Pixie UI.
Alerts (coming soon): Power alerts using Pixie's rich dataset, all configurable from within the Pixie UI.
The following table lists the plugins available in Pixie:
Plugin Name | Plugin Type | Description | Tutorial | GitHub repo |
---|---|---|---|---|
New Relic | Long-term Data Retention | Send Pixie data formatted in the OpenTelemetry format to New Relic's OpenTelemetry endpoint for long-term data retention, dashboarding, alerting and more. | tutorial | code |
OpenTelemetry | Long-term Data Retention | Send Pixie data formatted in the OpenTelemetry format to any OpenTelemetry collector. | tutorial | code |
Plugins can be configured from within the Admin UI.
Open the Live UI and navigate to the Plugins tab on the Admin page (/admin/plugins
).
Find the plugin you wish to enable and click the toggle to enable/disable the plugin.
Expand the plugin row to specify the necessary configuration values. The required set of fields differs per plugin provider, and usually contains information such as API keys which are used for authentication.
Enable a plugin which offers long-term data retention capabilities to send Pixie data to an external datastore. This plugin allows you to configure PxL scripts to export data at regularly scheduled intervals. This only currently supports exporting data through the OpenTelemetry format.
By default, the plugin provider has configured a set of preset scripts. These will automatically start running and exporting data from all clusters in the org as soon as the plugin is enabled. Users can also choose to export custom data by creating a custom export script.
/configure-data-export
).<Plugin Provider> Scripts
./configure-data-export
).Custom Scripts
, click the Create Scripts
button on the right-hand side.px.export
call for exporting data to the OpenTelemetry format. See our OpenTelemetry export tutorial and OpenTelemetry export reference docs for more information. No endpoint
needs to be specified to the px.otel.Data
object, as this will be filled in automatically based on the selected plugin provider.Coming soon!
Interested in contributing a Pixie plugin?
Check out our Plugin Repository for more details.
Having problems? Check out the Pixie Plugin Troubleshooting guide.