-
Notifications
You must be signed in to change notification settings - Fork 10
/
instrumentation.go
118 lines (104 loc) · 3.07 KB
/
instrumentation.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
// © 2023 Snyk Limited 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 engine
import (
"context"
"fmt"
"time"
"github.com/snyk/policy-engine/pkg/logging"
"github.com/snyk/policy-engine/pkg/metrics"
)
type level int
const (
info = iota
debug
trace
)
type instrumentation struct {
component string
labels metrics.Labels
logger logging.Logger
metrics metrics.Metrics
phaseStartTimes map[string]time.Time
level level
}
type instrumentationOptions struct {
component string
labels metrics.Labels
logger logging.Logger
metrics metrics.Metrics
level level
}
func newInstrumentation(options instrumentationOptions) instrumentation {
return instrumentation{
component: options.component,
labels: metrics.MergeLabels(options.labels, metrics.Labels{
"component": options.component,
}),
logger: options.logger.WithField("component", options.component),
metrics: options.metrics,
phaseStartTimes: map[string]time.Time{},
level: options.level,
}
}
type loggerOption func(l logging.Logger) logging.Logger
func withField(name string, val interface{}) loggerOption {
return func(l logging.Logger) logging.Logger {
return l.WithField(name, val)
}
}
func (i *instrumentation) startPhase(ctx context.Context, phase string, opts ...loggerOption) {
logger := i.logger.WithField("phase", phase)
for _, opt := range opts {
logger = opt(logger)
}
i.phaseStartTimes[phase] = time.Now()
i.logFromLevel(ctx, logger, "phase started")
}
func (i *instrumentation) finishPhase(ctx context.Context, phase string, opts ...loggerOption) {
duration := time.Since(i.phaseStartTimes[phase])
logger := i.logger.
WithField("phase", phase).
WithField("duration_ms", duration.Milliseconds())
for _, opt := range opts {
logger = opt(logger)
}
i.logFromLevel(ctx, logger, "phase finished")
i.metrics.
Timer(ctx, fmt.Sprintf("%s_time", phase), "", i.labels).
Record(duration)
}
func (i *instrumentation) child(labels metrics.Labels, level level, opts ...loggerOption) instrumentation {
logger := i.logger
for _, opt := range opts {
logger = opt(logger)
}
return newInstrumentation(instrumentationOptions{
component: i.component,
metrics: i.metrics,
labels: metrics.MergeLabels(i.labels, labels),
logger: logger,
level: level,
})
}
func (i *instrumentation) logFromLevel(ctx context.Context, logger logging.Logger, msg string) {
switch i.level {
case info:
logger.Info(ctx, msg)
case debug:
logger.Debug(ctx, msg)
case trace:
logger.Trace(ctx, msg)
}
}