api: Change logger functions to accept a log entry

Rather than accepting a `logrus.FieldLogger` interface type, change all
the `SetLogger()` functions to accept a `logrus.Entry`.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2018-07-26 14:38:26 +01:00
parent dfb758a82d
commit 029e7ca680
9 changed files with 16 additions and 15 deletions

View File

@ -19,11 +19,12 @@ func init() {
runtime.LockOSThread() runtime.LockOSThread()
} }
var virtLog = logrus.FieldLogger(logrus.New()) var virtLog *logrus.Entry
// SetLogger sets the logger for virtcontainers package. // SetLogger sets the logger for virtcontainers package.
func SetLogger(logger logrus.FieldLogger) { func SetLogger(logger *logrus.Entry) {
virtLog = logger.WithField("source", "virtcontainers") virtLog = logger.WithField("source", "virtcontainers")
deviceApi.SetLogger(virtLog) deviceApi.SetLogger(virtLog)
} }

View File

@ -12,10 +12,10 @@ import (
"github.com/kata-containers/runtime/virtcontainers/device/config" "github.com/kata-containers/runtime/virtcontainers/device/config"
) )
var devLogger = logrus.FieldLogger(logrus.New()) var devLogger *logrus.Entry
// SetLogger sets the logger for device api package. // SetLogger sets the logger for device api package.
func SetLogger(logger logrus.FieldLogger) { func SetLogger(logger *logrus.Entry) {
devLogger = logger devLogger = logger
} }

View File

@ -19,7 +19,7 @@ import (
vc "github.com/kata-containers/runtime/virtcontainers" vc "github.com/kata-containers/runtime/virtcontainers"
) )
var virtcLog = logrus.New() var virtcLog *logrus.Entry
var listFormat = "%s\t%s\t%s\t%s\n" var listFormat = "%s\t%s\t%s\t%s\n"
var statusFormat = "%s\t%s\n" var statusFormat = "%s\t%s\n"
@ -915,14 +915,14 @@ func main() {
if err != nil { if err != nil {
return err return err
} }
virtcLog.Out = f virtcLog.Logger.Out = f
} }
switch context.GlobalString("log-format") { switch context.GlobalString("log-format") {
case "text": case "text":
// retain logrus's default. // retain logrus's default.
case "json": case "json":
virtcLog.Formatter = new(logrus.JSONFormatter) virtcLog.Logger.Formatter = new(logrus.JSONFormatter)
default: default:
return fmt.Errorf("unknown log-format %q", context.GlobalString("log-format")) return fmt.Errorf("unknown log-format %q", context.GlobalString("log-format"))
} }

View File

@ -22,7 +22,7 @@ type VCImpl struct {
} }
// SetLogger implements the VC function of the same name. // SetLogger implements the VC function of the same name.
func (impl *VCImpl) SetLogger(logger logrus.FieldLogger) { func (impl *VCImpl) SetLogger(logger *logrus.Entry) {
SetLogger(logger) SetLogger(logger)
} }

View File

@ -15,7 +15,7 @@ import (
// VC is the Virtcontainers interface // VC is the Virtcontainers interface
type VC interface { type VC interface {
SetLogger(logger logrus.FieldLogger) SetLogger(logger *logrus.Entry)
SetFactory(Factory) SetFactory(Factory)
CreateSandbox(sandboxConfig SandboxConfig) (VCSandbox, error) CreateSandbox(sandboxConfig SandboxConfig) (VCSandbox, error)

View File

@ -131,7 +131,7 @@ func (config *RuntimeConfig) AddKernelParam(p vc.Param) error {
var ociLog = logrus.FieldLogger(logrus.New()) var ociLog = logrus.FieldLogger(logrus.New())
// SetLogger sets the logger for oci package. // SetLogger sets the logger for oci package.
func SetLogger(logger logrus.FieldLogger) { func SetLogger(logger *logrus.Entry) {
ociLog = logger.WithFields(logrus.Fields{ ociLog = logger.WithFields(logrus.Fields{
"source": "virtcontainers", "source": "virtcontainers",
"subsystem": "oci", "subsystem": "oci",

View File

@ -29,7 +29,7 @@ import (
const mockErrorPrefix = "vcmock forced failure" const mockErrorPrefix = "vcmock forced failure"
// SetLogger implements the VC function of the same name. // SetLogger implements the VC function of the same name.
func (m *VCMock) SetLogger(logger logrus.FieldLogger) { func (m *VCMock) SetLogger(logger *logrus.Entry) {
if m.SetLoggerFunc != nil { if m.SetLoggerFunc != nil {
m.SetLoggerFunc(logger) m.SetLoggerFunc(logger)
} }

View File

@ -98,7 +98,7 @@ func TestVCMockSetLogger(t *testing.T) {
m := &VCMock{} m := &VCMock{}
assert.Nil(m.SetLoggerFunc) assert.Nil(m.SetLoggerFunc)
logger := logrus.New() logger := logrus.NewEntry(logrus.New())
assert.Equal(loggerTriggered, 0) assert.Equal(loggerTriggered, 0)
m.SetLogger(logger) m.SetLogger(logger)

View File

@ -66,11 +66,11 @@ func TestMain(m *testing.M) {
flag.Parse() flag.Parse()
logger := logrus.New() logger := logrus.NewEntry(logrus.New())
logger.Level = logrus.ErrorLevel logger.Logger.Level = logrus.ErrorLevel
for _, arg := range flag.Args() { for _, arg := range flag.Args() {
if arg == "debug-logs" { if arg == "debug-logs" {
logger.Level = logrus.DebugLevel logger.Logger.Level = logrus.DebugLevel
} }
} }
SetLogger(logger) SetLogger(logger)