OTEL wiring in grpcserver interceptor (DataDog POC) #612

p0mvn · 2024-05-30T21:55:59Z

This PR wires up OTEL tracing in gprcserver interceptor, allowing tracing requests that originate from external services.

I had to bump up go as 1.20 did not support some of the otel grpc dependencies.

This has led to bumping up go versions of a lot of the CI stuff.

Tested.

coderabbitai · 2024-05-30T21:56:17Z

Walkthrough

The recent updates introduce OpenTelemetry tracing into the gRPC server functionality within the codebase. This enhancement includes importing necessary OpenTelemetry libraries and incorporating tracing logic into the interceptor function and StartGRPCServer function. These changes aim to improve observability and monitoring of gRPC calls by capturing detailed tracing information.

Changes

Files	Change Summary
`baseapp/grpcserver.go`	Added OpenTelemetry tracing imports, `tracerName` constant, and modified `interceptor` function.
`server/grpc/server.go`	Introduced OpenTelemetry instrumentation for gRPC, including `otelgrpc.NewServerHandler()`.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant gRPCServer
    participant OpenTelemetry

    Client->>gRPCServer: Send gRPC request
    gRPCServer->>OpenTelemetry: Start trace
    gRPCServer->>gRPCServer: Process request
    gRPCServer->>OpenTelemetry: End trace
    gRPCServer->>Client: Send response

Poem

In the code where gRPC roams,
Traces now find their homes.
With OpenTelemetry's might,
Observability takes flight.
Each request, a story told,
In spans of data, bright and bold.
🌟📡🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

p0mvn · 2024-07-20T23:10:41Z

baseapp/grpcserver.go

-		return handler(grpcCtx, req)
+		// Extract the existing span context from the incoming request
+		parentCtx := otel.GetTextMapPropagator().Extract(grpcCtx, propagation.HeaderCarrier(md))
+
+		// Start a new span representing the request
+		// The span ends when the request is complete
+		grpcCtx, span := tracer.Start(parentCtx, grpcInfo.FullMethod, trace.WithSpanKind(trace.SpanKindServer))
+		defer span.End()
+
+		span.SetAttributes(attribute.String("http.method", grpcInfo.FullMethod))
+
+		resp, err = handler(grpcCtx, req)
+
+		if err != nil {
+			span.SetStatus(otelcodes.Error, err.Error())
+		} else {
+			span.SetStatus(otelcodes.Ok, "OK")
+		}
+
+		return resp, err


p0mvn · 2024-07-21T00:02:58Z

.github/workflows/lint.yml

-          version: v1.51.2
+          version: v1.54.0


I had to do this because this is the first version that supports go 1.21

p0mvn · 2024-07-21T00:03:16Z

.golangci.yml

@@ -8,7 +8,6 @@ run:
 linters:
  disable-all: true
  enable:
-    - depguard


note: too many complaints after linter version bump so I removed it

* OTEL wiring in grpcserver * updates * updates * grpc headers * updates * updates * updates * go 1.21 * updates * test go1.21 * update lint go * go mod for tests * more updates * bump linter version * updates * remove nakedret * codeql go version (cherry picked from commit 5c3a933) # Conflicts: # .github/workflows/lint.yml # .golangci.yml # baseapp/grpcserver.go # go.mod # go.sum # simapp/go.mod # simapp/go.sum # tests/go.mod # tests/go.sum

* OTEL wiring in grpcserver * updates * updates * grpc headers * updates * updates * updates * go 1.21 * updates * test go1.21 * update lint go * go mod for tests * more updates * bump linter version * updates * remove nakedret * codeql go version

) (#619) * OTEL wiring in grpcserver interceptor (DataDog POC) (backport #612) * updates * deps * updates * updates * updates * updates * lint --------- Co-authored-by: Roman <roman@osmosis.team>

OTEL wiring in grpcserver

436de0d

p0mvn added 2 commits May 30, 2024 18:04

updates

c14cd47

updates

f7b0738

p0mvn mentioned this pull request May 30, 2024

Roman/data 187 sqs datadog poc osmosis-labs/osmosis#8333

Closed

p0mvn closed this May 31, 2024

grpc headers

3796c6f

p0mvn reopened this Jun 10, 2024

p0mvn marked this pull request as draft June 10, 2024 19:39

p0mvn commented Jul 20, 2024

View reviewed changes

p0mvn added 4 commits July 20, 2024 17:20

updates

aea2d17

updates

9d591d4

updates

db534ba

go 1.21

812a68e

github-actions bot added the Type: CI label Jul 20, 2024

p0mvn added 7 commits July 20, 2024 17:32

updates

fe6ed0d

test go1.21

cdd9d8c

update lint go

71570b7

go mod for tests

8617a75

more updates

d4313a9

bump linter version

b53ae8d

updates

d7e3b4b

p0mvn commented Jul 21, 2024

View reviewed changes

remove nakedret

9395286

p0mvn marked this pull request as ready for review July 21, 2024 00:15

codeql go version

6667816

PaddyMc approved these changes Jul 22, 2024

View reviewed changes

p0mvn merged commit 5c3a933 into osmo/v0.47.5 Jul 22, 2024
23 checks passed

p0mvn deleted the roman/otel-wiring branch July 22, 2024 18:31

p0mvn added the A:backport/sdk-v50 label Jul 23, 2024

p0mvn restored the roman/otel-wiring branch July 23, 2024 01:09

p0mvn added A:backport/sdk-v50 and removed A:backport/sdk-v50 labels Jul 23, 2024

mergify bot mentioned this pull request Jul 23, 2024

feat: OTEL wiring in grpcserver interceptor (DataDog POC) (backport #612) #619

Merged

p0mvn added a commit that referenced this pull request Jul 23, 2024

OTEL wiring in grpcserver interceptor (DataDog POC) (backport #612)

45fbb72

p0mvn mentioned this pull request Jul 23, 2024

feat: sdk dep bump with datadog gprc interceptor osmosis-labs/osmosis#8534

Merged

mergify bot mentioned this pull request Jul 23, 2024

feat: sdk dep bump with datadog gprc interceptor (backport #8534) osmosis-labs/osmosis#8537

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OTEL wiring in grpcserver interceptor (DataDog POC) #612

OTEL wiring in grpcserver interceptor (DataDog POC) #612

p0mvn commented May 30, 2024 •

edited

Loading

coderabbitai bot commented May 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

p0mvn Jul 20, 2024

p0mvn Jul 21, 2024

p0mvn Jul 21, 2024

OTEL wiring in grpcserver interceptor (DataDog POC) #612

OTEL wiring in grpcserver interceptor (DataDog POC) #612

Conversation

p0mvn commented May 30, 2024 • edited Loading

coderabbitai bot commented May 30, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

p0mvn Jul 20, 2024

Choose a reason for hiding this comment

p0mvn Jul 21, 2024

Choose a reason for hiding this comment

p0mvn Jul 21, 2024

Choose a reason for hiding this comment

p0mvn commented May 30, 2024 •

edited

Loading

coderabbitai bot commented May 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)