mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
226 lines
5.2 KiB
Plaintext
226 lines
5.2 KiB
Plaintext
---
|
|
layout: api
|
|
page_title: /sys/pprof - HTTP API
|
|
description: The `/sys/pprof` endpoint is used to query profiling information.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `/sys/pprof`
|
|
|
|
@include 'alerts/restricted-root.mdx'
|
|
|
|
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.
|
|
|
|
| Method | Path |
|
|
| :----- | :------------ |
|
|
| `GET` | `/sys/pprof/` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------- |
|
|
| `GET` | `/sys/pprof/allocs` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------- |
|
|
| `GET` | `/sys/pprof/block` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :------------------- |
|
|
| `GET` | `/sys/pprof/cmdline` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :--------------------- |
|
|
| `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
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------- |
|
|
| `GET` | `/sys/pprof/heap` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :---------------- |
|
|
| `GET` | `/sys/pprof/mutex` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :------------------- |
|
|
| `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
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :------------------ |
|
|
| `GET` | `/sys/pprof/symbol` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :--------------------- |
|
|
| `GET` | `/sys/pprof/threadcreate` |
|
|
|
|
### Sample request
|
|
|
|
```shell-session
|
|
$ 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.
|
|
|
|
| Method | Path |
|
|
| :----- | :----------------- |
|
|
| `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
|
|
|
|
```shell-session
|
|
$ curl \
|
|
--header "X-Vault-Token: ..." \
|
|
http://127.0.0.1:8200/v1/sys/pprof/trace
|
|
```
|