Skip to content

Some implementations of the go-logr/logr interface.

License

Notifications You must be signed in to change notification settings

bythepowerof/logr

 
 

Repository files navigation

Logr | Build Status|codecov

Some different implementations of the go-logr/logr logging interface.

Implementation Notes
stdlogr A standard implementation () using fmt that prints logs to STDOUT in logfmt
logrusr Output using logrus

stdlogr

The stdlogr uses fmt to print logs to STDOUT in logfmt. Error logs get printed even if the InfoLogger is disabled.

Example:

package main

import (
  "errors"

  "github.com/activeshadow/logr/stdlogr"
)

func main() {
  // Create new "foo" logger that's enabled and has a verbosity level of 1.
  logger := stdlogr.New("foo", true, 1)
  logger.Info("is this working?", "working", true)

  foobarLogger := logger.WithName("bar")
  err := errors.New("this is an error")
  foobarLogger.Error(err, "what about this logger?", "hello", "world!")

  logger.V(1).Info("verbosity 1 log")
  logger.V(2).Info("verbosity 2 log")
}

Output:

level=info ts=1534767423 name=foo msg="is this working?" working=true
level=error ts=1534767423 name=foo.bar msg="what about this logger?" hello=world! error="this is an error"
level=info ts=1534767423 name=foo msg="verbosity 1 log" v=1

logrusr

This was developed to work with kubebuilder which uses logr internally. We needed logrus output, so this seemed the simplest way.

Example:

package main

import (
  "errors"
  "github.com/bythepowerof/logr/logrusr"
  "github.com/sirupsen/logrus"
)

func main() {
  // Create new "foo" logger that's enabled and has a verbosity level of 1.
  l := logrus.New()
  
  // PrettyPrint should be false/not set 
  l.SetFormatter(&logrus.JSONFormatter{PrettyPrint: true})

  logger := logrusr.New("foo", *l ) 
  logger.Info("is this working?", "working", true)

  foobarLogger := logger.WithName("bar")
  err := errors.New("this is an error")
  foobarLogger.Error(err, "what about this logger?", "hello", "world!")

  logrusr.SetVerbosity(1)
  logger.V(1).Info("verbosity 1 log")
  
  logger.V(2).Info("verbosity 2 log")
}

Output:

{
  "level": "info",
  "msg": "is this working?",
  "request": {
    "kvs": [
      "working",
      true
    ],
    "name": "foo",
    "this_kvs": {}
  },
  "time": "2019-07-30T14:19:05+10:00"
}
{
  "level": "error",
  "msg": "what about this logger?",
  "request": {
    "error": {},
    "kvs": [
      "hello",
      "world!"
    ],
    "name": "foo.bar",
    "this_kvs": {}
  },
  "time": "2019-07-30T14:19:05+10:00"
}
{
  "level": "info",
  "msg": "verbosity 1 log",
  "request": {
    "kvs": null,
    "name": "foo",
    "this_kvs": {
      "v": 1
    }
  },
  "time": "2019-07-30T14:19:05+10:00"
}

License

MIT License

Copyright (c) 2018

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

Some implementations of the go-logr/logr interface.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 96.2%
  • Shell 2.7%
  • Makefile 1.1%