Get samples from CPU profiler

GET /v1/debug/cpu_profile

Query parameters

  • shard integer(int64)
  • wait_ms integer(int64)

Responses

  • 200 application/json

    CPU profile

    Hide response attributes Show response attributes object
    • shard_id integer(int64)

      Shard from which the sample originated

    • dropped_samples integer(int64)

      Number of samples that had to be dropped due to space limitations

    • samples array[object]

      CPU profile samples

      CPU profile sample

      Hide samples attributes Show samples attributes object
      • user_backtrace string

        User backtrace

      • occurrences integer(int64)

        Number of times this backtrace has occurred
  • 400 application/json

    Invalid request

    One of:
    shard_error object wait_ms_error object
GET /v1/debug/cpu_profile 
curl \
 --request GET 'http://localhost:9644/v1/debug/cpu_profile'
Response examples (200) 
[
  {
    "shard_id": 42,
    "dropped_samples": 42,
    "samples": [
      {
        "user_backtrace": "string",
        "occurrences": 42
      }
    ]
  }
]
Response examples (400) 
{
  "message": "Invalid shard ID, check shard limit",
  "code": 400
}
{
  "message": "wait_ms must be between 1ms and 15min",
  "code": 400
}