VAULT-9427: Add read support to sys/loggers endpoints
#17979
Conversation
| err = b.Core.SetLogLevelByName(nameRaw.(string), level) | ||
| if err != nil { | ||
| return logical.ErrorResponse(fmt.Sprintf("invalid params: %s", err.Error())), nil | ||
| name := nameRaw.(string) |
There was a problem hiding this comment.
nit: Do we need to check if name is an empty string here the same as above functions?
There was a problem hiding this comment.
Yes, we should. Thanks!
| @@ -112,6 +112,8 @@ func ParseLogFormat(format string) (LogFormat, error) { | |||
| } | |||
| } | |||
|
|
|||
| // ParseLogLevel returns the hclog.Level that corresponds with the provided level string. | |||
| // This differs hclog.LevelFromString in that it supports additional level strings. | |||
There was a problem hiding this comment.
I think I took this code and refactored it into a function when adding the log file feature, so this is my bad and thanks for adding comments!
However, I think that the func should probably not include notice or warning as that hasn't (to my knowledge) been documented on our site.
There's also differing info depending on whether you look at the docs for the server command or Vault configuration.
Trace, Debug, Error, Warn, Info. vs trace, debug, info, warn, *err*.
My PR I have open at the moment to add rotation to log files has updates to the docs to make them all standardised, and I will also update ParseLogLevel to not handle notice, warning or "" which defaults to info.
* add logger->log-level str func * ensure SetLogLevelByName accounts for duplicates * add read handlers for sys/loggers endpoints * add changelog entry * update docs * ignore base logger * fix docs formatting issue * add ReadOperation support to TestSystemBackend_Loggers * add more robust checks to TestSystemBackend_Loggers * add more robust checks to TestSystemBackend_LoggersByName * check for empty name in delete handler
* add initial logging helper package * VAULT-9427: Add read support to `sys/loggers` endpoints (#17979) * add logger->log-level str func * ensure SetLogLevelByName accounts for duplicates * add read handlers for sys/loggers endpoints * add changelog entry * update docs * ignore base logger * fix docs formatting issue * add ReadOperation support to TestSystemBackend_Loggers * add more robust checks to TestSystemBackend_Loggers * add more robust checks to TestSystemBackend_LoggersByName * check for empty name in delete handler * add logfile * remove doc changes
PR #16111 added support to modify server logging verbosity both globally and for individual loggers. It did not, however, add the ability to read the current state of the logger verbosity levels. This PR introduces read handlers for the
sys/loggersandsys/loggers/:nameendpoints.Additional more low-level changes:
Core.SetLogLevelByNameto account for the potential ofCore.allLoggersincluding loggers that share the same namesys/loggershandlers to useParseLogLevelfrom the logging helper package to remove redundant codesys/loggersendpoints do not handle base logger (name =="")TranslateLoggerLevelfunc to the logging helper package to determine the logging verbosity of anhclog.LoggerExample output on a dev server (
vault server -dev):