Pxl Community Scripts are open-source scripts which appear under the
px/ namespace in Pixie. These community scripts enable the developer community with a broad repository of use-case specific scripts out of the box. Over time, we hope this grows into a community driven knowledge base of data-driven tools to observe, debug, secure and manage applications.
Pixie (>= v0.4.0) needs to be installed on your Kubernetes cluster. If it is not already installed then please consult our install guides.
You also need to clone the
pixie repo to get the relevant files.
git clone https://github.com/pixie-labs/pixie.git
Filing an issue with an explanation of what use-case you are looking to address help us make sure these community scripts are broadly applicable and useful.
Each Pxl script can have 2 or 3 files in the script folder:
<your script's name>.pxlcontains the PxL script
manifest.jsoncontains metadata like script title, description etc. which help in search and discovery
vis.jsoncontains the spec to visualize your script results
If you are interested, you can developer and test your script in the local environment by following these steps:
make devin the
~/pixie/pxl_scriptsdirectory to start a local dev server
Once your script is ready, you can submit it for review by:
px/namespace in Pixie for the entire Pixie community
Note: We currently have a small set of reviewers to ensure quality and plan to expand it as the platform and community matures.