http_handler.go 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. // Copyright (c) 2016 Uber Technologies, Inc.
  2. //
  3. // Permission is hereby granted, free of charge, to any person obtaining a copy
  4. // of this software and associated documentation files (the "Software"), to deal
  5. // in the Software without restriction, including without limitation the rights
  6. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. // copies of the Software, and to permit persons to whom the Software is
  8. // furnished to do so, subject to the following conditions:
  9. //
  10. // The above copyright notice and this permission notice shall be included in
  11. // all copies or substantial portions of the Software.
  12. //
  13. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19. // THE SOFTWARE.
  20. package zap
  21. import (
  22. "encoding/json"
  23. "fmt"
  24. "io"
  25. "net/http"
  26. "go.uber.org/zap/zapcore"
  27. )
  28. // ServeHTTP is a simple JSON endpoint that can report on or change the current
  29. // logging level.
  30. //
  31. // GET
  32. //
  33. // The GET request returns a JSON description of the current logging level like:
  34. // {"level":"info"}
  35. //
  36. // PUT
  37. //
  38. // The PUT request changes the logging level. It is perfectly safe to change the
  39. // logging level while a program is running. Two content types are supported:
  40. //
  41. // Content-Type: application/x-www-form-urlencoded
  42. //
  43. // With this content type, the level can be provided through the request body or
  44. // a query parameter. The log level is URL encoded like:
  45. //
  46. // level=debug
  47. //
  48. // The request body takes precedence over the query parameter, if both are
  49. // specified.
  50. //
  51. // This content type is the default for a curl PUT request. Following are two
  52. // example curl requests that both set the logging level to debug.
  53. //
  54. // curl -X PUT localhost:8080/log/level?level=debug
  55. // curl -X PUT localhost:8080/log/level -d level=debug
  56. //
  57. // For any other content type, the payload is expected to be JSON encoded and
  58. // look like:
  59. //
  60. // {"level":"info"}
  61. //
  62. // An example curl request could look like this:
  63. //
  64. // curl -X PUT localhost:8080/log/level -H "Content-Type: application/json" -d '{"level":"debug"}'
  65. //
  66. func (lvl AtomicLevel) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  67. type errorResponse struct {
  68. Error string `json:"error"`
  69. }
  70. type payload struct {
  71. Level zapcore.Level `json:"level"`
  72. }
  73. enc := json.NewEncoder(w)
  74. switch r.Method {
  75. case http.MethodGet:
  76. enc.Encode(payload{Level: lvl.Level()})
  77. case http.MethodPut:
  78. requestedLvl, err := decodePutRequest(r.Header.Get("Content-Type"), r)
  79. if err != nil {
  80. w.WriteHeader(http.StatusBadRequest)
  81. enc.Encode(errorResponse{Error: err.Error()})
  82. return
  83. }
  84. lvl.SetLevel(requestedLvl)
  85. enc.Encode(payload{Level: lvl.Level()})
  86. default:
  87. w.WriteHeader(http.StatusMethodNotAllowed)
  88. enc.Encode(errorResponse{
  89. Error: "Only GET and PUT are supported.",
  90. })
  91. }
  92. }
  93. // Decodes incoming PUT requests and returns the requested logging level.
  94. func decodePutRequest(contentType string, r *http.Request) (zapcore.Level, error) {
  95. if contentType == "application/x-www-form-urlencoded" {
  96. return decodePutURL(r)
  97. }
  98. return decodePutJSON(r.Body)
  99. }
  100. func decodePutURL(r *http.Request) (zapcore.Level, error) {
  101. lvl := r.FormValue("level")
  102. if lvl == "" {
  103. return 0, fmt.Errorf("must specify logging level")
  104. }
  105. var l zapcore.Level
  106. if err := l.UnmarshalText([]byte(lvl)); err != nil {
  107. return 0, err
  108. }
  109. return l, nil
  110. }
  111. func decodePutJSON(body io.Reader) (zapcore.Level, error) {
  112. var pld struct {
  113. Level *zapcore.Level `json:"level"`
  114. }
  115. if err := json.NewDecoder(body).Decode(&pld); err != nil {
  116. return 0, fmt.Errorf("malformed request body: %v", err)
  117. }
  118. if pld.Level == nil {
  119. return 0, fmt.Errorf("must specify logging level")
  120. }
  121. return *pld.Level, nil
  122. }