Enabling pprof endpoints

Enable pprof endpoints for Kueue controller manager.

This page shows you how to enable pprof endpoints for Kueue controller manager.

The intended audience for this page are batch administrators.

Before you begin

Make sure the following conditions are met:

  • A Kubernetes cluster is running.
  • The kubectl command-line tool has communication with your cluster.
  • Kueue is installed.

Enabling pprof endpoints

Available in Kueue v0.5.0 and later

To enable pprof endpoints, you need to set a pprofBindAddress is set in the manager’s configuration.

The easiest way to reach pprof port in kubernetes is to use port-forward command.

  1. Run the following command to obtain the name of the Pod running Kueue:
kubectl get pod -n kueue-system
NAME                                        READY   STATUS    RESTARTS   AGE
kueue-controller-manager-769f96b5dc-87sf2   2/2     Running   0          45s
  1. Run the following command to initiate the port forwarding to your localhost:
kubectl port-forward kueue-controller-manager-769f96b5dc-87sf2 -n kueue-system 8082:8082
Forwarding from -> 8082
Forwarding from [::1]:8082 -> 8082

The HTTP endpoint will now be available as a local port.

To learn how to use the exposed endpoint, see pprof basic usage and examples.

Last modified March 25, 2024: Organize tasks into folders (#1899) (d43d3ea)