Scripts run in the Live UI offers rich visualizations that are not available with the CLI or API. For this reason, we recommend that developers who are new to Pixie begin by using the Live UI.
Pixie needs to be installed on your Kubernetes cluster. If it is not already installed, please consult our install guides.
Open Pixie's Live UI.
Select your cluster using the
cluster drop-down menu.
px/clusterscript from the
scriptdrop-down menu. The right-half of this menu displays a description of the selected script.
RUNbutton in the top right. The
px/clusterscript lists all of the namespaces, services, nodes and pods on your cluster. After running the script, you should see something similar to the following.
Tables in the script output can be sorted by column by clicking on the column title. Rows in the table can be expanded by clicking on the row.
Scripts often take arguments, which will appear next to the
script drop-down menus. This script takes an argument for
start_timeto set it to
-10mand re-run the script using the
Deep links embedded in the script output allow you to easily navigate between Kubernetes entities.
The "Nodes" table in the
px/cluster script output lists all of the nodes in your cluster.
px/nodescript for that particular node.
Navigating the Live UI is much faster using keyboard shortcuts. To see the shortcut menu, press
shift+? or open the menu item (shown below).
Try out the following 2 shortcuts, we'll use them often.
Run the current script:
ctrl+enter (Windows, Linux) or
Show / hide the script editor:
ctrl+e (Windows, Linux) or
The Live UI's
script drop-down menu lists all of Pixie's open source scripts.
To learn how to use Pixie scripts for a specific use case, check out one of the following tutorials:
To learn how to write your own PxL script, check out the tutorial.
For writing quick, one-off scripts, use the
Scratch Pad. The
Scratch Pad is the first item in the drop-down
script menu. Open the script editor to add code to the empty PxL Script.
Scratch Pad does not yet support persistence, so if you are extensively developing a script, we recommend using the Script Developer Environment.