Files
tasks/common/log/interface.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

52 lines
1.6 KiB
Go

//go:generate mockgen -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
)