3 * Copyright 2017 gRPC authors.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
29 // LoggerV2 does underlying logging work for grpclog.
30 type LoggerV2 interface {
31 // Info logs to INFO log. Arguments are handled in the manner of fmt.Print.
32 Info(args ...interface{})
33 // Infoln logs to INFO log. Arguments are handled in the manner of fmt.Println.
34 Infoln(args ...interface{})
35 // Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.
36 Infof(format string, args ...interface{})
37 // Warning logs to WARNING log. Arguments are handled in the manner of fmt.Print.
38 Warning(args ...interface{})
39 // Warningln logs to WARNING log. Arguments are handled in the manner of fmt.Println.
40 Warningln(args ...interface{})
41 // Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.
42 Warningf(format string, args ...interface{})
43 // Error logs to ERROR log. Arguments are handled in the manner of fmt.Print.
44 Error(args ...interface{})
45 // Errorln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
46 Errorln(args ...interface{})
47 // Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
48 Errorf(format string, args ...interface{})
49 // Fatal logs to ERROR log. Arguments are handled in the manner of fmt.Print.
50 // gRPC ensures that all Fatal logs will exit with os.Exit(1).
51 // Implementations may also call os.Exit() with a non-zero exit code.
52 Fatal(args ...interface{})
53 // Fatalln logs to ERROR log. Arguments are handled in the manner of fmt.Println.
54 // gRPC ensures that all Fatal logs will exit with os.Exit(1).
55 // Implementations may also call os.Exit() with a non-zero exit code.
56 Fatalln(args ...interface{})
57 // Fatalf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
58 // gRPC ensures that all Fatal logs will exit with os.Exit(1).
59 // Implementations may also call os.Exit() with a non-zero exit code.
60 Fatalf(format string, args ...interface{})
61 // V reports whether verbosity level l is at least the requested verbose level.
65 // SetLoggerV2 sets logger that is used in grpc to a V2 logger.
66 // Not mutex-protected, should be called before any gRPC functions.
67 func SetLoggerV2(l LoggerV2) {
72 // infoLog indicates Info severity.
74 // warningLog indicates Warning severity.
76 // errorLog indicates Error severity.
78 // fatalLog indicates Fatal severity.
82 // severityName contains the string representation of each severity.
83 var severityName = []string{
85 warningLog: "WARNING",
90 // loggerT is the default logger used by grpclog.
96 // NewLoggerV2 creates a loggerV2 with the provided writers.
97 // Fatal logs will be written to errorW, warningW, infoW, followed by exit(1).
98 // Error logs will be written to errorW, warningW and infoW.
99 // Warning logs will be written to warningW and infoW.
100 // Info logs will be written to infoW.
101 func NewLoggerV2(infoW, warningW, errorW io.Writer) LoggerV2 {
102 return NewLoggerV2WithVerbosity(infoW, warningW, errorW, 0)
105 // NewLoggerV2WithVerbosity creates a loggerV2 with the provided writers and
107 func NewLoggerV2WithVerbosity(infoW, warningW, errorW io.Writer, v int) LoggerV2 {
109 m = append(m, log.New(infoW, severityName[infoLog]+": ", log.LstdFlags))
110 m = append(m, log.New(io.MultiWriter(infoW, warningW), severityName[warningLog]+": ", log.LstdFlags))
111 ew := io.MultiWriter(infoW, warningW, errorW) // ew will be used for error and fatal.
112 m = append(m, log.New(ew, severityName[errorLog]+": ", log.LstdFlags))
113 m = append(m, log.New(ew, severityName[fatalLog]+": ", log.LstdFlags))
114 return &loggerT{m: m, v: v}
117 // newLoggerV2 creates a loggerV2 to be used as default logger.
118 // All logs are written to stderr.
119 func newLoggerV2() LoggerV2 {
120 errorW := ioutil.Discard
121 warningW := ioutil.Discard
122 infoW := ioutil.Discard
124 logLevel := os.Getenv("GRPC_GO_LOG_SEVERITY_LEVEL")
126 case "", "ERROR", "error": // If env is unset, set level to ERROR.
128 case "WARNING", "warning":
135 vLevel := os.Getenv("GRPC_GO_LOG_VERBOSITY_LEVEL")
136 if vl, err := strconv.Atoi(vLevel); err == nil {
139 return NewLoggerV2WithVerbosity(infoW, warningW, errorW, v)
142 func (g *loggerT) Info(args ...interface{}) {
143 g.m[infoLog].Print(args...)
146 func (g *loggerT) Infoln(args ...interface{}) {
147 g.m[infoLog].Println(args...)
150 func (g *loggerT) Infof(format string, args ...interface{}) {
151 g.m[infoLog].Printf(format, args...)
154 func (g *loggerT) Warning(args ...interface{}) {
155 g.m[warningLog].Print(args...)
158 func (g *loggerT) Warningln(args ...interface{}) {
159 g.m[warningLog].Println(args...)
162 func (g *loggerT) Warningf(format string, args ...interface{}) {
163 g.m[warningLog].Printf(format, args...)
166 func (g *loggerT) Error(args ...interface{}) {
167 g.m[errorLog].Print(args...)
170 func (g *loggerT) Errorln(args ...interface{}) {
171 g.m[errorLog].Println(args...)
174 func (g *loggerT) Errorf(format string, args ...interface{}) {
175 g.m[errorLog].Printf(format, args...)
178 func (g *loggerT) Fatal(args ...interface{}) {
179 g.m[fatalLog].Fatal(args...)
180 // No need to call os.Exit() again because log.Logger.Fatal() calls os.Exit().
183 func (g *loggerT) Fatalln(args ...interface{}) {
184 g.m[fatalLog].Fatalln(args...)
185 // No need to call os.Exit() again because log.Logger.Fatal() calls os.Exit().
188 func (g *loggerT) Fatalf(format string, args ...interface{}) {
189 g.m[fatalLog].Fatalf(format, args...)
190 // No need to call os.Exit() again because log.Logger.Fatal() calls os.Exit().
193 func (g *loggerT) V(l int) bool {