Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Profiling
GETProfilingSince 1.0SynchronousAuth Required

GetHeapSummary

Get heap memory summary statistics for the specified session.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • sessionIdStringRequired

    Session identifier to retrieve heap summary for.

Responses

200 OK

On success, this API returns the following response structure.

  • sessionIdString

    Session identifier this heap summary belongs to.

    Example: sess-heap001

  • totalAllocBytesString

    Cumulative bytes allocated since the process started.

    Example: 104857600

  • heapInuseBytesString

    Bytes currently in use by the heap.

    Example: 52428800

  • gcCountLong

    Number of completed garbage collection cycles.

    Example: 14

  • nextGcTargetBytesString

    Heap size target that will trigger the next GC cycle.

    Example: 67108864

  • topAllocFunctionsList

    Top functions ranked by heap allocation volume.

    Example: (nested array)

    • funcNameString

      Fully-qualified function name including package path.

      Example: runtime.gcBgMarkWorker

    • packageString

      Go package that contains this function.

      Example: runtime

    • selfPctLong

      Percentage of samples attributed solely to this function.

      Example: 12.5

    • cumulativePctLong

      Percentage of samples including callees of this function.

      Example: 18.3

    • sampleCountString

      Absolute number of profiling samples collected for this function.

      Example: 4200

Endpoint

GET/api/v1/profiling/heap/{sessionId}/summary

/api/v1/profiling/heap/{sessionId}/summary

Operation ID

GetHeapSummary

Permalink

Request Example

curl -X GET '{host}/api/v1/profiling/heap/{sessionId}/summary' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "sessionId": "sess-heap001",
  "totalAllocBytes": 104857600,
  "heapInuseBytes": 52428800,
  "gcCount": 14,
  "nextGcTargetBytes": 67108864,
  "topAllocFunctions": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history