/
instrument.go
66 lines (56 loc) · 1.59 KB
/
instrument.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
// Copyright 2020 Buf Technologies, Inc.
//
// 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 instrument implements instrumentation.
package instrument
import (
"time"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// Timer logs a duration to a logger.
type Timer interface {
End(...zap.Field)
}
// Start returns a new Timer.
func Start(logger *zap.Logger, message string, fields ...zap.Field) Timer {
if checkedEntry := logger.Check(zap.DebugLevel, message); checkedEntry != nil {
return newTimer(checkedEntry, fields...)
}
return nopTimer{}
}
type timer struct {
checkedEntry *zapcore.CheckedEntry
fields []zap.Field
start time.Time
}
func newTimer(checkedEntry *zapcore.CheckedEntry, fields ...zap.Field) *timer {
return &timer{
checkedEntry: checkedEntry,
fields: fields,
start: time.Now(),
}
}
func (t *timer) End(extraFields ...zap.Field) {
t.checkedEntry.Write(
append(
t.fields,
append(
extraFields,
zap.Duration("duration", time.Since(t.start)),
)...,
)...,
)
}
type nopTimer struct{}
func (nopTimer) End(...zap.Field) {}