Merge pull request #945 from newrelic/develop

Release 3.34.0

.github/auto_assign.yml

@@ -2,7 +2,7 @@
 addReviewers: true
 
 # Set to true to add assignees to pull requests
-addAssignees: false
+addAssignees: true
 
 # A list of reviewers to be added to pull requests (GitHub user name)
 reviewers:

.github/workflows/autoassign.yml

@@ -7,4 +7,4 @@ jobs:
   add-reviews:
     runs-on: ubuntu-latest
     steps:
-      - uses: kentaro-m/auto-assign-action@v1.2.0
+      - uses: kentaro-m/auto-assign-action@v2.0.0

.github/workflows/ci.yaml

@@ -4,7 +4,7 @@ name: Go Agent CI
 on: pull_request
 env:
   # Specifies which go version to run integration tests on
-  INTEGRATION_TESTS_GO_VERSION: 1.21.5
+  INTEGRATION_TESTS_GO_VERSION: latest
 
 jobs:
   go-agent-v3:
@@ -15,11 +15,13 @@ jobs:
       matrix:
         include:
             # Core Tests on 3 most recent major Go versions
-          - go-version: 1.19.0
+          - go-version: 1.20.14
             dirs: v3/newrelic,v3/internal,v3/examples
-          - go-version: 1.20.0
+          - go-version: 1.21
             dirs: v3/newrelic,v3/internal,v3/examples
-          - go-version: 1.21.0
+          - go-version: latest
+            dirs: v3/newrelic,v3/internal,v3/examples
+          - go-version: 1.23rc2
             dirs: v3/newrelic,v3/internal,v3/examples
 
             # Integration Tests on highest Supported Go Version
@@ -68,6 +70,7 @@ jobs:
           - dirs: v3/integrations/nrgraphqlgo,v3/integrations/nrgraphqlgo/example
           - dirs: v3/integrations/nrmssql
           - dirs: v3/integrations/nropenai
+          - dirs: v3/integrations/nrslog
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
@@ -106,11 +109,11 @@ jobs:
       matrix:
         include:
             # Core Tests on 3 most recent major Go versions
-          - go-version: 1.19.0
+          - go-version: 1.20.14
             dirs: v3/newrelic,v3/internal,v3/examples
-          - go-version: 1.20.0
+          - go-version: 1.21
             dirs: v3/newrelic,v3/internal,v3/examples
-          - go-version: 1.21.0
+          - go-version: latest
             dirs: v3/newrelic,v3/internal,v3/examples
     steps:
     - name: Checkout Code

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.34.0
+### Added
+  - logcontext-v2/nrlogrus can now collect user attributes
+  - logcontext-v2/nrslog can now collect user attributes
+  - use slog to manage Go agent logs with the new nrslog library
+  - use zerolog go manage Go agent logs with the new nrzerolog library
+  - support for `RegisterTLSConfig` in nrmysql
+### Fixed
+  - logcontext-v2/nrlogrus will still print user logs without isses if the Go agent has already been shut down.
+  - switched protobuff to google.golang.org/protobuff in modfile
+### Support statement
+We use the latest version of the Go language. At minimum, you should be using no version of Go older than what is supported by the Go team themselves.
+See the [Go agent EOL Policy](/docs/apm/agents/go-agent/get-started/go-agent-eol-policy) for details about supported versions of the Go agent and third-party components.
+
+
 ## 3.33.1
 ### Added
    - Increased max span events default limit to 2,000 to align with agent specifications

Dockerfile

@@ -1,6 +1,6 @@
 # This file is used to build the docker image for the Go Agent's GitHub Action tests
 # Default go version if no arguments passed in
-ARG GO_VERSION=1.19
+ARG GO_VERSION=1.20
 
 # Takes in go version
 FROM golang:${GO_VERSION} as builder

GUIDE.md

@@ -137,12 +137,13 @@ if nil == err {
 }
 ```
 
-Popular logging libraries `logrus`, `logxi` and `zap` are supported by
+Popular logging libraries `logrus`, `logxi`, `zap` and `zerolog` are supported by
 integration packages:
 
 * [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus/)
 * [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi/)
 * [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap/)
+* [v3/integrations/nrzerolog](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog/)
 
 ## Transactions
 

README.md

@@ -112,11 +112,13 @@ package primitives can be found [here](GUIDE.md#datastore-segments).
 
 #### Agent Logging
 
-| Project | Integration Package |  |
-| ------------- | ------------- | - |
-| [sirupsen/logrus](https://github.com/sirupsen/logrus) | [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus) | Send agent log messages to Logrus |
-| [mgutz/logxi](https://github.com/mgutz/logxi) | [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi) | Send agent log messages to Logxi |
-| [uber-go/zap](https://github.com/uber-go/zap) | [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap) | Send agent log messages to Zap |
+| Project                                               | Integration Package                                                                                 |                                       |
+|-------------------------------------------------------|-----------------------------------------------------------------------------------------------------|---------------------------------------|
+| [sirupsen/logrus](https://github.com/sirupsen/logrus) | [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus) | Send agent log messages to Logrus     |
+| [mgutz/logxi](https://github.com/mgutz/logxi)         | [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi)   | Send agent log messages to Logxi      |
+| [uber-go/zap](https://github.com/uber-go/zap)         | [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap)       | Send agent log messages to Zap        |
+| [log/slog](https://pkg.go.dev/log/slog)               | [v3/integrations/nrslog](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrslog)     | Send agent log messages to `log/slog` |
+| [rs/zerolog](https://github.com/rs/zerolog)           | [v3/integrations/nrzerolog](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog) | Send agent log messages to Zerolog  |
 
 #### Logs in Context
 

v3/go.mod

@@ -3,7 +3,7 @@ module github.com/newrelic/go-agent/v3
 go 1.20
 
 require (
-	github.com/golang/protobuf v1.5.3
+	google.golang.org/protobuf v1.5.3
 	google.golang.org/grpc v1.56.3
 )
 

v3/integrations/logcontext-v2/nrlogrus/formatter.go

@@ -30,8 +30,9 @@ func NewFormatter(app *newrelic.Application, formatter logrus.Formatter) Context
 // Format renders a single log entry.
 func (f ContextFormatter) Format(e *logrus.Entry) ([]byte, error) {
 	logData := newrelic.LogData{
-		Severity: e.Level.String(),
-		Message:  e.Message,
+		Severity:   e.Level.String(),
+		Message:    e.Message,
+		Attributes: e.Data,
 	}
 
 	logBytes, err := f.formatter.Format(e)

v3/integrations/logcontext-v2/nrlogrus/formatter_test.go

@@ -114,6 +114,32 @@ func TestBackgroundLog(t *testing.T) {
 	})
 }
 
+func TestBackgroundLogWithFields(t *testing.T) {
+	app := integrationsupport.NewTestApp(integrationsupport.SampleEverythingReplyFn,
+		newrelic.ConfigAppLogDecoratingEnabled(true),
+		newrelic.ConfigAppLogForwardingEnabled(true),
+	)
+	out := bytes.NewBuffer([]byte{})
+	log := newTextLogger(out, app.Application)
+	message := "Hello World!"
+	log.WithField("test field", []string{"a", "b"}).Info(message)
+	logcontext.ValidateDecoratedOutput(t, out, &logcontext.DecorationExpect{
+		EntityGUID: integrationsupport.TestEntityGUID,
+		Hostname:   host,
+		EntityName: integrationsupport.SampleAppName,
+	})
+	app.ExpectLogEvents(t, []internal.WantLog{
+		{
+			Severity:  logrus.InfoLevel.String(),
+			Message:   message,
+			Timestamp: internal.MatchAnyUnixMilli,
+			Attributes: map[string]interface{}{
+				"test field": []string{"a", "b"},
+			},
+		},
+	})
+}
+
 func TestJSONBackgroundLog(t *testing.T) {
 	app := integrationsupport.NewTestApp(integrationsupport.SampleEverythingReplyFn,
 		newrelic.ConfigAppLogDecoratingEnabled(true),
@@ -192,3 +218,39 @@ func TestLogInContext(t *testing.T) {
 
 	txn.End()
 }
+
+func TestLogInContextWithFields(t *testing.T) {
+	app := integrationsupport.NewTestApp(integrationsupport.SampleEverythingReplyFn,
+		newrelic.ConfigAppLogDecoratingEnabled(true),
+		newrelic.ConfigAppLogForwardingEnabled(true),
+	)
+	out := bytes.NewBuffer([]byte{})
+	log := newTextLogger(out, app.Application)
+	txn := app.StartTransaction("test txn")
+
+	ctx := newrelic.NewContext(context.Background(), txn)
+	message := "Hello World!"
+	log.WithField("hi", 1).WithContext(ctx).Info(message)
+
+	logcontext.ValidateDecoratedOutput(t, out, &logcontext.DecorationExpect{
+		EntityGUID: integrationsupport.TestEntityGUID,
+		Hostname:   host,
+		EntityName: integrationsupport.SampleAppName,
+		TraceID:    txn.GetLinkingMetadata().TraceID,
+		SpanID:     txn.GetLinkingMetadata().SpanID,
+	})
+	txn.ExpectLogEvents(t, []internal.WantLog{
+		{
+			Severity:  logrus.InfoLevel.String(),
+			Message:   message,
+			Timestamp: internal.MatchAnyUnixMilli,
+			SpanID:    txn.GetLinkingMetadata().SpanID,
+			TraceID:   txn.GetLinkingMetadata().TraceID,
+			Attributes: map[string]interface{}{
+				"hi": 1,
+			},
+		},
+	})
+
+	txn.End()
+}

v3/integrations/logcontext-v2/nrslog/example/main.go

@@ -12,6 +12,7 @@ import (
 
 func main() {
 	app, err := newrelic.NewApplication(
+		newrelic.ConfigAppName("slog example app"),
 		newrelic.ConfigFromEnvironment(),
 		newrelic.ConfigAppLogEnabled(true),
 	)
@@ -27,7 +28,11 @@ func main() {
 	txn := app.StartTransaction("example transaction")
 	ctx := newrelic.NewContext(context.Background(), txn)
 
-	log.InfoContext(ctx, "I am a log inside a transaction")
+	log.InfoContext(ctx, "I am a log inside a transaction with custom attributes!",
+		slog.String("foo", "bar"),
+		slog.Int("answer", 42),
+		slog.Any("some_map", map[string]interface{}{"a": 1.0, "b": 2}),
+	)
 
 	// pretend to do some work
 	time.Sleep(500 * time.Millisecond)

v3/integrations/logcontext-v2/nrslog/handler.go

@@ -129,10 +129,18 @@ func (h NRHandler) Enabled(ctx context.Context, lvl slog.Level) bool {
 //   - If a group has no Attrs (even if it has a non-empty key),
 //     ignore it.
 func (h NRHandler) Handle(ctx context.Context, record slog.Record) error {
+	attrs := map[string]interface{}{}
+
+	record.Attrs(func(attr slog.Attr) bool {
+		attrs[attr.Key] = attr.Value.Any()
+		return true
+	})
+
 	data := newrelic.LogData{
-		Severity:  record.Level.String(),
-		Timestamp: record.Time.UnixMilli(),
-		Message:   record.Message,
+		Severity:   record.Level.String(),
+		Timestamp:  record.Time.UnixMilli(),
+		Message:    record.Message,
+		Attributes: attrs,
 	}
 	if h.txn != nil {
 		h.txn.RecordLog(data)

v3/integrations/logcontext-v2/nrslog/handler_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"log/slog"
+	"os"
 	"strings"
 	"testing"
 
@@ -225,6 +226,45 @@ func TestWithAttributes(t *testing.T) {
 
 }
 
+func TestWithAttributesFromContext(t *testing.T) {
+	app := integrationsupport.NewTestApp(integrationsupport.SampleEverythingReplyFn,
+		newrelic.ConfigAppLogDecoratingEnabled(false),
+		newrelic.ConfigAppLogForwardingEnabled(true),
+	)
+	log := slog.New(TextHandler(app.Application, os.Stdout, &slog.HandlerOptions{}))
+
+	log.Info("I am a log message")
+
+	txn := app.StartTransaction("example transaction")
+	ctx := newrelic.NewContext(context.Background(), txn)
+
+	log.InfoContext(ctx, "I am a log inside a transaction with custom attributes!",
+		slog.String("foo", "bar"),
+		slog.Int("answer", 42),
+		slog.Any("some_map", map[string]interface{}{"a": 1.0, "b": 2}),
+	)
+
+	txn.End()
+
+	app.ExpectLogEvents(t, []internal.WantLog{
+		{
+			Severity:  slog.LevelInfo.String(),
+			Message:   "I am a log message",
+			Timestamp: internal.MatchAnyUnixMilli,
+		},
+		{
+			Severity:  slog.LevelInfo.String(),
+			Message:   "I am a log inside a transaction with custom attributes!",
+			Timestamp: internal.MatchAnyUnixMilli,
+			Attributes: map[string]interface{}{
+				"foo":      "bar",
+				"answer":   42,
+				"some_map": map[string]interface{}{"a": 1.0, "b": 2},
+			},
+		},
+	})
+
+}
 func TestWithGroup(t *testing.T) {
 	app := integrationsupport.NewTestApp(integrationsupport.SampleEverythingReplyFn,
 		newrelic.ConfigAppLogDecoratingEnabled(false),

v3/integrations/nrmssql/nrmssql.go

@@ -1,9 +1,6 @@
 // Copyright 2020 New Relic Corporation. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-//go:build go1.10
-// +build go1.10
-
 // Package nrmssql instruments github.com/microsoft/go-mssqldb.
 //
 // Use this package to instrument your MSSQL calls without having to manually

v3/integrations/nrmysql/nrmysql.go

@@ -1,6 +1,7 @@
 // Copyright 2020 New Relic Corporation. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+//go:build go1.10
 // +build go1.10
 
 // Package nrmysql instruments https://github.com/go-sql-driver/mysql.
@@ -48,6 +49,7 @@
 package nrmysql
 
 import (
+	"crypto/tls"
 	"database/sql"
 	"net"
 
@@ -67,6 +69,10 @@ var (
 	}
 )
 
+func RegisterTLSConfig(key string, config *tls.Config) error {
+	return mysql.RegisterTLSConfig(key, config)
+}
+
 func init() {
 	sql.Register("nrmysql", newrelic.InstrumentSQLDriver(mysql.MySQLDriver{}, baseBuilder))
 	internal.TrackUsage("integration", "driver", "mysql")