Skip to content

Commit

Permalink
[cmd/telemetrygen] remove go-grpc-middleware dep (#37103)
Browse files Browse the repository at this point in the history
This PR removes a dependency that needed to be updated anyways. This
uses the same method we use in core for setting the grpc logger using
grpclog directly.

---------

Signed-off-by: Alex Boten <[email protected]>
  • Loading branch information
codeboten authored Jan 9, 2025
1 parent 5f913db commit 765ddb7
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 156 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: telemetrygen

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove go-grpc-middleware dependency

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [37103]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
2 changes: 0 additions & 2 deletions cmd/telemetrygen/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/cmd/telemetryge
go 1.22.7

require (
github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
github.com/spf13/cobra v1.8.1
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.10.0
Expand Down Expand Up @@ -36,7 +35,6 @@ require (
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
Expand Down
74 changes: 0 additions & 74 deletions cmd/telemetrygen/go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions cmd/telemetrygen/internal/common/log.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ package common
import (
"fmt"

grpcZap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"go.uber.org/zap/zapgrpc"
"google.golang.org/grpc/grpclog"
)

// CreateLogger creates a logger for use by telemetrygen
Expand All @@ -16,10 +18,12 @@ func CreateLogger(skipSettingGRPCLogger bool) (*zap.Logger, error) {
if err != nil {
return nil, fmt.Errorf("failed to obtain logger: %w", err)
}

if !skipSettingGRPCLogger {
grpcZap.ReplaceGrpcLoggerV2WithVerbosity(logger.WithOptions(
zap.AddCallerSkip(3),
), 1) // set to warn verbosity to avoid copious logging from grpc framework
grpcLogger := zapgrpc.NewLogger(logger.WithOptions(zap.WrapCore(func(core zapcore.Core) zapcore.Core {
return core.With([]zapcore.Field{zap.Bool("grpc_log", true)})
}), zap.AddCallerSkip(3)))
grpclog.SetLoggerV2(grpcLogger)
}
return logger, err
}
Loading

0 comments on commit 765ddb7

Please sign in to comment.