»/sys/pprof

The /sys/pprof endpoint is used to query. The response returned by these endpoints are equivalent to those returned by the http/pprof package.

»Index

This endpoint returns an HTML page listing the available profiles.

MethodPath
GET/sys/pprof/

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/

»Allocs

This endpoint returns a sampling of historical memory allocations over the life of the program.

MethodPath
GET/sys/pprof/allocs

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/allocs

»Block

This endpoint returns a sampling of goroutines involved in blocking on synchronization primitives.

It is included for completeness, but since Vault doesn't normally enable collection of this data, it won't return anything useful with the standard Vault binary.

MethodPath
GET/sys/pprof/block

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/block

»Cmdline

This endpoint returns the running program's command line, with arguments separated by NUL bytes.

MethodPath
GET/sys/pprof/cmdline

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/cmdline

»Goroutine

This endpoint returns stack traces of all current goroutines.

MethodPath
GET/sys/pprof/goroutine

»Parameters

  • debug (int: 0) - Specifies special arguments for the collection. A value of 2 results in the stack traces being returned as text instead of the default pprof format.

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/goroutine

»Heap

This endpoint returns a sampling of memory allocations of live object.

MethodPath
GET/sys/pprof/heap

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/heap

»Mutex

This endpoint returns a sampling of goroutines holding contended mutexes.

It is included for completeness, but since Vault doesn't normally enable collection of this data, it won't return anything useful with the standard Vault binary.

MethodPath
GET/sys/pprof/mutex

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/mutex

»Profile

This endpoint returns a pprof-formatted cpu profile payload. Profiling lasts for duration specified in seconds GET parameter, or for 30 seconds if not specified.

MethodPath
GET/sys/pprof/profile

»Parameters

  • seconds (int: 30) - Specifies the duration to run the profiling command. This value is specified as a query parameter.

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/profile

»Symbol

This endpoint returns the program counters listed in the request.

MethodPath
GET/sys/pprof/symbol

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/symbol

»Threadcreate

This endpoint returns stack traces of goroutines that led to the creation of new OS threads.

MethodPath
GET/sys/pprof/threadcreate

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/threadcreate

»Trace

This endpoint returns the execution trace in binary form. Tracing lasts for duration specified in seconds GET parameter, or for 1 second if not specified.

MethodPath
GET/sys/pprof/trace

»Parameters

  • seconds (int: 1) - Specifies the duration to run the tracing command. This value is specified as a query parameter.

»Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/sys/pprof/trace