Modify Vault log verbosity on the fly (without restarting Vault nodes)

Avatar
Zaid Baban
  • Updated

 

As of Vault versions: 1.12.0 , 1.11.1 and 1.10.5 (OSS and Ent), a change was introduced where you can change the log level verbosity without having to restart your vault node.

The two endpoints that have been introduced are sys/loggers(all loggers) and sys/loggers/:name(an individual logger, e.g.core). Each supports a POST and DELETE to modify and revert back to Vault configuration, respectively.

 

Modify verbosity level of all loggers

The/sys/loggers endpoint is used modify the verbosity level of logging.

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

{
  "level":"debug"
}

 

Sample Request

$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

{
  "level":"debug"
}

Sample Request

$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

$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

$curl\    
--header "X-Vault-Token: ..."\    
--request DELETE \    
http://127.0.0.1:8200/v1/sys/loggers/core

 

 

Resources:

 

 

 

Articles in this section

See more

Related articles