sigs.k8s.io/kueue@v0.6.2/site/content/en/docs/tasks/enabling_pprof_endpoints.md (about)

     1  ---
     2  title: "Enabling pprof endpoints"
     3  date: 2023-07-21
     4  weight: 3
     5  description: >
     6    Enable pprof endpoints for Kueue controller manager.
     7  ---
     8  
     9  This page shows you how to enable pprof endpoints for Kueue controller manager.
    10  
    11  The intended audience for this page are [batch administrators](/docs/tasks#batch-administrator).
    12  
    13  ## Before you begin
    14  
    15  Make sure the following conditions are met:
    16  
    17  - A Kubernetes cluster is running.
    18  - The kubectl command-line tool has communication with your cluster.
    19  - [Kueue is installed](/docs/installation).
    20  
    21  ## Enabling pprof endpoints
    22  
    23  > _Available in Kueue v0.5.0 and later_
    24  
    25  To enable pprof endpoints, you need to set a `pprofBindAddress` is set in the [manager's configuration](/docs/installation/#install-a-custom-configured-released-version).
    26  
    27  The easiest way to reach pprof port in kubernetes is to use `port-forward` command.
    28  
    29  1. Run the following command to obtain the name of the Pod running Kueue:
    30  
    31  ```shell
    32  kubectl get pod -n kueue-system
    33  NAME                                        READY   STATUS    RESTARTS   AGE
    34  kueue-controller-manager-769f96b5dc-87sf2   2/2     Running   0          45s
    35  ```
    36  
    37  2. Run the following command to initiate the port forwarding to your localhost:
    38  
    39  ```shell
    40  kubectl port-forward kueue-controller-manager-769f96b5dc-87sf2 -n kueue-system 8082:8082
    41  Forwarding from 127.0.0.1:8082 -> 8082
    42  Forwarding from [::1]:8082 -> 8082
    43  ```
    44  
    45  The HTTP endpoint will now be available as a local port.
    46  
    47  To learn how to use the exposed endpoint, see [pprof basic usage](https://github.com/google/pprof#basic-usage) and [examples](https://pkg.go.dev/net/http/pprof#hdr-Usage_examples).