Skip to content

log.With does not compose well with log.Levels #63

Description

@ChrisHines

Context

I would like the ability to do something like this:

var Log log.Logger

func HandleTask(taskID int) error {
    logger := log.With(Log, "task", taskID)
    logger.Info("event", "start")
    ...
    logger.Debug("event", "query", "query", query)
    if err := doQuery(query); err != nil {
        logger.Error("event", "query", "err", err)
        return err
    }
    ...
    logger.Info("event", "done")
}

The important aspect of my example is the re-use of logging context across multiple severity levels.

The problem

As it stands now, package log encourages us to implement log levels via multiple Loggers each with a different level context created by a call to log.With. Unfortunately this approach makes it cumbersome to create additional contextual loggers on top of the leveled loggers. For example:

var lvls = log.NewLevels()

func HandleTask(taskID int) error {
    dlog := log.With(lvls.Debug, "task", taskID)
    ilog := log.With(lvls.Info, "task", taskID)
    elog := log.With(lvls.Error, "task", taskID)

    ilog.Log("event", "start")
    ...
    dlog.Log("event", "query", "query", query)
    if err := doQuery(query); err != nil {
        elog.Log("event", "query", "err", err)
        return err
    }
    ...
    ilog.Log("event", "done")
}

In addition to being cumbersome, each call to log.With costs allocations.

Challenge

Can we find a good way to avoid the need for multiple calls to log.With when doing leveled logging?

Activity

  1. changed the title [-]`log.With` does not compose well with `log.Levels`[/-] [+]log.With does not compose well with log.Levels[/+] on Jun 17, 2015
  2. peterbourgon commented on Jun 17, 2015

    @peterbourgon
    Member

    The obvious way is to canonize some levels into the interface definition, but I'd like to avoid that...

  3. peterbourgon commented on Jun 21, 2015

    @peterbourgon
    Member

    We could define a new interface with canonized levels, with constructors that can wrap a logger...

  4. ChrisHines commented on Jun 21, 2015

    @ChrisHines
    MemberAuthor

    How would log.With compose with the new interface you propose?

  5. peterbourgon commented on Jun 21, 2015

    @peterbourgon
    Member

    Not well :) Could probably dream up a special-case solution, like

    type Foo interface {
        Info(keyvals ...interface{})
        Warn(keyvals ...interface{})
        Error(keyvals ...interface{})
    
        With(keyvals ...interface{}) Foo
    }

    But that feels awkward, opposite of the existing API.

  6. peterbourgon commented on Jun 21, 2015

    @peterbourgon
    Member

    In general I'm struggling to embrace and extend log.With semantics...

  7. peterbourgon commented on Jun 29, 2015

    @peterbourgon
    Member

    @ChrisHines, what do you think about the approach described in this README?

  8. ChrisHines commented on Jul 3, 2015

    @ChrisHines
    MemberAuthor

    @peterbourgon What do you think of this?

    func With(keyvals ...interface{}) Context {
        c := Context{}
        return c.With(keyvals...)
    }
    
    type Context []interface{}
    
    func (c Context) With(keyvals ...interface{}) Context {
        n := len(c)
        return append(c[:n:n], keyvals...)
    }
    
    func (c Context) LogTo(logger Logger) error {
        ctx := c
        if containsValuer(ctx) {
            ctx = append(Context{}, ctx...)
            bindValues(ctx)
        }
        return logger.Log(ctx...)
    }

    The above code would get used like this:

    ctx := log.With("a", 123)
    ...
    ctx = ctx.With("b", "c")
    ...
    ctx.With("msg", "message").LogTo(logger)
  9. peterbourgon commented on Jul 4, 2015

    @peterbourgon
    Member

    On first read I resisted the idea of manipulating a first-order Context object and logging it "to" a destination, but after rolling it around a little bit, it feels like it could reasonable. Any reason not to s/LogTo/Log/? Thinking out loud a little bit: we're flying pretty close to an encoder or writer API, I wonder if it doesn't make sense to make that more explicit, with something like

    type Logger interface {
        Log(Context) error
    }
    
    func (c Context) Log(dst Logger) error {
        return dst.Log(c)
    }

    ...which raises the question of where best to put the valuer stuff. It feels strange to have it only occur when you context.Log(logger), and get ignored if you logger.Log(context). Maybe your version, having the logger take a keyvals, makes that more explicit.

  10. added a commit that references this issue on Oct 12, 2016
    f5d44a4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions