1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
// Copyright 2019 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package logger logs messages as appropriate.
package logger
import (
"context"
"fmt"
"io"
"os"
"time"
"cloud.google.com/go/compute/metadata"
"cloud.google.com/go/logging"
"google.golang.org/api/option"
)
var (
// DeferredFatalFuncs is a slice of functions that will be called prior to os.Exit in Fatal.
DeferredFatalFuncs []func()
cloudLoggingClient *logging.Client
cloudLogger *logging.Logger
debugEnabled bool
loggerName string
formatFunction func(LogEntry) string
writers []io.Writer
)
// LogOpts represents options for logging.
type LogOpts struct {
Debug bool
ProjectName string
LoggerName string
DisableLocalLogging bool
DisableCloudLogging bool
// FormatFunction will produce the string representation of each log event.
FormatFunction func(LogEntry) string
// Additional writers that will be used during logging.
Writers []io.Writer
UserAgent string
}
// SetDebugLogging enables or disables debug level logging.
func SetDebugLogging(enabled bool) {
debugEnabled = enabled
}
// Init instantiates the logger.
func Init(ctx context.Context, opts LogOpts) error {
if opts.LoggerName == "" {
return fmt.Errorf("logger name must be set")
}
loggerName = opts.LoggerName
debugEnabled = opts.Debug
formatFunction = opts.FormatFunction
writers = opts.Writers
if !opts.DisableLocalLogging {
if err := localSetup(loggerName); err != nil {
return fmt.Errorf("logger Init localSetup error: %v", err)
}
}
if !opts.DisableCloudLogging && opts.ProjectName != "" {
var err error
cOpts := []option.ClientOption{}
if opts.UserAgent != "" {
cOpts = append(cOpts, option.WithUserAgent(opts.UserAgent))
}
cloudLoggingClient, err = logging.NewClient(ctx, opts.ProjectName, cOpts...)
if err != nil {
Errorf("Continuing without cloud logging due to error in initialization: %v", err.Error())
// Log but don't return this error, as it doesn't prevent continuing.
return nil
}
// Override default error handler. Must be a func and not nil.
cloudLoggingClient.OnError = func(e error) { return }
// The logger automatically detects and associates with a GCE
// resource. However instance_name is not included in this
// resource, so add an instance_name label to all log Entries.
name, err := metadata.InstanceName()
if err == nil {
cloudLogger = cloudLoggingClient.Logger(loggerName, logging.CommonLabels(map[string]string{"instance_name": name}))
} else {
cloudLogger = cloudLoggingClient.Logger(loggerName)
}
go func() {
for {
time.Sleep(5 * time.Second)
cloudLogger.Flush()
}
}()
}
return nil
}
// Close closes the logger.
func Close() {
if cloudLoggingClient != nil {
cloudLoggingClient.Close()
}
localClose()
}
// Log writes an entry to all outputs.
func Log(e LogEntry) {
if e.Severity == Debug && !debugEnabled {
return
}
if e.CallDepth == 0 {
e.CallDepth = 2
}
e.LocalTimestamp = now()
e.Source = caller(e.CallDepth)
local(e)
for _, w := range writers {
w.Write(e.bytes())
}
var cloudSev logging.Severity
if cloudLogger != nil {
var payload interface{}
if e.StructuredPayload != nil {
payload = e.StructuredPayload
} else {
payload = e
}
switch e.Severity {
case Debug:
cloudSev = logging.Debug
case Info:
cloudSev = logging.Info
case Warning:
cloudSev = logging.Warning
case Error:
cloudSev = logging.Error
case Critical:
cloudSev = logging.Critical
default:
cloudSev = logging.Default
}
cloudLogger.Log(logging.Entry{Severity: cloudSev, SourceLocation: e.Source, Payload: payload, Labels: e.Labels})
}
}
// Debugf logs debug information.
func Debugf(format string, v ...interface{}) {
Log(LogEntry{Message: fmt.Sprintf(format, v...), Severity: Debug})
}
// Infof logs general information.
func Infof(format string, v ...interface{}) {
Log(LogEntry{Message: fmt.Sprintf(format, v...), Severity: Info})
}
// Warningf logs warning information.
func Warningf(format string, v ...interface{}) {
Log(LogEntry{Message: fmt.Sprintf(format, v...), Severity: Warning})
}
// Errorf logs error information.
func Errorf(format string, v ...interface{}) {
Log(LogEntry{Message: fmt.Sprintf(format, v...), Severity: Error})
}
// Fatalf logs critical error information and exits.
func Fatalf(format string, v ...interface{}) {
Log(LogEntry{Message: fmt.Sprintf(format, v...), Severity: Critical})
for _, f := range DeferredFatalFuncs {
f()
}
Close()
os.Exit(1)
}
|