Files
tasks/common/log/throttle_logger.go
zeekay 5a601d081b rebrand: go.temporal.io/server -> github.com/hanzoai/tasks
Full module path rebrand from Temporal to Hanzo Tasks:
- go.mod module: github.com/hanzoai/tasks
- All internal Go imports updated (1906 files)
- cmd/server renamed to cmd/tasksd
- Binary name: tasksd (was temporal-server)
- Docker images: hanzoai/tasks (was temporalio/server)
- README rewritten with Hanzo Tasks branding
- LLM.md created with integration notes
- Makefile, goreleaser, CI workflows updated
- go.temporal.io/sdk and go.temporal.io/api imports preserved (separate repos)

Fork of Temporal.io (MIT license).
2026-03-19 10:36:40 -07:00

102 lines
2.7 KiB
Go

package log
import (
"github.com/hanzoai/tasks/common/log/tag"
"github.com/hanzoai/tasks/common/quotas"
)
// extraSkipForThrottleLogger is the number of extra stack trace frames to skip when SkipLogger is used
const extraSkipForThrottleLogger = 3
type throttledLogger struct {
limiter quotas.RateLimiter
logger Logger
}
var _ Logger = (*throttledLogger)(nil)
// NewThrottledLogger returns an implementation of logger that throttles the
// log messages being emitted. The underlying implementation uses a token bucket
// rate limiter and stops emitting logs once the bucket runs out of tokens
//
// Fatal/Panic/DPanic logs are always emitted without any throttling
func NewThrottledLogger(logger Logger, rps quotas.RateFn) *throttledLogger {
if sl, ok := logger.(SkipLogger); ok {
logger = sl.Skip(extraSkipForThrottleLogger)
}
limiter := quotas.NewDefaultOutgoingRateLimiter(rps)
tl := &throttledLogger{
limiter: limiter,
logger: logger,
}
return tl
}
func (tl *throttledLogger) Debug(msg string, tags ...tag.Tag) {
tl.rateLimit(func() {
tl.logger.Debug(msg, tags...)
})
}
func (tl *throttledLogger) Info(msg string, tags ...tag.Tag) {
tl.rateLimit(func() {
tl.logger.Info(msg, tags...)
})
}
func (tl *throttledLogger) Warn(msg string, tags ...tag.Tag) {
tl.rateLimit(func() {
tl.logger.Warn(msg, tags...)
})
}
func (tl *throttledLogger) Error(msg string, tags ...tag.Tag) {
tl.rateLimit(func() {
tl.logger.Error(msg, tags...)
})
}
func (tl *throttledLogger) DPanic(msg string, tags ...tag.Tag) {
// DPanic logs are always emitted without any throttling. Call bypassRateLimit
// to maintain the same number of stack trace frames (see extraSkipForThrottleLogger)
tl.bypassRateLimit(func() {
tl.logger.DPanic(msg, tags...)
})
}
func (tl *throttledLogger) Panic(msg string, tags ...tag.Tag) {
// Panic logs are always emitted without any throttling
tl.bypassRateLimit(func() {
tl.logger.Panic(msg, tags...)
})
}
func (tl *throttledLogger) Fatal(msg string, tags ...tag.Tag) {
// Fatal logs are always emitted without any throttling
tl.bypassRateLimit(func() {
tl.logger.Fatal(msg, tags...)
})
}
// Return a logger with the specified key-value pairs set, to be included in a subsequent normal logging call
func (tl *throttledLogger) With(tags ...tag.Tag) Logger {
result := &throttledLogger{
limiter: tl.limiter,
logger: With(tl.logger, tags...),
}
return result
}
func (tl *throttledLogger) rateLimit(f func()) {
if tl.limiter.Allow() {
f()
}
}
// bypassRateLimit bypasses the rate limit and calls the function directly. It exists to maintain the same
// number of stack trace frames as when rateLimit is called (see extraSkipForThrottleLogger)
func (tl *throttledLogger) bypassRateLimit(f func()) {
f()
}