/
interface.go
75 lines (68 loc) · 2.85 KB
/
interface.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
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination interface_mock.go
package log
import (
"go.temporal.io/server/common/log/tag"
)
type (
// Logger is the logging interface.
// Usage example:
// logger.Info("hello world",
// tag.WorkflowNextEventID(123),
// tag.WorkflowActionWorkflowStarted,
// tag.WorkflowNamespaceID("test-namespace-id")),
// )
// Note: msg should be static, do not use fmt.Sprintf() for msg. Anything dynamic should be tagged.
Logger interface {
Debug(msg string, tags ...tag.Tag)
Info(msg string, tags ...tag.Tag)
Warn(msg string, tags ...tag.Tag)
Error(msg string, tags ...tag.Tag)
DPanic(msg string, tags ...tag.Tag)
Panic(msg string, tags ...tag.Tag)
Fatal(msg string, tags ...tag.Tag)
}
// Implement WithLogger interface with With method which should return new instance of logger with prepended tags.
// If WithLogger is not implemented on logger, internal (not very efficient) preppender is used.
// Create prepended logger example:
// logger = log.With(
// logger,
// tag.WorkflowNextEventID(123),
// tag.WorkflowActionWorkflowStarted,
// tag.WorkflowNamespaceID("test-namespace-id"))
// ...
// logger.Info("hello world")
WithLogger interface {
With(tags ...tag.Tag) Logger
}
// If logger implements SkipLogger then Skip method will be called and extraSkip parameter will have
// number of extra stack trace frames to skip (useful to log caller func file/line).
SkipLogger interface {
Skip(extraSkip int) Logger
}
// Special logger types for use with fx
SnTaggedLogger Logger
ThrottledLogger Logger
)