feat(otelgin): enhance gin error tracking with span recording #6346

flc1125 · 2024-11-19T16:10:22Z

No description provided.

dmathieu · 2024-11-20T08:30:38Z

Could you test this change?
By checking there's indeed an error here for example: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go#L123

Also, I wonder if we need to keep the gin.errors attribute. While removing it is a breaking change, keeping it is redundant.

dmathieu · 2024-11-20T08:31:12Z

Side note that otelgin has no owner, so it may be removed soon.
#6190

flc1125 · 2024-11-20T09:26:57Z

Side note that otelgin has no owner, so it may be removed soon. #6190

Okay, will this package still accept new PRs at present?

dmathieu · 2024-11-20T09:42:57Z

It does.

codecov · 2024-11-20T09:45:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.9%. Comparing base (73c4165) to head (1fa4d17).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #6346   +/-   ##
=====================================
  Coverage   66.9%   66.9%           
=====================================
  Files        193     193           
  Lines      15652   15653    +1     
=====================================
+ Hits       10479   10480    +1     
  Misses      4882    4882           
  Partials     291     291

Files with missing lines	Coverage Δ
...ation/github.com/gin-gonic/gin/otelgin/gintrace.go	`84.2% <100.0%> (+0.1%)`	⬆️

---- 🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

flc1125 · 2024-11-20T09:52:03Z

#6190

I think I can give it a try.

If I come to maintain it, what do I need to do?

dmathieu · 2024-11-20T10:01:18Z

That's documented in the issue, as well as in https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/CONTRIBUTING.md#code-owners.

CHANGELOG.md

Co-authored-by: Damien Mathieu <[email protected]>

flc1125 · 2024-11-21T09:29:19Z

Could you test this change? By checking there's indeed an error here for example: main/instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go#L123

Also, I wonder if we need to keep the gin.errors attribute. While removing it is a breaking change, keeping it is redundant.

It's done.

flc1125 · 2024-11-21T09:30:49Z

Side note that otelgin has no owner, so it may be removed soon.

I spent some time reading through the requirements. I understand that I may still need to make some contributions before applying. If so, I need some time.

.golangci.yml

flc1125 · 2024-11-21T12:03:44Z

link: #5252

Changes made

dmathieu

This is starting to look good 😸

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go

Co-authored-by: Damien Mathieu <[email protected]>

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

pellared

Just nit comments. Can you please address them before we merge?

pellared · 2024-11-25T08:01:54Z

CHANGELOG.md

@@ -13,6 +13,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Added support for providing `endpoint`, `pollingIntervalMs` and `initialSamplingRate` using environment variable `OTEL_TRACES_SAMPLER_ARG` in `go.opentelemetry.io/contrib/samples/jaegerremote`. (#6310)
 - Added support exporting logs via OTLP over gRPC in `go.opentelemetry.io/contrib/config`. (#6340)

+### Changed
+
+- Record an error instead of setting the `gin.errors` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#6346)


Suggested change

- Record an error instead of setting the `gin.errors` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#6346)

- Record errors instead of setting the `gin.errors` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#6346)

pellared · 2024-11-25T08:02:23Z

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/propagation"
 	semconv "go.opentelemetry.io/otel/semconv/v1.20.0"
 	oteltrace "go.opentelemetry.io/otel/trace"
+
+	"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin/internal/semconvutil"


Can you revert this import rearrange change? We are grouping go.openteletry.io. See

opentelemetry-go-contrib/.golangci.yml

Lines 108 to 109 in 96b1ed1

goimports:

local-prefixes: go.opentelemetry.io

pellared · 2024-11-25T08:02:29Z

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go

 	oteltrace "go.opentelemetry.io/otel/trace"
+
+	"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"


Can you revert this import rearrange change? We are grouping go.openteletry.io. See

opentelemetry-go-contrib/.golangci.yml

Lines 108 to 109 in 96b1ed1

goimports:

local-prefixes: go.opentelemetry.io

pellared · 2024-11-25T08:03:42Z

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go

@@ -120,7 +122,17 @@ func TestError(t *testing.T) {
 	attr := span.Attributes()
 	assert.Contains(t, attr, attribute.String("net.host.name", "foobar"))
 	assert.Contains(t, attr, attribute.Int("http.status_code", http.StatusInternalServerError))
-	assert.Contains(t, attr, attribute.String("gin.errors", "Error #01: oh no\n"))
+
+	// verify the error event


Suggested change

// verify the error event

// verify the error events

feat(otelgin): enhance gin error tracking with span recording

60f2e0c

flc1125 requested a review from a team as a code owner November 19, 2024 16:10

Merge branch 'main' into gintrace-recorderror

afe0635

flc1125 added 2 commits November 20, 2024 22:39

feat(otelgin): enhance gin error tracking with span recording

7817837

feat(otelgin): enhance gin error tracking with span recording

dcc6c62

dmathieu reviewed Nov 20, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

flc1125 and others added 5 commits November 21, 2024 00:19

Update CHANGELOG.md

f5d9a1c

Co-authored-by: Damien Mathieu <[email protected]>

test(otelgin): Add tests for span recording on errors

84f2f0e

refactor(otelgin): Remove unused dependencies and simplify tests

e5ef74d

refactor(otelgin): Remove unused dependencies and simplify tests

9cdd7d6

Merge branch 'main' into gintrace-recorderror

9b368d5

dmathieu previously requested changes Nov 21, 2024

View reviewed changes

.golangci.yml Outdated Show resolved Hide resolved

test(instrumentation): remove gin.errors assertion in gintrace_test.go

cc1c612

flc1125 requested a review from dmathieu November 21, 2024 14:14

dmathieu reviewed Nov 21, 2024

View reviewed changes

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go Outdated Show resolved Hide resolved

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go Show resolved Hide resolved

flc1125 and others added 3 commits November 21, 2024 22:36

Update instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

fc2dd22

Co-authored-by: Damien Mathieu <[email protected]>

feat(otelgin): refine gin trace error handling and test cases

488835c

feat(otelgin): refine gin trace error handling and test cases

92ff337

flc1125 requested a review from dmathieu November 21, 2024 15:13

dmathieu reviewed Nov 21, 2024

View reviewed changes

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go Outdated Show resolved Hide resolved

test(otelgin): remove redundant code

23949c7

dmathieu approved these changes Nov 21, 2024

View reviewed changes

pellared reviewed Nov 22, 2024

View reviewed changes

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go Outdated Show resolved Hide resolved

flc1125 added 2 commits November 24, 2024 00:20

chore(otelgin): refine error recording in gintrace

5f403b8

Merge branch 'main' into gintrace-recorderror

1fa4d17

pellared approved these changes Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(otelgin): enhance gin error tracking with span recording #6346

feat(otelgin): enhance gin error tracking with span recording #6346

flc1125 commented Nov 19, 2024

dmathieu commented Nov 20, 2024

dmathieu commented Nov 20, 2024

flc1125 commented Nov 20, 2024

dmathieu commented Nov 20, 2024

codecov bot commented Nov 20, 2024 •

edited

Loading

flc1125 commented Nov 20, 2024 •

edited

Loading

dmathieu commented Nov 20, 2024

flc1125 commented Nov 21, 2024

flc1125 commented Nov 21, 2024

flc1125 commented Nov 21, 2024 •

edited

Loading

dmathieu left a comment

pellared left a comment

pellared Nov 25, 2024

pellared Nov 25, 2024

pellared Nov 25, 2024

pellared Nov 25, 2024

	- Record an error instead of setting the `gin.errors` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#6346)
	- Record errors instead of setting the `gin.errors` attribute in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#6346)

		oteltrace "go.opentelemetry.io/otel/trace"

		"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"

feat(otelgin): enhance gin error tracking with span recording #6346

Are you sure you want to change the base?

feat(otelgin): enhance gin error tracking with span recording #6346

Conversation

flc1125 commented Nov 19, 2024

dmathieu commented Nov 20, 2024

dmathieu commented Nov 20, 2024

flc1125 commented Nov 20, 2024

dmathieu commented Nov 20, 2024

codecov bot commented Nov 20, 2024 • edited Loading

Codecov Report

flc1125 commented Nov 20, 2024 • edited Loading

dmathieu commented Nov 20, 2024

flc1125 commented Nov 21, 2024

flc1125 commented Nov 21, 2024

flc1125 commented Nov 21, 2024 • edited Loading

dmathieu left a comment

Choose a reason for hiding this comment

pellared left a comment

Choose a reason for hiding this comment

pellared Nov 25, 2024

Choose a reason for hiding this comment

pellared Nov 25, 2024

Choose a reason for hiding this comment

pellared Nov 25, 2024

Choose a reason for hiding this comment

pellared Nov 25, 2024

Choose a reason for hiding this comment

codecov bot commented Nov 20, 2024 •

edited

Loading

flc1125 commented Nov 20, 2024 •

edited

Loading

flc1125 commented Nov 21, 2024 •

edited

Loading