EXPAND ALL
  • Home

Using the Live UI

PxL scripts can be run in Pixie's web based Live UI or CLI tool. To learn about the CLI, check out this tutorial.

Setup

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

Running your First PxL Script

  1. Open Pixie's Live UI.

  2. Select your cluster using the cluster drop-down menu.

Selecting your cluster in the Live UI.
  1. Select the px/cluster script from the script drop-down menu. The right-half of this menu displays a description of the selected script.
Selecting your script in Live UI.
  1. Run the script using the RUN button in the top right. The px/cluster script lists all of the namespaces, services, nodes and pods on your cluster. After running the script, you should see something similar to the following.
Output of the px/cluster script.

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.

Editing Script Arguments

Scripts often take arguments, which will appear next to the cluster and script drop-down menus. This script takes an argument for start_time.

  1. Modify the start_time to set it to -10m and re-run the script using the RUN button.
Modify the start_time.

Deep Linking

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.

  1. Click on any of the node names in the blue underlined text to be taken to the output of the px/node script for that particular node.
Click on deep links to easily navigate between Kubernetes entities.

Keyboard Shortcuts

Navigating the Live UI is much faster using keyboard shortcuts. To see the shortcut menu, press shift+? or open the menu item (shown below).

Opening the Live UI shortcuts menu.

Try out the following 2 shortcuts, we'll use them often.

  1. Run the current script: ctrl+enter (Windows, Linux) or cmd+enter (Mac)

  2. Show / hide the script editor: ctrl+e (Windows, Linux) or cmd+e (Mac)

Pixie's Open Source Scripts

The Live UI's script drop-down menu lists all of Pixie's open source scripts.

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.

Write Your Own PxL Scripts

To learn how to write PxL scripts, check out this 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.

Use the Scratch Pad script .

The Scratch Pad does not yet support persistence, so if you are extensively developing a script, we recommend using the script developer environment.

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.