`/sys/pprof`

Конечная точка /sys/pprof используется для выполнения запроса. Ответы, возвращаемые этими конечными точками, эквивалентны ответам, возвращаемым пакетом http/pprof.

1. Индекс

Эта конечная точка возвращает HTML-страницу со списком доступных профилей.

Метод

Путь

GET

/sys/pprof/

Пример запроса:

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

2. Allocs

Эта конечная точка возвращает выборку исторических распределений памяти за весь срок службы программы.

Метод

Путь

GET

/sys/pprof/allocs

Пример запроса:

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

3. Block

Эта конечная точка возвращает выборку goroutines, участвующих в блокировке примитивов синхронизации.

Он включен для полноты картины, но поскольку StarVault обычно не позволяет собирать эти данные, он не вернет ничего полезного со стандартным двоичным файлом StarVault.

Метод

Путь

GET

/sys/pprof/block

Пример запроса:

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

4. Cmdline

Эта конечная точка возвращает командную строку запущенной программы с аргументами, разделенными байтами NUL.

Метод

Путь

GET

/sys/pprof/cmdline

Пример запроса:

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

5. Goroutine

Эта конечная точка возвращает трассировки стека всех текущих горутин.

Метод

Путь

GET

/sys/pprof/goroutine

5.1. Параметры

debug (int: 0) — Задаёт специальные аргументы для коллекции. Значение 2 приводит к тому, что трассировки стека возвращаются в виде текста, а не в формате pprof по умолчанию.

Пример запроса:

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

6. Heap

Эта конечная точка возвращает выборку выделений памяти живого объекта.

Метод

Путь

GET

/sys/pprof/heap

Пример запроса:

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

7. Mutex

Эта конечная точка возвращает выборку горутин, содержащих спорные мьютексы.

Метод

Путь

GET

/sys/pprof/mutex

Пример запроса:

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

8. Profile

Эта конечная точка возвращает профиль процессора в формате pprof. Профилирование длится в течение времени, указанного в параметре GET в секундах, или 30 секунд, если не указано иное.

Метод

Путь

GET

/sys/pprof/profile

8.1. Параметры

seconds (int: 30) — Указывает продолжительность выполнения команды профилирования. Это значение указывается как параметр запроса.

Пример запроса:

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

9. Symbol

Эта конечная точка возвращает счетчики программ, перечисленные в запросе.

Метод

Путь

GET

/sys/pprof/symbol

Пример запроса:

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

10. Threadcreate

Эта конечная точка возвращает трассировки стека горутин, которые привели к созданию новых потоков ОС.

Метод

Путь

GET

/sys/pprof/threadcreate

Пример запроса:

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

11. Trace

Эта конечная точка возвращает трассировку выполнения в двоичном формате. Трассировка длится в течение времени, указанного в параметре GET (в секундах), или в течение 1 секунды, если не указано иное.

Метод

Путь

GET

/sys/pprof/trace

11.1. Параметры

seconds (int: 1) — указывает продолжительность выполнения команды трассировки. Это значение указывается как параметр запроса.

Пример запроса:

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