blob: f6e0dc1da8d21716738ad6fe3bab5a30e8bae0a7 [file] [log] [blame]
Scott Baker105df152020-04-13 15:55:14 -07001/*
2 *
3 * Copyright 2020 gRPC authors.
4 *
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
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
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.
16 *
17 */
18
19package grpclog
20
21// PrefixLogger does logging with a prefix.
22//
23// Logging method on a nil logs without any prefix.
24type PrefixLogger struct {
25 prefix string
26}
27
28// Infof does info logging.
29func (pl *PrefixLogger) Infof(format string, args ...interface{}) {
30 if pl != nil {
31 // Handle nil, so the tests can pass in a nil logger.
32 format = pl.prefix + format
33 }
34 Logger.Infof(format, args...)
35}
36
37// Warningf does warning logging.
38func (pl *PrefixLogger) Warningf(format string, args ...interface{}) {
39 if pl != nil {
40 format = pl.prefix + format
41 }
42 Logger.Warningf(format, args...)
43}
44
45// Errorf does error logging.
46func (pl *PrefixLogger) Errorf(format string, args ...interface{}) {
47 if pl != nil {
48 format = pl.prefix + format
49 }
50 Logger.Errorf(format, args...)
51}
52
53// Debugf does info logging at verbose level 2.
54func (pl *PrefixLogger) Debugf(format string, args ...interface{}) {
55 if Logger.V(2) {
56 pl.Infof(format, args...)
57 }
58}
59
60// NewPrefixLogger creates a prefix logger with the given prefix.
61func NewPrefixLogger(prefix string) *PrefixLogger {
62 return &PrefixLogger{prefix: prefix}
63}