Tutorials | Pixie 101 | Request Tracing (original) (raw)

The move from monolith to microservice architecture has greatly increased the volume of inter-service traffic. Pixie makes debugging this communication between services easy by providing immediate and deep (full-body) visibility into requests flowing through your cluster.

HTTP requests are featured in this tutorial, but Pixie can trace a number of different protocols including DNS, PostgreSQL, and MySQL. See the full list here.

This tutorial will demonstrate how to use Pixie to:

If you're interested in troubleshooting HTTP latency, check out the Service Performance tutorial.

Prerequisites

  1. You will need a Kubernetes cluster with Pixie installed. If you do not have a cluster, you can create a minikube cluster and install Pixie using one of our install guides.
  2. You will need to install the demo microservices application, using Pixie's CLI:

Full-Body HTTP Request

A developer has noticed that the demo application's cart service is reporting errors.

Let's use Pixie to look at HTTP requests with specific types of errors:

  1. Select px/http_data_filtered from the script drop-down menu.

This script shows the most recent HTTP requests in your cluster filtered by service, pod, request path, and response status code.

  1. Select the drop-down arrow next to the status_code argument, type 500, and press Enter to re-run the script.

This filters the HTTP requests to just those with the 500 status code.

  1. Select the drop-down arrow next to the svc argument, type px-sock-shop/carts, and press Enter to re-run the script.

This filters the HTTP requests to just those made to the carts service.

For requests with longer message bodies, it's often easier to view the data in JSON form.

  1. Click on a table row to see the row data in JSON format.
  2. Scroll through the JSON data to find the resp_body key.

We can see that a HTTP POST request to the carts service has returned an error, with the message: Cannot find item in cart.

Service Errors

Once we have identified a specific error coming from the carts service, we will want to go up a level to see how often these errors occur at the service level.

  1. Hover over the HTTP Data table and scroll all the way to the right side.

Pixie's UI makes it easy to quickly navigate between Kubernetes resources. Clicking on any pod, node, service, or namespace name in the UI will open a script showing a high-level overview for that entity.

  1. From the SVC column, click on the px-sock-shop/carts service name.

This will open the px/service script with the service argument pre-filled with the name of the service you selected.

The px/service script shows error rate over time for all inbound HTTP requests.

We can see that the carts service has had a low but consistent error rate over the selected time window.

  1. Scroll down to the Inbound Traffic by Requesting Service table.

This table shows the services making requests to the carts service.

We can see from the ERROR_RATE column that the requests with errors are only coming from the front-end service.

Pod Errors

If services are backed by multiple pods, it is worth inspecting the individual pods to see if a single pod is the source of the service's errors.

  1. Scroll up to the Pod List table.

In this case, the carts service is backed by a single pod. If the service had multiple pods, they would be listed here.

  1. Click on the pod name in the Pod List table.

This will open the px/pod script with the pod argument pre-filled with the name of the pod you selected.

The px/pod script shows HTTP error rate alongside high-level resource metrics.

We can see that there is no resource pressure on this pod and that the HTTP request throughput has been constant over the selected time window.

Resolving this bug requires further insight into the application logic. For Go/C/C++ applications, you might want to try Pixie's continuous profiling feature. Pixie also offers dynamic logging for Go applications.

This tutorial demonstrated a few of Pixie's community scripts. To see full body requests for a specific protocol, check out the following scripts: