EXPAND ALL
  • Home

How to Write a PxL Script

Overview

Pixie's API 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.

Setup

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

Writing PxL Scripts

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

Writing PxL Scripts with Visualizations

This tutorial series adds visualizations to the PxL script developed in the Writing PxL Scripts tutorial series. Pixie's Live UI will be used to execute the script.

Writing Advanced PxL Scripts

This tutorial series will demonstrate how to write a PxL script to extend the Pixie platform to collect new data sources. (coming soon)

Getting Help

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

Copyright © 2018- The Pixie Authors. 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.