shohi commented on a change in pull request #323: URL: https://github.com/apache/pulsar-client-go/pull/323#discussion_r474373341
########## File path: pulsar/log/logger.go ########## @@ -0,0 +1,57 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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 log + +// Logger and Entry interfaces are inspired by sirupsen/logrus + +// Fields type, used to pass to `WithFields`. +type Fields map[string]interface{} + +// Logger describes the interface that must be implemeted by all loggers. +type Logger interface { + SubLogger(fields Fields) Logger + + WithFields(fields Fields) Entry + WithField(name string, value interface{}) Entry + + Debug(args ...interface{}) + Info(args ...interface{}) + Warn(args ...interface{}) + Error(args ...interface{}) + + Debugf(format string, args ...interface{}) + Infof(format string, args ...interface{}) + Warnf(format string, args ...interface{}) + Errorf(format string, args ...interface{}) +} + +// Entry describes the interface for the logger entry. +type Entry interface { Review comment: For `logrus` backed implementation, it's true, but the logger interfaces are not targeted only for logrus, they are more for users to customize the implementation to cope with their own scenarios. Using two entities makes logging concepts clear and gives users more control on the implementation, in some cases, logging performance is critical and entry pooling is necessary. Logger is usually used to hold the log level, common fields and its own entry pool, where the entry holds its private fields, formats all its fields into bytes and emits the bytes out. I think implementation based on these concepts is much straightforward. The popular `logrus` provides both logger-level and entry-level methods, but they are not based on interfaces. Another the performant logging library `zap` provides only Logger level methods, but all loggers share a global entry pool. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
