loggerv2.go 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. /*
  2. *
  3. * Copyright 2017, Google Inc.
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without
  7. * modification, are permitted provided that the following conditions are
  8. * met:
  9. *
  10. * * Redistributions of source code must retain the above copyright
  11. * notice, this list of conditions and the following disclaimer.
  12. * * Redistributions in binary form must reproduce the above
  13. * copyright notice, this list of conditions and the following disclaimer
  14. * in the documentation and/or other materials provided with the
  15. * distribution.
  16. * * Neither the name of Google Inc. nor the names of its
  17. * contributors may be used to endorse or promote products derived from
  18. * this software without specific prior written permission.
  19. *
  20. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. *
  32. */
  33. package grpclog
  34. import (
  35. "io"
  36. "io/ioutil"
  37. "log"
  38. "os"
  39. "strconv"
  40. )
  41. // LoggerV2 does underlying logging work for grpclog.
  42. type LoggerV2 interface {
  43. // Info logs to INFO log. Arguments are handled in the manner of fmt.Print.
  44. Info(args ...interface{})
  45. // Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.
  46. Infoln(args ...interface{})
  47. // Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.
  48. Infof(format string, args ...interface{})
  49. // Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.
  50. Warning(args ...interface{})
  51. // Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.
  52. Warningln(args ...interface{})
  53. // Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.
  54. Warningf(format string, args ...interface{})
  55. // Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.
  56. Error(args ...interface{})
  57. // Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
  58. Errorln(args ...interface{})
  59. // Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
  60. Errorf(format string, args ...interface{})
  61. // Fatal logs to ERROR log. Arguments are handled in the manner of fmt.Print.
  62. // This function should call os.Exit() with a non-zero exit code.
  63. Fatal(args ...interface{})
  64. // Fatalln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
  65. // This function should call os.Exit() with a non-zero exit code.
  66. Fatalln(args ...interface{})
  67. // Fatalf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
  68. // This function should call os.Exit() with a non-zero exit code.
  69. Fatalf(format string, args ...interface{})
  70. // V reports whether verbosity level l is at least the requested verbose level.
  71. V(l int) bool
  72. }
  73. // SetLoggerV2 sets logger that is used in grpc to a V2 logger.
  74. // Not mutex-protected, should be called before any gRPC functions.
  75. func SetLoggerV2(l LoggerV2) {
  76. logger = l
  77. }
  78. const (
  79. // infoLog indicates Info severity.
  80. infoLog int = iota
  81. // warningLog indicates Warning severity.
  82. warningLog
  83. // errorLog indicates Error severity.
  84. errorLog
  85. // fatalLog indicates Fatal severity.
  86. fatalLog
  87. )
  88. // severityName contains the string representation of each severity.
  89. var severityName = []string{
  90. infoLog: "INFO",
  91. warningLog: "WARNING",
  92. errorLog: "ERROR",
  93. fatalLog: "FATAL",
  94. }
  95. // loggerT is the default logger used by grpclog.
  96. type loggerT struct {
  97. m []*log.Logger
  98. v int
  99. }
  100. // NewLoggerV2 creates a loggerV2 with the provided writers.
  101. // Fatal logs will be written to errorW, warningW, infoW, followed by exit(1).
  102. // Error logs will be written to errorW, warningW and infoW.
  103. // Warning logs will be written to warningW and infoW.
  104. // Info logs will be written to infoW.
  105. func NewLoggerV2(infoW, warningW, errorW io.Writer) LoggerV2 {
  106. return NewLoggerV2WithVerbosity(infoW, warningW, errorW, 0)
  107. }
  108. // NewLoggerV2WithVerbosity creates a loggerV2 with the provided writers and
  109. // verbosity level.
  110. func NewLoggerV2WithVerbosity(infoW, warningW, errorW io.Writer, v int) LoggerV2 {
  111. var m []*log.Logger
  112. m = append(m, log.New(infoW, severityName[infoLog]+": ", log.LstdFlags))
  113. m = append(m, log.New(io.MultiWriter(infoW, warningW), severityName[warningLog]+": ", log.LstdFlags))
  114. ew := io.MultiWriter(infoW, warningW, errorW) // ew will be used for error and fatal.
  115. m = append(m, log.New(ew, severityName[errorLog]+": ", log.LstdFlags))
  116. m = append(m, log.New(ew, severityName[fatalLog]+": ", log.LstdFlags))
  117. return &loggerT{m: m, v: v}
  118. }
  119. // newLoggerV2 creates a loggerV2 to be used as default logger.
  120. // All logs are written to stderr.
  121. func newLoggerV2() LoggerV2 {
  122. errorW := ioutil.Discard
  123. warningW := ioutil.Discard
  124. infoW := ioutil.Discard
  125. logLevel := os.Getenv("GRPC_GO_LOG_SEVERITY_LEVEL")
  126. switch logLevel {
  127. case "", "ERROR", "error": // If env is unset, set level to ERROR.
  128. errorW = os.Stderr
  129. case "WARNING", "warning":
  130. warningW = os.Stderr
  131. case "INFO", "info":
  132. infoW = os.Stderr
  133. }
  134. var v int
  135. vLevel := os.Getenv("GRPC_GO_LOG_VERBOSITY_LEVEL")
  136. if vl, err := strconv.Atoi(vLevel); err == nil {
  137. v = vl
  138. }
  139. return NewLoggerV2WithVerbosity(infoW, warningW, errorW, v)
  140. }
  141. func (g *loggerT) Info(args ...interface{}) {
  142. g.m[infoLog].Print(args...)
  143. }
  144. func (g *loggerT) Infoln(args ...interface{}) {
  145. g.m[infoLog].Println(args...)
  146. }
  147. func (g *loggerT) Infof(format string, args ...interface{}) {
  148. g.m[infoLog].Printf(format, args...)
  149. }
  150. func (g *loggerT) Warning(args ...interface{}) {
  151. g.m[warningLog].Print(args...)
  152. }
  153. func (g *loggerT) Warningln(args ...interface{}) {
  154. g.m[warningLog].Println(args...)
  155. }
  156. func (g *loggerT) Warningf(format string, args ...interface{}) {
  157. g.m[warningLog].Printf(format, args...)
  158. }
  159. func (g *loggerT) Error(args ...interface{}) {
  160. g.m[errorLog].Print(args...)
  161. }
  162. func (g *loggerT) Errorln(args ...interface{}) {
  163. g.m[errorLog].Println(args...)
  164. }
  165. func (g *loggerT) Errorf(format string, args ...interface{}) {
  166. g.m[errorLog].Printf(format, args...)
  167. }
  168. func (g *loggerT) Fatal(args ...interface{}) {
  169. g.m[fatalLog].Fatal(args...)
  170. }
  171. func (g *loggerT) Fatalln(args ...interface{}) {
  172. g.m[fatalLog].Fatalln(args...)
  173. }
  174. func (g *loggerT) Fatalf(format string, args ...interface{}) {
  175. g.m[fatalLog].Fatalf(format, args...)
  176. }
  177. func (g *loggerT) V(l int) bool {
  178. return l <= g.v
  179. }