feat: adding instrumentation support for mongo-driver/v2 #6539

AlaricWhitney · 2024-12-28T17:52:25Z

Adding the mongo-driver/v2 instrumentation.

This is a copy/paste of the v1 instrumentation, and was modified to adhere to the mongo-driver/v2 requirements.

Notable differences:

mtest was removed in v2. Replaced with drivertest in the unit testing.

This addresses PR #6419

linux-foundation-easycla · 2024-12-28T17:52:32Z

The committers listed above are authorized under a signed CLA.

✅ login: AlaricWhitney / name: Alaric Whitney (a0f083b, 9590887, 71da688, 6d22da1, f83a9ab, b3cbb84, 95dcf65, 37c8729, 24b5f1e, d38d115, 8e90ad0, bd3c9c5, 407eea4, 0403896, f6ec856, e97fcde, 4e44c3e)

codecov · 2025-01-07T11:00:17Z

Codecov Report

Attention: Patch coverage is 83.73984% with 20 lines in your changes missing coverage. Please review.

Project coverage is 75.5%. Comparing base (2719357) to head (407eea4).

Files with missing lines	Patch %	Lines
...ngodb.org/mongo-driver/v2/mongo/otelmongo/mongo.go	80.2%	13 Missing and 5 partials ⚠️
...rg/mongo-driver/v2/mongo/otelmongo/test/version.go	60.0%	2 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##            main   #6539    +/-   ##
======================================
  Coverage   75.5%   75.5%            
======================================
  Files        206     210     +4     
  Lines      19181   19304   +123     
======================================
+ Hits       14484   14593   +109     
- Misses      4259    4270    +11     
- Partials     438     441     +3

Files with missing lines	Coverage Δ
...godb.org/mongo-driver/v2/mongo/otelmongo/config.go	`100.0% <100.0%> (ø)`
...odb.org/mongo-driver/v2/mongo/otelmongo/version.go	`100.0% <100.0%> (ø)`
...rg/mongo-driver/v2/mongo/otelmongo/test/version.go	`60.0% <60.0%> (ø)`
...ngodb.org/mongo-driver/v2/mongo/otelmongo/mongo.go	`80.2% <80.2%> (ø)`

... and 1 file with indirect coverage changes

dmathieu · 2025-01-14T08:09:46Z

cc @prestonvasquez for review?

prestonvasquez

@AlaricWhitney Thank you for putting this together. I wanted to let you know that I'll be reviewing this in stages, as my schedule allows.

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/doc.go

prestonvasquez · 2025-01-14T15:58:40Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/doc.go

+// This code was originally based on the following:
+// - https://github.com/DataDog/dd-trace-go/tree/02f0449efa3cb382d499fadc873957385dcb2192/contrib/go.mongodb.org/mongo-driver/mongo
+// - https://github.com/DataDog/dd-trace-go/tree/v1.23.3/ddtrace/ext


We should update this to note that the code was copied from a specific instance of the v1 instrumentation.

I've updated it to reference the commit version that it was based on.

prestonvasquez · 2025-01-22T01:58:54Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/version.go

+// SemVersion is the semantic version to be supplied to tracer/meter creation.
+//
+// Deprecated: Use [Version] instead.
+func SemVersion() string {


@dmathieu Can this be excluded in v2?

Sure, this is a new package. We shouldn't introduce methods that are already deprecated.

Sounds good. I'll remove it.

prestonvasquez · 2025-01-22T01:59:02Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/version.go

+package otelmongo // import "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo"
+
+// Version is the current release version of the mongo-driver instrumentation.
+func Version() string {


This should probably start at 0.1.0 per SEMVAR: semver.org#how-should-i-deal-with-revisions-in-the-0yz-initial-development-phase

@dmathieu Unless there is an open telemetry-specific requirement? This also mentions something about being updated by the pre_releash.sh script during release. Where does that script live? Does it need to include v2/mongo/otelmongo? Should this file be excluded altogether, i.e. does the script generate the entire file?

Versions are specified here: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/versions.yaml
We have commonly not started at 0.1.0 for new instrumentations, but at the version where we're currently at.

The release procedure is detailed here: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/RELEASING.md
The pre_release script has been moved to a make command.

I can update the version to 0.60.0, and let the the pre_release script update it to the correct value if I'm understanding the process correctly.

prestonvasquez · 2025-01-22T02:01:20Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/version_test.go

+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package test_test


Suggest removing this file along with the test. If it gets autogenerated as part of pre-release automation, so bet it.

Great! I'll remove the test.

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/doc.go

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/version.go

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/version.go

jakenmbe · 2025-01-30T03:41:52Z

can this pr merge? I need use it in my project

dmathieu · 2025-01-30T08:26:07Z

Not until all review comments have been closed an it has been approved.

…/doc.go Co-authored-by: Preston Vasquez <[email protected]>

…/test/doc.go Co-authored-by: Preston Vasquez <[email protected]>

…/test/version.go Co-authored-by: Damien Mathieu <[email protected]>

…/version.go Co-authored-by: Preston Vasquez <[email protected]>

…tation for go.mongodb.org/mongo-driver/v2

AlaricWhitney · 2025-02-20T16:29:35Z

@prestonvasquez @dmathieu This should be ready for review.

dmathieu

Could you add this new package to the CODEOWNERS file too?

This looks good. I don't have the required mongo knowledge to assert proper behavior though, so I'll let @prestonvasquez weigh on that.

dmathieu · 2025-02-21T08:31:24Z

CHANGELOG.md

@@ -13,6 +13,7 @@ The next release will require at least [Go 1.23].

 ### Added

+- Add instrumentation support for `go.mongodb.org/mongo-driver/v2` in `go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo`(#6539)


Could you move this entry to be last in the section?

dmathieu · 2025-02-21T08:33:44Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/mongo.go

+
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/codes"
+	semconv "go.opentelemetry.io/otel/semconv/v1.21.0"


Since this is a new package, we should rely on the latest semantic conventions (1.30.0) right away, let's not make things harder by forcing a migration right away :)

dmathieu · 2025-02-21T08:35:27Z

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/doc.go

+/*
+Package test validates the otelmongo V2 instrumentation with the default SDK.
+
+This package is in a separate module from the instrumentation it tests to


Having this in a test subpackage shouldn't be required anymore, and we're in the process of removing that folder for every instrumentation.
Since this is a new one, could we avoid creating it altogether?

See #6763 as similar work for otelhttp.

feat: adding instrumentation support for mongo-driver/v2

95dcf65

AlaricWhitney requested a review from a team as a code owner December 28, 2024 17:52

AlaricWhitney mentioned this pull request Dec 28, 2024

Add go.mongodb.org/mongo-driver/v2 specific instrumentation #6419

Open

Update LInting

24b5f1e

prestonvasquez suggested changes Jan 14, 2025

View reviewed changes

dmathieu mentioned this pull request Jan 21, 2025

mongo v2 is not supported, can it be supported as soon as possible? #6654

Closed

prestonvasquez suggested changes Jan 22, 2025

View reviewed changes

prestonvasquez reviewed Jan 22, 2025

View reviewed changes

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/doc.go Outdated Show resolved Hide resolved

prestonvasquez reviewed Jan 22, 2025

View reviewed changes

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/version.go Outdated Show resolved Hide resolved

dmathieu reviewed Jan 22, 2025

View reviewed changes

instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo/test/version.go Outdated Show resolved Hide resolved

AlaricWhitney and others added 15 commits February 14, 2025 20:24

Update instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo…

b3cbb84

…/doc.go Co-authored-by: Preston Vasquez <[email protected]>

Update instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo…

a0f083b

…/doc.go Co-authored-by: Preston Vasquez <[email protected]>

Update instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo…

f83a9ab

…/test/doc.go Co-authored-by: Preston Vasquez <[email protected]>

Update instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo…

8e90ad0

…/test/version.go Co-authored-by: Damien Mathieu <[email protected]>

Update instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo…

9590887

…/version.go Co-authored-by: Preston Vasquez <[email protected]>

Merge branch 'main' into main

71da688

chore: Updating version

6d22da1

chore: removing version unit test

37c8729

Update code reference source

4e44c3e

Merge branch 'main' into main

f6ec856

lint: fix extra empty comment line

d38d115

Merge branch 'main' into main

0403896

fix: fixed lint issue

e97fcde

feat: adding changelog entry for open-telemetry#6539 adding instrumen…

bd3c9c5

…tation for go.mongodb.org/mongo-driver/v2

Merge branch 'main' into main

407eea4

AlaricWhitney requested review from dmathieu and prestonvasquez February 20, 2025 16:28

dmathieu reviewed Feb 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding instrumentation support for mongo-driver/v2 #6539

feat: adding instrumentation support for mongo-driver/v2 #6539

AlaricWhitney commented Dec 28, 2024

linux-foundation-easycla bot commented Dec 28, 2024 •

edited

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

dmathieu commented Jan 14, 2025

prestonvasquez left a comment

prestonvasquez Jan 14, 2025

AlaricWhitney Feb 15, 2025

prestonvasquez Jan 22, 2025

dmathieu Jan 22, 2025

AlaricWhitney Feb 15, 2025

prestonvasquez Jan 22, 2025 •

edited

Loading

dmathieu Jan 22, 2025

dmathieu Jan 22, 2025

AlaricWhitney Feb 15, 2025

prestonvasquez Jan 22, 2025 •

edited

Loading

AlaricWhitney Feb 15, 2025

jakenmbe commented Jan 30, 2025

dmathieu commented Jan 30, 2025

AlaricWhitney commented Feb 20, 2025

dmathieu left a comment

dmathieu Feb 21, 2025

dmathieu Feb 21, 2025

dmathieu Feb 21, 2025

		@@ -13,6 +13,7 @@ The next release will require at least [Go 1.23].

		### Added

		- Add instrumentation support for `go.mongodb.org/mongo-driver/v2` in `go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver/v2/mongo/otelmongo`(#6539)

feat: adding instrumentation support for mongo-driver/v2 #6539

Are you sure you want to change the base?

feat: adding instrumentation support for mongo-driver/v2 #6539

Conversation

AlaricWhitney commented Dec 28, 2024

linux-foundation-easycla bot commented Dec 28, 2024 • edited Loading

codecov bot commented Jan 7, 2025 • edited Loading

Codecov Report

dmathieu commented Jan 14, 2025

prestonvasquez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prestonvasquez Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prestonvasquez Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakenmbe commented Jan 30, 2025

dmathieu commented Jan 30, 2025

AlaricWhitney commented Feb 20, 2025

dmathieu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Dec 28, 2024 •

edited

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

prestonvasquez Jan 22, 2025 •

edited

Loading

prestonvasquez Jan 22, 2025 •

edited

Loading