Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nsqconsumer): add a configurable log level #978

Merged
merged 4 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions nsqconsumer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## To be Released

* feat: add a configurable log level

## v1.2.0

* feat: Start unwraps errors to find noRetry field that can be wrapped in ErrCtx. Also use ErrCtx to enrich the logger
Expand Down
51 changes: 49 additions & 2 deletions nsqconsumer/consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,50 @@ var (
maxPostponeDelay int64 = 3600
)

// LogLevel is a wrapper around nsq.LogLevel to ensure that the default log level is set to Warning and not Debug
type LogLevel int

const (
// DefaultLogLevel is the default log level for NSQ when no log level is provided
DefaultLogLevel LogLevel = iota
LogLevelDebug
LogLevelInfo
LogLevelWarning
LogLevelError
)

func ParseLogLevel(logLevel string) LogLevel {
switch logLevel {
case "debug":
return LogLevelDebug
case "info":
return LogLevelInfo
case "warning":
return LogLevelWarning
case "error":
return LogLevelError
default:
return DefaultLogLevel
}
}

func (l LogLevel) toNSQLogLevel() nsq.LogLevel {
switch l {
case LogLevelDebug:
return nsq.LogLevelDebug
case LogLevelInfo:
return nsq.LogLevelInfo
case LogLevelWarning:
return nsq.LogLevelWarning
case LogLevelError:
return nsq.LogLevelError
case DefaultLogLevel:
return nsq.LogLevelWarning
default:
return nsq.LogLevelWarning
}
}

type Error struct {
error error
noRetry bool
Expand Down Expand Up @@ -98,6 +142,7 @@ type nsqConsumer struct {
PostponeProducer nsqproducer.Producer
count uint64
logger logrus.FieldLogger
logLevel LogLevel
}

type ConsumerOpts struct {
Expand All @@ -107,6 +152,7 @@ type ConsumerOpts struct {
Channel string
MaxInFlight int
SkipLogSet map[string]bool
LogLevel LogLevel
// PostponeProducer is an NSQ producer user to send postponed messages
PostponeProducer nsqproducer.Producer
// How long can the consumer keep the message before the message is considered as 'Timed Out'
Expand Down Expand Up @@ -135,6 +181,7 @@ func New(opts ConsumerOpts) (Consumer, error) {
MessageHandler: opts.MessageHandler,
MaxInFlight: opts.MaxInFlight,
SkipLogSet: opts.SkipLogSet,
logLevel: opts.LogLevel,
}
if consumer.MaxInFlight == 0 {
consumer.MaxInFlight = opts.NsqConfig.MaxInFlight
Expand Down Expand Up @@ -166,7 +213,7 @@ func (c *nsqConsumer) Start(ctx context.Context) func() {
c.logger.WithError(err).Fatalf("fail to create new NSQ consumer")
}

consumer.SetLogger(log.New(os.Stderr, fmt.Sprintf("[nsq-consumer(%s)]", c.Topic), log.Flags()), nsq.LogLevelWarning)
consumer.SetLogger(log.New(os.Stderr, fmt.Sprintf("[nsq-consumer(%s)]", c.Topic), log.Flags()), c.logLevel.toNSQLogLevel())

consumer.AddConcurrentHandlers(nsq.HandlerFunc(c.nsqHandler), c.MaxInFlight)

Expand Down Expand Up @@ -279,7 +326,7 @@ func (c *nsqConsumer) postponeMessage(ctx context.Context, msgLogger logrus.Fiel
Payload: msg.Payload,
}

msgLogger.Info("POSTPONE Messaage")
msgLogger.Info("POSTPONE Message")

if c.PostponeProducer == nil {
return errors.New("no postpone producer configured in this consumer")
Expand Down