open-vault/website/content/api-docs/system/loggers.mdx
Chris Capurso 9501d44ed5
Add endpoints to provide ability to modify logging verbosity (#16111)
* add func to set level for specific logger

* add endpoints to modify log level

* initialize base logger with IndependentLevels

* test to ensure other loggers remain unchanged

* add DELETE loggers endpoints to revert back to config

* add API docs page

* add changelog entry

* remove extraneous line

* add log level field to Core struct

* add godoc for getLogLevel

* add some loggers to c.allLoggers
2022-06-27 11:39:53 -04:00

103 lines
2.2 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: api
page_title: /sys/loggers - HTTP API
description: The `/sys/loggers` endpoint is used modify the verbosity level of logging.
---
# `/sys/loggers`
The `/sys/loggers` endpoint is used modify the verbosity level of logging.
## Modify verbosity level of all loggers
| Method | Path |
| :------ | :------------- |
| `POST` | `/sys/loggers` |
### Parameters
- `level` `(string: <required>)`  Specifies the log verbosity level to be set for all loggers.
Supported values (in order of detail) are `"trace"`, `"debug"`, `"info"`, `"warn"`, and `"error"`.
### Sample Payload
```json
{
"level": "debug",
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/loggers
```
## Modify verbosity level of a single logger
| Method | Path |
| :------ | :------------------- |
| `POST` | `/sys/loggers/:name` |
### Parameters
- `name` `(string: <required>)`  Specifies the logger to be modified (e.g. `audit`, `core`, `expiration`).
- `level` `(string: <required>)`  Specifies the log verbosity level to be set for the provided logger.
Supported values (in order of detail) are `"trace"`, `"debug"`, `"info"`, `"warn"`, and `"error"`.
### Sample Payload
```json
{
"level": "debug",
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/loggers/core
```
## Revert verbosity of all loggers to configured level
| Method | Path |
| :-------- | :------------- |
| `DELETE` | `/sys/loggers` |
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/loggers
```
## Revert verbosity of a single logger to configured level
| Method | Path |
| :-------- | :------------------- |
| `DELETE` | `/sys/loggers/:name` |
### Parameters
- `name` `(string: <required>)`  Specifies the logger to be modified (e.g. `audit`, `core`, `expiration`).
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/sys/loggers/core
```