Ability to change log verbosity while the node is running #799
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // Copyright (c) 2024 The VeChainThor developers | ||
|
|
||
| // Distributed under the GNU Lesser General Public License v3.0 software license, see the accompanying | ||
| // file LICENSE or <https://www.gnu.org/licenses/lgpl-3.0.html> | ||
|
|
||
| package admin | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "log/slog" | ||
| "net/http" | ||
|
|
||
| "github.com/gorilla/handlers" | ||
| "github.com/gorilla/mux" | ||
| "github.com/vechain/thor/v2/log" | ||
| ) | ||
|
|
||
| type logLevelRequest struct { | ||
| Level string `json:"level"` | ||
| } | ||
|
|
||
| type logLevelResponse struct { | ||
| CurrentLevel string `json:"currentLevel"` | ||
| } | ||
|
|
||
| type errorResponse struct { | ||
| ErrorCode int `json:"errorCode"` | ||
| ErrorMessage string `json:"errorMessage"` | ||
| } | ||
|
|
||
| func writeError(w http.ResponseWriter, errCode int, errMsg string) { | ||
| w.Header().Set("Content-Type", "application/json") | ||
| w.WriteHeader(errCode) | ||
| json.NewEncoder(w).Encode(errorResponse{ | ||
| ErrorCode: errCode, | ||
| ErrorMessage: errMsg, | ||
| }) | ||
| } | ||
|
|
||
| func getLogLevelHandler(logLevel *slog.LevelVar) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, r *http.Request) { | ||
| response := logLevelResponse{ | ||
| CurrentLevel: logLevel.Level().String(), | ||
| } | ||
| if err := json.NewEncoder(w).Encode(response); err != nil { | ||
| writeError(w, http.StatusInternalServerError, "Failed to encode response") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func postLogLevelHandler(logLevel *slog.LevelVar) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, r *http.Request) { | ||
| var req logLevelRequest | ||
| if err := json.NewDecoder(r.Body).Decode(&req); err != nil { | ||
| writeError(w, http.StatusBadRequest, "Invalid request body") | ||
| return | ||
| } | ||
|
|
||
| switch req.Level { | ||
| case "debug": | ||
| logLevel.Set(log.LevelDebug) | ||
| case "info": | ||
| logLevel.Set(log.LevelInfo) | ||
| case "warn": | ||
| logLevel.Set(log.LevelWarn) | ||
| case "error": | ||
| logLevel.Set(log.LevelError) | ||
| case "trace": | ||
| logLevel.Set(log.LevelTrace) | ||
| case "crit": | ||
| logLevel.Set(log.LevelCrit) | ||
| default: | ||
| writeError(w, http.StatusBadRequest, "Invalid verbosity level") | ||
| return | ||
| } | ||
|
|
||
| w.Header().Set("Content-Type", "application/json") | ||
| response := logLevelResponse{ | ||
| CurrentLevel: logLevel.Level().String(), | ||
| } | ||
| w.WriteHeader(http.StatusOK) | ||
| json.NewEncoder(w).Encode(response) | ||
| } | ||
| } | ||
|
|
||
| func logLevelHandler(logLevel *slog.LevelVar) http.HandlerFunc { | ||
| return func(w http.ResponseWriter, r *http.Request) { | ||
| switch r.Method { | ||
| case http.MethodGet: | ||
| getLogLevelHandler(logLevel).ServeHTTP(w, r) | ||
| case http.MethodPost: | ||
| postLogLevelHandler(logLevel).ServeHTTP(w, r) | ||
| default: | ||
| writeError(w, http.StatusMethodNotAllowed, "method not allowed") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func HTTPHandler(logLevel *slog.LevelVar) http.Handler { | ||
| router := mux.NewRouter() | ||
| router.HandleFunc("/admin/loglevel", logLevelHandler(logLevel)) | ||
| return handlers.CompressHandler(router) | ||
| } | ||
|
Comment on lines
+99
to
+103
There was a problem hiding this comment. What if the same pattern of the api package was used ? There was a problem hiding this comment. Wouldn't it make more sense to use the same pattern as the metrics server since our goal is something similar? In the metric's case the |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think it would be good to have some unit tests ? Since we're setting the package up, perhaps it would make any refactor easy at this stage.