How to Write a PxL Script

Pixie uses PxL scripts to both:

1. Query telemetry data collected by the Pixie Platform (DNS events, HTTP events, etc).
2. Extend Pixie to collect new data sources (in addition to those it collects by default).

PxL scripts can be executed by the Pixie platform by using the web based Live UI, CLI or API.

Pixie needs to be installed on your Kubernetes cluster. If it is not already installed, please consult our install guides.

This tutorial series demonstrates how to write a PxL script to query data automatically collected by Pixie's platform. Pixie's CLI is used to execute the script.

• (Prerequisite) Install Pixie's CLI tool
• (Optional Prerequisite) Learn how to navigate the CLI
• Tutorial #1: Write your first PxL script
• Tutorial #2: Finish your first PxL script

This tutorial series demonstrates how to write a Vis Spec to accompany the PxL script developed in Tutorial #1 and Tutorial #2. Pixie's Live UI is used to execute the script.

• (Optional Prerequisite) Learn how to navigate the Live UI
• Tutorial #3: Write your first Vis Spec
• Tutorial #4: Add a Timeseries chart to your Vis Spec
• Tutorial #5: Add a Graph to your Vis Spec

These tutorials demonstrate how to write a PxL script that extends the Pixie platform to collect new data sources:

• Tutorial: Distributed bpftrace deployment
• Tutorial: Dynamic Go logging

To see these features in action, check out the following blog posts:

• Dumpster Diving the Go Garbage Collector: using Pixie's dynamic Go logging to understand how Go garbage collection works.
• Distributed bpftrace with Pixie: how to deploy bpftrace tools across your cluster using Pixie.

If you have questions about these tutorials, we’d be happy to help out on our GitHub or community Slack.

PxL ScriptsTutorial #1: Write your first PxL script