forked from vmware/vic
/
trace.go
152 lines (129 loc) · 3.72 KB
/
trace.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
// Copyright 2016-2017 VMware, 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 trace
import (
"context"
"fmt"
"os"
"runtime"
"strings"
"time"
"github.com/Sirupsen/logrus"
"github.com/vmware/govmomi/vim25/types"
"github.com/vmware/vic/pkg/log"
)
var tracingEnabled = true
// Enable global tracing.
func EnableTracing() {
tracingEnabled = true
}
// Disable global tracing.
func DisableTracing() {
tracingEnabled = false
}
var Logger = &logrus.Logger{
Out: os.Stderr,
// We're using our own text formatter to skip the \n and \t escaping logrus
// was doing on non TTY Out (we redirect to a file) descriptors.
Formatter: log.NewTextFormatter(),
Hooks: make(logrus.LevelHooks),
Level: logrus.InfoLevel,
}
// trace object used to grab run-time state
type Message struct {
msg string
funcName string
lineNo int
operationID string
startTime time.Time
}
func (t *Message) delta() time.Duration {
if t == nil {
return 0
}
return time.Now().Sub(t.startTime)
}
// Add Syslog hook
// This method is not thread safe, this is currently
// not a problem because it is only called once from main
func InitLogger(cfg *log.LoggingConfig) error {
hook, err := log.CreateSyslogHook(cfg)
if err == nil && hook != nil {
Logger.Hooks.Add(hook)
}
return err
}
// begin a trace from this stack frame less the skip.
func newTrace(msg string, skip int, opID string) *Message {
pc, _, line, ok := runtime.Caller(skip)
if !ok {
return nil
}
// lets only return the func name from the repo (vic)
// down - i.e. vic/lib/etc vs. github.com/vmware/vic/lib/etc
// if github.com/vmware doesn't match then the original is returned
name := strings.TrimPrefix(runtime.FuncForPC(pc).Name(), "github.com/vmware/")
message := Message{
msg: msg,
funcName: name,
lineNo: line,
startTime: time.Now(),
}
// if we have an operationID then format the output
if opID != "" {
message.operationID = fmt.Sprintf("op=%s", opID)
}
return &message
}
// Begin starts the trace. Msg is the msg to log.
// context provided to allow tracing of operationID
// context added as optional to avoid breaking current usage
func begin(msg string, ctx ...context.Context) *Message {
if tracingEnabled && Logger.Level >= logrus.DebugLevel {
var opID string
// populate operationID if provided
if len(ctx) == 1 {
if id, ok := ctx[0].Value(types.ID{}).(string); ok {
opID = id
}
}
if t := newTrace(msg, 3, opID); t != nil {
if msg == "" {
Logger.Debugf("[BEGIN] %s [%s:%d]", t.operationID, t.funcName, t.lineNo)
} else {
Logger.Debugf("[BEGIN] %s [%s:%d] %s", t.operationID, t.funcName, t.lineNo, t.msg)
}
return t
}
}
return nil
}
func Begin(msg string, ctx ...context.Context) *Message {
return begin(msg, ctx...)
}
// Audit is a wrapper around Begin which logs an Audit message after
func Audit(msg string, op Operation) *Message {
m := begin(msg, op)
if len(op.t) > 0 { // We expect an operation to always have at least one frame, but check for safety
op.Auditf(op.t[0].msg)
}
return m
}
// End ends the trace.
func End(t *Message) {
if t == nil {
return
}
Logger.Debugf("[ END ] %s [%s:%d] [%s] %s", t.operationID, t.funcName, t.lineNo, t.delta(), t.msg)
}