---
title: "Get CPU profile for a debug session"
url: "https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4/operations/getDebugSessionCPUProfile"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4.md

# Get CPU profile for a debug session

`GET` `/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/profiles/cpu`

Operation ID: `getDebugSessionCPUProfile`

Get CPU profile for a debug session with support for multiple formats (otel/flamegraph/frames)

## Path parameters

- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.
- `debugSessionId` (string, uuid, required) - Debug Session identifier

## Query parameters

- `format` (string, optional) - The format in which cpu profile should be returned

## Responses

- `200` - Returns cpu profile belonging to a session
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Dolly APIs
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/profiles/cpu:
    get:
      operationId: getDebugSessionCPUProfile
      summary: Get CPU profile for a debug session
      description: Get CPU profile for a debug session with support for multiple
        formats (otel/flamegraph/frames)
      parameters:
        - $ref: "#/components/parameters/controlPlaneId"
        - $ref: "#/components/parameters/debugSessionId"
        - $ref: "#/components/parameters/cpuProfileFormat"
      responses:
        "200":
          $ref: "#/components/responses/CPUProfileResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Session Profiles
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    controlPlaneId:
      name: controlPlaneId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your control plane. This variable is available in the
        Konnect manager.
    debugSessionId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: debugSessionId
      in: path
      required: true
      description: Debug Session identifier
    cpuProfileFormat:
      schema:
        type: string
        default: frames
        enum:
          - frames
          - flamegraph
          - otel
      name: format
      in: query
      required: false
      description: The format in which cpu profile should be returned
  responses:
    CPUProfileResponse:
      description: Returns cpu profile belonging to a session
      content:
        application/json:
          schema:
            type: object
            properties:
              metadata:
                $ref: "#/components/schemas/CPUProfileMetadata"
              frames:
                type: array
                items:
                  $ref: "#/components/schemas/CPUProfileFrame"
              flamegraph:
                $ref: "#/components/schemas/CPUProfileFlamegraph"
            required:
              - metadata
          examples:
            Frames Format Example:
              $ref: "#/components/examples/CPUProfileResponseFramesFormatExample"
            Flamegraph Format Example:
              $ref: "#/components/examples/CPUProfileResponseFlamegraphFormatExample"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    CPUProfileMetadata:
      description: Represents the metadata for the cpu profile
      type: object
      properties:
        resource:
          $ref: "#/components/schemas/Resource"
        profile:
          $ref: "#/components/schemas/ProfileMetadata"
      required:
        - profile
    CPUProfileFrame:
      description: Represents a frame in a cpu profile
      type: object
      properties:
        stacktrace:
          description: The stacktrace for the frame
          type: string
        value:
          description: The number of times the stacktrace was sampled in the profile
          type: integer
          format: uint64
        locations:
          type: array
          items:
            $ref: "#/components/schemas/CPUProfileFrameLocation"
        attributes:
          $ref: "#/components/schemas/Attributes"
      required:
        - stacktrace
        - value
        - locations
    CPUProfileFlamegraph:
      description: Represents the flamegraph representation of a cpu profile
      type: object
      properties:
        root:
          $ref: "#/components/schemas/CPUProfileFlamegraphNode"
      required:
        - root
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    Resource:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/Attributes"
    ProfileMetadata:
      description: Contains the metadata for the profile
      type: object
      properties:
        type:
          description: Represents the type of profile
          type: string
        mode:
          description: Represents the mode for the profile
          type: string
        attributes:
          $ref: "#/components/schemas/Attributes"
      required:
        - type
        - mode
    CPUProfileFrameLocation:
      description: The location in the cpu profiling frame (contains function, line,
        file metadata)
      type: object
      properties:
        function:
          $ref: "#/components/schemas/CPUProfileFunction"
        line:
          description: The line number for the function call
          type: integer
    Attributes:
      type: object
    CPUProfileFlamegraphNode:
      description: Represents a node in the flamegraph tree
      type: object
      properties:
        location:
          $ref: "#/components/schemas/CPUProfileFrameLocation"
        value:
          description: The value associated with this node in the flamegraph tree
          type: integer
          format: uint64
        children:
          type: array
          items:
            $ref: "#/components/schemas/CPUProfileFlamegraphNode"
      required:
        - children
        - value
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    CPUProfileFunction:
      description: Represents a function in the cpu profile (contains the name of the
        function and the file where it's defined)
      type: object
      properties:
        name:
          description: The name of the function
          type: string
        file:
          description: The file where the function is defined
          type: string
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    CPUProfileResponseFramesFormatExample:
      value:
        metadata:
          profile:
            mode: instruction
            type: cpu
        frames:
          - locations:
              - function:
                  file: /usr/local/openresty/site/lualib/resty/events/worker.lua
                  name: Lua()
                line: 151
              - function:
                  file: /usr/local/openresty/site/lualib/resty/events/worker.lua
                  name: terminating()
                line: 116
            stacktrace: "@/usr/local/openresty/site/lualib/resty/events/worker.lua:151:Lua(\
              );@/usr/local/openresty/site/lualib/resty/events/worker.lua:116:t\
              erminating()"
            value: 1
          - locations:
              - function:
                  file: /usr/local/share/lua/5.1/kong/clustering/telemetry.lu
                  name: Lua()
                line: 105
              - function:
                  file: /usr/local/openresty/site/lualib/resty/websocket/client.lua
                  name: recv_frame()
                line: 367
            stacktrace: "@/usr/local/share/lua/5.1/kong/clustering/telemetry.lua:105:Lua();\
              @/usr/local/openresty/site/lualib/resty/websocket/client.lua:367:\
              recv_frame()"
            value: 1
    CPUProfileResponseFlamegraphFormatExample:
      value:
        metadata:
          profile:
            mode: instruction
            type: cpu
        flamegraph:
          root:
            value: 1056
            children:
              - location:
                  function:
                    file: /usr/local/openresty/site/lualib/resty/events/worker.lua
                    name: Lua()
                  line: 151
                value: 56
                children:
                  - location:
                      function:
                        file: /usr/local/openresty/site/lualib/resty/events/worker.lua
                        name: terminating()
                      line: 116
                    value: 450
                    children: []
              - location:
                  function:
                    file: /usr/local/share/lua/5.1/kong/clustering/telemetry.lua
                    name: Lua()
                  line: 105
                value: 550
                children: []
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
```
