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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
|
/*
* Copyright (C) 2014 ~ 2018 Deepin Technology Co., Ltd.
*
* Author: jouyouyun <jouyouwen717@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package log
import (
"encoding/json"
"fmt"
"io/ioutil"
golog "log"
"os"
"path/filepath"
"reflect"
"regexp"
"runtime"
"sync"
"github.com/linuxdeepin/go-lib/utils"
)
const (
defaultDebugEnv = "DDE_DEBUG"
defaultDebugLelveEnv = "DDE_DEBUG_LEVEL"
defaultDebugMatchEnv = "DDE_DEBUG_MATCH"
defaultDebugFile = "/var/cache/dde_debug"
crashReporterExe = "/usr/bin/deepin-crash-reporter" // TODO
)
// Priority is the data type of log level.
type Priority int
// Definitions of log level, the larger of the value, the higher of
// the priority.
const (
LevelDisable Priority = iota
LevelFatal
LevelPanic
LevelError
LevelWarning
LevelInfo
LevelDebug
)
var (
// DebugEnv is the name of environment variable that used to
// enable debug mode , if exists the default log level will be
// "LevelDebug".
DebugEnv = defaultDebugEnv
// DebugLevelEnv is the name of environment variable that used to
// control the log level, could be "debug", "info", "warning",
// "error", "fatal" and "disable".
DebugLevelEnv = defaultDebugLelveEnv
// DebugMatchEnv is the name of environment variable that used to
// enable debug mode for target logger object.
DebugMatchEnv = defaultDebugMatchEnv
// DebugFile if the file name that if exist the default log level
// will be "LevelDebug".
DebugFile = defaultDebugFile
)
var (
errUnknownLogLevel = fmt.Errorf("unknown log level")
std = golog.New(os.Stderr, "", golog.Lshortfile)
)
// Backend defines interface of logger's back-ends.
type Backend interface {
log(level Priority, msg string) error
close() error
}
// Logger is a wrapper object to access Logger dbus service.
type Logger struct {
name string
level Priority
backends []Backend
backendsLock sync.Mutex
config *restartConfig
}
// NewLogger create a Logger object, which need a string as name to
// register Logger dbus service, if the environment variable exists
// which name stores in variable "DebugEnv", the default log level
// will be "LevelDebug" or is "LevelInfo".
func NewLogger(name string) (l *Logger) {
// ignore panic
defer func() {
if err := recover(); err != nil {
std.Println("<info> dbus unavailable,", err)
}
}()
l = &Logger{name: name}
l.config = newRestartConfig(name)
l.level = getDefaultLogLevel(name)
l.AddBackendConsole()
l.AddBackendSyslog()
return
}
// parse environment variables to get default log level
func getDefaultLogLevel(name string) (level Priority) {
level = LevelInfo
if utils.IsEnvExists(DebugLevelEnv) {
switch os.Getenv(DebugLevelEnv) {
case "debug":
level = LevelDebug
case "info":
level = LevelInfo
case "warning":
level = LevelWarning
case "error":
level = LevelError
case "fatal":
level = LevelFatal
case "disable":
level = LevelDisable
}
}
if utils.IsEnvExists(DebugEnv) || utils.IsFileExist(DebugFile) {
if !utils.IsEnvExists(DebugLevelEnv) {
level = LevelDebug
}
}
if utils.IsEnvExists(DebugMatchEnv) {
if matchLogger(name, os.Getenv(DebugMatchEnv)) {
if !utils.IsEnvExists(DebugLevelEnv) {
level = LevelDebug
}
} else {
level = LevelDisable
}
}
return
}
func matchLogger(name, expr string) bool {
reg, err := regexp.Compile(expr)
if err != nil {
std.Printf("match variable $%s failed %v\n", DebugMatchEnv, err)
return false
}
return reg.Match([]byte(name))
}
// SetLogLevel reset the log level.
func (l *Logger) SetLogLevel(level Priority) *Logger {
l.level = level
return l
}
// GetLogLevel return the log level.
func (l *Logger) GetLogLevel() Priority {
return l.level
}
// ResetBackends clear all backends.
func (l *Logger) ResetBackends() {
for _, b := range l.backends {
_ = b.close()
}
l.backends = nil
}
// AddBackend append a log back-end.
func (l *Logger) AddBackend(b Backend) bool {
l.backendsLock.Lock()
defer l.backendsLock.Unlock()
if utils.IsInterfaceNil(b) {
return false
}
l.backends = append(l.backends, b)
return true
}
// RemoveBackend remove all back-end with target type.
func (l *Logger) RemoveBackend(b Backend) {
len := len(l.backends)
targetType := reflect.TypeOf(b)
for i := len - 1; i >= 0; i-- {
itemType := reflect.TypeOf(l.backends[i])
if itemType == targetType {
l.doRemoveBackend(i)
}
}
}
func (l *Logger) doRemoveBackend(i int) {
l.backendsLock.Lock()
defer l.backendsLock.Unlock()
_ = l.backends[i].close()
l.backends[i] = nil
newLen := len(l.backends) - 1
copy(l.backends[i:], l.backends[i+1:])
l.backends[newLen] = nil
l.backends = l.backends[:newLen]
}
// AddBackendConsole append a console back-end.
func (l *Logger) AddBackendConsole() bool {
return l.AddBackend(newBackendConsole(l.name))
}
// RemoveBackendConsole remove all console back-end.
func (l *Logger) RemoveBackendConsole() {
l.RemoveBackend(&backendConsole{})
}
// AddBackendSyslog append a syslog back-end.
func (l *Logger) AddBackendSyslog() bool {
return l.AddBackend(newBackendSyslog(l.name))
}
// RemoveBackendSyslog remove all console back-end.
func (l *Logger) RemoveBackendSyslog() {
l.RemoveBackend(&backendSyslog{})
}
// SetRestartCommand reset the command and argument when restart after fatal.
func (l *Logger) SetRestartCommand(exefile string, args ...string) {
l.config.RestartCommand = append([]string{exefile}, args...)
}
// AddExtArgForRestart add the command option which be used when
// process fataled and restart by Logger dbus service.
func (l *Logger) AddExtArgForRestart(arg string) {
if !isStringInArray(arg, l.config.RestartCommand[1:]) {
l.config.RestartCommand = append(l.config.RestartCommand, arg)
}
}
// BeginTracing log function information when entering it.
func (l *Logger) BeginTracing() {
// TODO
// funcName, file, line, ok := getCallerFuncInfo(2)
// if !ok {
// return
// }
// msg := fmt.Sprintf("%s:%d %s begin", filepath.Base(file), line, funcName)
// l.doLog(LevelInfo, msg)
}
// EndTracing log function information when leaving it.
func (l *Logger) EndTracing() {
// TODO
// funcName, file, line, ok := getCallerFuncInfo(2)
// if !ok {
// return
// }
// msg := fmt.Sprintf("%s:%d %s end", filepath.Base(file), line, funcName)
// l.doLog(LevelInfo, msg)
}
func (l *Logger) isNeedLog(level Priority) bool {
return level <= l.level
}
func (l *Logger) isNeedTraceMore(level Priority) bool {
return level <= LevelError
}
func (l *Logger) log(level Priority, v ...interface{}) {
if !l.isNeedLog(level) {
return
}
s := buildMsg(3, l.isNeedTraceMore(level), v...)
l.doLog(level, s)
}
func (l *Logger) logf(level Priority, format string, v ...interface{}) {
if !l.isNeedLog(level) {
return
}
s := buildFormatMsg(3, l.isNeedTraceMore(level), format, v...)
l.doLog(level, s)
}
func (l *Logger) doLog(level Priority, msg string) {
for _, b := range l.backends {
_ = b.log(level, msg)
}
}
func buildMsg(calldepth int, loop bool, v ...interface{}) (msg string) {
s := fmtSprint(v...)
msg = doBuildMsg(calldepth+1, loop, s)
return
}
func buildFormatMsg(calldepth int, loop bool, format string, v ...interface{}) (msg string) {
s := fmt.Sprintf(format, v...)
msg = doBuildMsg(calldepth+1, loop, s)
return
}
func doBuildMsg(calldepth int, loop bool, s string) (msg string) {
var file, lastFile string
var line, lastLine int
var ok bool
_, file, line, ok = runtime.Caller(calldepth)
lastFile, lastLine = file, line
msg = fmt.Sprintf("%s:%d: %s", filepath.Base(file), line, s)
if loop && ok {
for {
calldepth++
_, file, line, ok = runtime.Caller(calldepth)
if file == lastFile && line == lastLine {
// prevent infinite loop for that some platforms not
// works well, e.g. mips
break
}
if ok {
msg = fmt.Sprintf("%s\n -> %s:%d", msg, filepath.Base(file), line)
}
lastFile, lastLine = file, line
}
}
return
}
// Debug log a message in "debug" level.
func (l *Logger) Debug(v ...interface{}) {
l.log(LevelDebug, v...)
}
// Debugf formats message according to a format specifier and log it in "debug" level.
func (l *Logger) Debugf(format string, v ...interface{}) {
l.logf(LevelDebug, format, v...)
}
// Info log a message in "info" level.
func (l *Logger) Info(v ...interface{}) {
l.log(LevelInfo, v...)
}
// Infof formats message according to a format specifier and log it in "info" level.
func (l *Logger) Infof(format string, v ...interface{}) {
l.logf(LevelInfo, format, v...)
}
// Warning log a message in "warning" level.
func (l *Logger) Warning(v ...interface{}) {
l.log(LevelWarning, v...)
}
// Warningf formats message according to a format specifier and log it in "warning" level.
func (l *Logger) Warningf(format string, v ...interface{}) {
l.logf(LevelWarning, format, v...)
}
// Error log a message in "error" level.
func (l *Logger) Error(v ...interface{}) {
l.log(LevelError, v...)
}
// Errorf formats message according to a format specifier and log it in "error" level.
func (l *Logger) Errorf(format string, v ...interface{}) {
l.logf(LevelError, format, v...)
}
// Panic is equivalent to Error() followed by a call to panic().
func (l *Logger) Panic(v ...interface{}) {
l.log(LevelPanic, v...)
s := fmtSprint(v...)
panic(s)
}
// Panicf is equivalent to Errorf() followed by a call to panic().
func (l *Logger) Panicf(format string, v ...interface{}) {
l.logf(LevelPanic, format, v...)
s := fmt.Sprintf(format, v...)
panic(s)
}
// Fatal is equivalent to Error() followed by a call to os.Exit(1).
func (l *Logger) Fatal(v ...interface{}) {
l.log(LevelFatal, v...)
l.launchCrashReporter()
os.Exit(1)
}
// Fatalf is equivalent to Errorf() followed by a call to os.Exit(1).
func (l *Logger) Fatalf(format string, v ...interface{}) {
l.logf(LevelFatal, format, v...)
l.launchCrashReporter()
os.Exit(1)
}
func (l *Logger) launchCrashReporter() {
// if deepin-crash-reporter exists, launch it
if utils.IsFileExist(crashReporterExe) {
// save config to a temporary json file
l.config.LogDetail = "not ready" // TODO use lib/logquery to get log messages.
fileContent, err := json.Marshal(l.config)
if err != nil {
l.Error(err)
}
// create temporary json file and it will be removed by deepin-crash-reporter
f, err := ioutil.TempFile("", "deepin_crash_reporter_config_")
defer func() {
_ = f.Close()
}()
if err != nil {
l.Error(err)
}
_, err = f.Write(fileContent)
if err != nil {
l.Error(err)
}
// launch crash reporter
l.Infof("launch deepin-crash-reporter: %s %v", crashReporterExe, append(crashReporterArgs, f.Name()))
_, err = os.StartProcess(crashReporterExe, append(crashReporterArgs, f.Name()),
&os.ProcAttr{Files: []*os.File{os.Stdin, os.Stdout, os.Stderr}})
if err != nil {
l.Error("launch deepin-crash-reporter failed:", err)
}
}
}
|