Merge pull request #276 from NVIDIA/enable-dcgm-logging-options

Added ability to enable DCGM library log output

.vscode/launch.json

@@ -14,7 +14,9 @@
             "args": [
                 "-f",
                 "./etc/default-counters.csv",
-                "--debug"
+                "--debug",
+                "--enable-dcgm-log",
+                "--dcgm-log-level=INFO"
             ]
         }
     ]

Makefile

@@ -94,4 +94,3 @@ validate-modules:
 tools: ## Install required tools and utilities
 	go install github.com/golangci/golangci-lint/cmd/[email protected]
 	go install github.com/axw/gocov/gocov@latest
-

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/NVIDIA/go-nvml v0.12.0-2
 	github.com/avast/retry-go/v4 v4.5.1
 	github.com/bits-and-blooms/bitset v1.13.0
+	github.com/go-kit/log v0.2.1
 	github.com/gorilla/mux v1.8.1
 	github.com/prometheus/client_model v0.6.0
 	github.com/prometheus/common v0.47.0
@@ -31,7 +32,6 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/emicklei/go-restful/v3 v3.11.0 // indirect
 	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
-	github.com/go-kit/log v0.2.1 // indirect
 	github.com/go-logfmt/logfmt v0.5.1 // indirect
 	github.com/go-logr/logr v1.3.0 // indirect
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect

internal/pkg/logging/logger_adapter.go

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2024, NVIDIA CORPORATION.  All rights reserved.
+ *
+ * Licensed 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 logging
+
+import (
+	"fmt"
+	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
+	"github.com/sirupsen/logrus"
+)
+
+// LogrusAdapter is an adapter that allows logrus Logger to be used as a go-kit/log Logger.
+type LogrusAdapter struct {
+	Logger *logrus.Logger
+}
+
+// NewLogrusAdapter creates a new LogrusAdapter with the provided logrus.Logger.
+func NewLogrusAdapter(logger *logrus.Logger) log.Logger {
+	return &LogrusAdapter{
+		Logger: logger,
+	}
+}
+
+// Log implements the go-kit/log Logger interface.
+func (la *LogrusAdapter) Log(keyvals ...interface{}) error {
+	// keyvals is a slice of interfaces, that represents a key-value pairs.
+	if len(keyvals)%2 != 0 {
+		keyvals = append(keyvals, "MISSING")
+	}
+
+	fields := logrus.Fields{}
+	for i := 0; i < len(keyvals); i += 2 {
+		key, ok := keyvals[i].(string)
+		if !ok {
+			// If the key is not la string, use la default key
+			key = "missing_key"
+		}
+		fields[key] = keyvals[i+1]
+	}
+
+	// The go-kit/log uses msg field to keep log message, we don't want to use message as field in the logrus.
+	msg, exists := fields["msg"]
+	if exists {
+		delete(fields, "msg")
+	}
+
+	// The go-kit/log uses level fields to keep log level. We need to convert this field into logrus value.
+	lvl, exists := fields["level"]
+	if !exists {
+		fields["level"] = level.InfoValue()
+	}
+	delete(fields, "level")
+	parsedLvl, err := logrus.ParseLevel(fmt.Sprint(lvl))
+	if err != nil {
+		parsedLvl = logrus.InfoLevel
+	}
+
+	la.Logger.WithFields(fields).Log(parsedLvl, msg)
+
+	return nil
+}

internal/pkg/logging/logger_adapter_test.go

@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2024, NVIDIA CORPORATION.  All rights reserved.
+ *
+ * Licensed 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 logging
+
+import (
+	"github.com/go-kit/log/level"
+	"github.com/sirupsen/logrus"
+	"github.com/sirupsen/logrus/hooks/test"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestLogrusAdapter_Log(t *testing.T) {
+	type testCase struct {
+		name    string
+		keyvals []interface{}
+		assert  func(*testing.T, *logrus.Entry)
+	}
+
+	//"msg", "Listening on", "address"
+	testCases := []testCase{
+		{
+			name: "Success",
+			keyvals: []interface{}{
+				"level",
+				level.InfoValue,
+				"msg",
+				"Listening on",
+				"address",
+				"127.0.0.0.1:8080",
+			},
+			assert: func(t *testing.T, entry *logrus.Entry) {
+				t.Helper()
+				require.NotNil(t, entry)
+				assert.Equal(t, "Listening on", entry.Message)
+				require.Contains(t, entry.Data, "address")
+				assert.Equal(t, "127.0.0.0.1:8080", entry.Data["address"])
+			},
+		},
+		{
+			name: "When no Level",
+			keyvals: []interface{}{
+				"msg",
+				"Listening on",
+				"address",
+				"127.0.0.0.1:8080",
+			},
+			assert: func(t *testing.T, entry *logrus.Entry) {
+				t.Helper()
+				require.NotNil(t, entry)
+				assert.Equal(t, "Listening on", entry.Message)
+				require.Contains(t, entry.Data, "address")
+				assert.Equal(t, "127.0.0.0.1:8080", entry.Data["address"])
+			},
+		},
+		{
+			name: "When key is not string",
+			keyvals: []interface{}{
+				"msg",
+				"Listening on",
+				42,
+				"127.0.0.0.1:8080",
+			},
+			assert: func(t *testing.T, entry *logrus.Entry) {
+				t.Helper()
+				require.NotNil(t, entry)
+				assert.Equal(t, "Listening on", entry.Message)
+				require.Contains(t, entry.Data, "missing_key")
+				assert.Equal(t, "127.0.0.0.1:8080", entry.Data["missing_key"])
+			},
+		},
+		{
+			name: "When value is missing",
+			keyvals: []interface{}{
+				"msg",
+				"Listening on",
+				"address",
+			},
+			assert: func(t *testing.T, entry *logrus.Entry) {
+				t.Helper()
+				require.NotNil(t, entry)
+				assert.Equal(t, "Listening on", entry.Message)
+				require.Contains(t, entry.Data, "address")
+				assert.Equal(t, "MISSING", entry.Data["address"])
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			logrusLogger, logHook := test.NewNullLogger()
+			logger := NewLogrusAdapter(logrusLogger)
+			err := logger.Log(tc.keyvals...)
+			require.NoError(t, err)
+			tc.assert(t, logHook.LastEntry())
+		})
+	}
+}