/
log_utils.go
158 lines (131 loc) · 3.69 KB
/
log_utils.go
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
package utils
import (
"bytes"
"context"
"fmt"
"html/template"
"io/ioutil"
"os"
"sync"
"github.com/sirupsen/logrus"
"github.com/spf13/viper"
)
var fileRegister []*os.File
var fileRegisterSignal *sync.Mutex
func init() {
fileRegisterSignal = &sync.Mutex{}
fileRegister = make([]*os.File, 0)
}
// LogDefinition is used to define where a logger should log to
type LogDefinition struct {
Level string `yaml:"level" json:"level"`
Type string `yaml:"type" json:"type"`
Format string `yaml:"format" json:"format"`
Destination string `yaml:"destination" json:"destination"`
}
// LoggingContext is a structure that holds workflow and step
// and is used to determine log configuration
type LoggingContext struct {
Workflow *Workflow
Step *Step
}
func addFile(file *os.File) {
fileRegisterSignal.Lock()
defer fileRegisterSignal.Unlock()
fileRegister = append(fileRegister, file)
}
// CloseAllFiles closes all files in fileRegister
func CloseAllFiles() {
fileRegisterSignal.Lock()
defer fileRegisterSignal.Unlock()
for _, file := range fileRegister {
file.Close()
}
}
// NewLoggingContext creates a new logging context. Da
func NewLoggingContext(workflow *Workflow, step *Step) *LoggingContext {
return &LoggingContext{
Workflow: workflow,
Step: step,
}
}
// Parse parses the given value within this context.
func (l *LoggingContext) parse(value string) (string, error) {
temp, err := template.New("filename").Parse(value)
if err != nil {
return "", err
}
var tpl bytes.Buffer
err = temp.Execute(&tpl, l)
if err != nil {
return "", err
}
return tpl.String(), nil
}
// DefaultLogDefinition returns a LogDefintion based on the given base
// if the base is nil it creates a new one
// if not nil, it fills the empty values with the defaults
func DefaultLogDefinition(baseDefinition *LogDefinition) *LogDefinition {
var definition *LogDefinition
if baseDefinition == nil {
definition = &LogDefinition{}
} else {
definition = baseDefinition
}
if definition.Type == "" {
definition.Type = viper.GetString("log-type")
}
if definition.Destination == "" {
definition.Destination = viper.GetString("log-file")
}
if definition.Format == "" {
definition.Format = viper.GetString("log-format")
}
if definition.Level == "" {
definition.Level = viper.GetString("log-level")
}
return definition
}
// NewLogger creates a new logger instance and sets the right log level based
func NewLogger(baseDefinition *LogDefinition, loggingContext *LoggingContext) (*logrus.Logger, error) {
ctx := context.Background()
definition := DefaultLogDefinition(baseDefinition)
logger := logrus.New()
if definition.Type == "stdout" {
logger.SetOutput(os.Stdout)
} else if definition.Type == "stderr" {
logger.SetOutput(os.Stderr)
} else if definition.Type == "discard" {
logger.SetOutput(ioutil.Discard)
} else if definition.Type == "file" {
var filename string
var err error
if filename, err = loggingContext.parse(definition.Destination); err != nil {
return nil, err
}
if filename, err = ExpandEnvVars(ctx, filename); err != nil {
return nil, err
}
file, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0755)
if err != nil {
return nil, err
}
addFile(file)
logger.SetOutput(file)
} else {
return nil, fmt.Errorf("invalid log type %s", definition.Type)
}
level, err := logrus.ParseLevel(definition.Level)
if err != nil {
return nil, err
}
logger.SetLevel(level)
if definition.Format == "text" {
logger.Formatter = &logrus.TextFormatter{}
} else if definition.Format == "json" {
logger.Formatter = &logrus.JSONFormatter{}
} else {
return nil, fmt.Errorf("invalid log format %s", definition.Format)
}
return logger, nil
}