/api/v0/diag/profile

Collect a performance profile for debugging.

Arguments

• output [string]: The path where the output .zip should be stored. Default: ./ipfs-profile-[timestamp].zip. Required: no.

• collectors [array]: The list of collectors to use for collecting diagnostic data. Default: [goroutines-stack goroutines-pprof version heap allocs bin cpu mutex block trace]. Default: [goroutines-stack goroutines-pprof version heap allocs bin cpu mutex block trace]. Required: no.

• profile-time [string]: The amount of time spent profiling. If this is set to 0, then sampling profiles are skipped. Default: 30s. Required: no.

• mutex-profile-fraction [int]: The fraction 1/n of mutex contention events that are reported in the mutex profile. Default: 4. Required: no.

• block-profile-rate [string]: The duration to wait between sampling goroutine-blocking events for the blocking profile. Default: 1ms. Required: no.

Response

On success, the call to this endpoint will return with 200 and the following body:

This endpoint returns a `text/plain` response body.

cURL Example

curl -X POST "http://127.0.0.1:5001/api/v0/diag/profile?output=<value>&collectors=[goroutines-stack goroutines-pprof version heap allocs bin cpu mutex block trace]&profile-time=30s&mutex-profile-fraction=4&block-profile-rate=1ms"