File: logger.go

package info (click to toggle)
golang-github-scaleway-scaleway-sdk-go 1.0.0~beta32-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,444 kB
  • sloc: sh: 70; makefile: 3
file content (52 lines) | stat: -rw-r--r-- 1,652 bytes parent folder | download | duplicates (2)
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
package logger

import "os"

type LogLevel int

const DebugEnv = "SCW_DEBUG"

const (
	// LogLevelDebug indicates Debug severity.
	LogLevelDebug LogLevel = iota
	// LogLevelInfo indicates Info severity.
	LogLevelInfo
	// LogLevelWarning indicates Warning severity.
	LogLevelWarning
	// LogLevelError indicates Error severity.
	LogLevelError
)

// severityName contains the string representation of each severity.
var severityName = []string{
	LogLevelDebug:   "DEBUG",
	LogLevelInfo:    "INFO",
	LogLevelWarning: "WARNING",
	LogLevelError:   "ERROR",
}

// Logger does underlying logging work for scaleway-sdk-go.
type Logger interface {
	// Debugf logs to DEBUG log. Arguments are handled in the manner of fmt.Printf.
	Debugf(format string, args ...interface{})
	// Infof logs to INFO log. Arguments are handled in the manner of fmt.Printf.
	Infof(format string, args ...interface{})
	// Warningf logs to WARNING log. Arguments are handled in the manner of fmt.Printf.
	Warningf(format string, args ...interface{})
	// Errorf logs to ERROR log. Arguments are handled in the manner of fmt.Printf.
	Errorf(format string, args ...interface{})
	// ShouldLog reports whether verbosity level l is at least the requested verbose level.
	ShouldLog(level LogLevel) bool
}

// SetLogger sets logger that is used in by the SDK.
// Not mutex-protected, should be called before any scaleway-sdk-go functions.
func SetLogger(l Logger) {
	logger = l
}

// EnableDebugMode enable LogLevelDebug on the default logger.
// If a custom logger was provided with SetLogger this method has no effect.
func EnableDebugMode() {
	DefaultLogger.Init(os.Stderr, LogLevelDebug)
}