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 (95dcf65, 24b5f1e)

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

Codecov Report

Attention: Patch coverage is 82.40000% with 22 lines in your changes missing coverage. Please review.

Project coverage is 68.6%. Comparing base (00786cc) to head (24b5f1e).
Report is 52 commits behind head on main.

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 ⚠️
...odb.org/mongo-driver/v2/mongo/otelmongo/version.go	60.0%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #6539     +/-   ##
=======================================
+ Coverage   68.5%   68.6%   +0.1%     
=======================================
  Files        200     204      +4     
  Lines      16768   16906    +138     
=======================================
+ Hits       11490   11606    +116     
- Misses      4933    4950     +17     
- Partials     345     350      +5

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

... and 3 files 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.

prestonvasquez · 2025-01-14T15:55:17Z

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

+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Package otelmongo instruments go.mongodb.org/mongo-driver/mongo.


Suggested change

// Package otelmongo instruments go.mongodb.org/mongo-driver/mongo.

// Package otelmongo instruments go.mongodb.org/mongo-driver/v2/mongo.

prestonvasquez · 2025-01-14T15:57:15Z

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

+// This package is compatible with v0.2.0 of
+// go.mongodb.org/mongo-driver/mongo.


Suggested change

// This package is compatible with v0.2.0 of

// go.mongodb.org/mongo-driver/mongo.

MongoDB's Go Driver has a major version compatibility guarantee, so this information is necessary for v2.

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.

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.

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.

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.

prestonvasquez · 2025-01-22T02:06:53Z

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

+// SPDX-License-Identifier: Apache-2.0
+
+/*
+Package test validates the otelmongo instrumentation with the default SDK.


Suggested change

Package test validates the otelmongo instrumentation with the default SDK.

Package test validates the otelmongo V2 instrumentation with the default SDK.

prestonvasquez · 2025-01-22T02:07:40Z

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.


Suggested change

// Version is the current release version of the mongo-driver instrumentation.

// Version is the current release version of the mongo-go-driver V2 instrumentation.

dmathieu · 2025-01-22T08:17:42Z

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

+
+// Version is the current release version of the mongo-driver instrumentation test module.
+func Version() string {
+	return "0.58.0"


Suggested change

return "0.58.0"

return "0.60.0"

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

dmathieu reviewed Jan 22, 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

prestonvasquez Jan 14, 2025

prestonvasquez Jan 14, 2025

prestonvasquez Jan 22, 2025

dmathieu Jan 22, 2025

prestonvasquez Jan 22, 2025 •

edited

Loading

dmathieu Jan 22, 2025

dmathieu Jan 22, 2025

prestonvasquez Jan 22, 2025 •

edited

Loading

prestonvasquez Jan 22, 2025

prestonvasquez Jan 22, 2025

dmathieu Jan 22, 2025

	// Package otelmongo instruments go.mongodb.org/mongo-driver/mongo.
	// Package otelmongo instruments go.mongodb.org/mongo-driver/v2/mongo.

		// This package is compatible with v0.2.0 of
		// go.mongodb.org/mongo-driver/mongo.

	Package test validates the otelmongo instrumentation with the default SDK.
	Package test validates the otelmongo V2 instrumentation with the default SDK.


		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.

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

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

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