GODRIVER-3690 Add ErrorCodesFrom to the mongo package #2241

prestonvasquez · 2025-11-18T01:13:12Z

Summary

Add an ErrorCodes function that can be used to parse server error codes from an arbitrary Go error.

Usage:

func publishMetrics(ctx context.Context, evt *event.CommandFailedEvent) {
	attrs := []attribute.KeyValue{}

	if errCodes := mongo.ErrorCodes(evt.Failure); len(errCodes) > 0 {
		// Record the first error code as a status code attribute.
		attrs = append(attrs, semconv.DBResponseStatusCode(errCodes[0]))
	}

	Record(
		ctx,
		evt.Duration.Seconds(),
		dbconv.SystemNameMongoDB,
		attrs...,
	)
}

Background

Would be convenient to get server status codes without caller taking a dependency on the experimental API. For example, OpenTelemetry needs to include db.response.status.code for otelmongo: open-telemetry/opentelemetry-go-contrib#7983 (comment)

An alternative to this design would be to put Codes on event.CommandFailedEvent. Suggest we forgo this solution for two reasons:

It breaks unkeyed composite literals for event.CommandFailedEvent
There may be non-event cases where users would want to validate for error codes.

Copilot

Pull Request Overview

This PR extends the CommandFailedEvent structure to include error codes, addressing GODRIVER-3690. The change enables users to access error codes directly from command failure events without parsing the error themselves.

Key changes:

Added a Codes field to CommandFailedEvent to expose error codes
Implemented errorCodes() helper function to extract codes from driver errors
Added test coverage for the new field

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
event/monitoring.go	Added `Codes` field to `CommandFailedEvent` structure
x/mongo/driver/operation.go	Populates the new `Codes` field when publishing failed events; removed blank line
x/mongo/driver/errors.go	Implemented `errorCodes()` function to extract error codes from driver errors
mongo/errors.go	Refactored variable declarations to use `var()` block (style change)
internal/integration/clam_prose_test.go	Added test case for `CommandFailedEvent.Codes`; removed blank line

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

x/mongo/driver/errors.go

mongodb-drivers-pr-bot · 2025-11-18T01:18:04Z

🧪 Performance Results

Commit SHA: 4696628

The following benchmark tests for version 6939b57f664aca0007f87dd5 had statistically significant changes (i.e., |z-score| > 1.96):

Benchmark	Measurement	% Change	Patch Value	Stable Region	H-Score	Z-Score
BenchmarkSmallDocInsertOne	ops_per_second_min	-34.6431	986.4190	Avg: 1509.2809 Med: 1558.1348 Stdev: 232.7626	0.7685	-2.2463
BenchmarkMultiInsertSmallDocument	total_mem_allocs	21.0604	2749585.0000	Avg: 2271250.4542 Med: 2240393.0000 Stdev: 118085.9635	0.8744	4.0507
BenchmarkMultiInsertSmallDocument	total_time_seconds	13.3744	1.2021	Avg: 1.0603 Med: 1.0465 Stdev: 0.0460	0.8411	3.0812
BenchmarkMultiInsertSmallDocument	total_bytes_allocated	12.7953	513299504.0000	Avg: 455071541.5385 Med: 451556360.0000 Stdev: 16093521.3853	0.8474	3.6181
BenchmarkMultiInsertSmallDocument	allocated_bytes_per_op	-5.6371	2613.0000	Avg: 2769.0979 Med: 2789.0000 Stdev: 67.6814	0.7771	-2.3064
BenchmarkBSONFlatDocumentDecoding	ops_per_second_max	-2.6065	21461.5302	Avg: 22035.8879 Med: 22057.1480 Stdev: 272.7613	0.7595	-2.1057
BenchmarkSmallDocInsertOne	allocated_bytes_per_op	-0.3134	5671.0000	Avg: 5688.8261 Med: 5688.0000 Stdev: 4.2496	0.8874	-4.1947

For a comprehensive view of all microbenchmark results for this PR's commit, please check out the Evergreen perf task for this patch.

mongodb-drivers-pr-bot · 2025-11-18T01:18:11Z

API Change Report

./v2/mongo

compatible changes

ErrorCodes: added

RafaelCenzano

LGTM

matthewdale · 2025-12-05T03:58:11Z

mongo/errors.go

+	var ec interface{ ErrorCodes() []int }
+	if errors.As(wrapErrors(err), &ec) {
+		return ec.ErrorCodes()


Can users use errors.As to convert the error to a mongo.ServerError and get the same information?

E.g.

var se mongo.ServerError if errors.As(err, &se) { se.ErrorCodes() }

This would only work if mongo.ServerError is in the error tree for the arbitrary error which isn't the case for errors propagated by event monitoring. Here's an example: https://github.com/prestonvasquez/go-playground/blob/01e0e77437bdd9ba0a23d912121e152880dc19e9/mgd_errors_test.go#L17

matthewdale · 2025-12-05T04:00:24Z

mongo/errors.go

 }
+
+// ErrorCodesFrom returns the list of server error codes contained in err.
+func ErrorCodesFrom(err error) []int {


Optional: Consider naming this ErrorCodes, which matches the method name on the error types.

Good idea 👍

qingyang-hu · 2025-12-08T22:25:00Z

mongo/errors.go

+var (
+	_ ServerError = CommandError{}
+	_ ServerError = WriteError{}
+	_ ServerError = WriteException{}
+	_ ServerError = BulkWriteException{}
+)


Do we need to define interface{ ErrorCodes() []int } here and add additional checks that these structs also satisfies the interface? It may prevent ErrorCodes() in ServerError from being modified.

Nice, will update

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

qingyang-hu

LGTM!

…s-with-error-codes

Copilot AI review requested due to automatic review settings November 18, 2025 01:13

prestonvasquez requested a review from a team as a code owner November 18, 2025 01:13

prestonvasquez requested a review from qingyang-hu November 18, 2025 01:13

prestonvasquez marked this pull request as draft November 18, 2025 01:13

prestonvasquez removed the request for review from qingyang-hu November 18, 2025 01:13

Copilot AI reviewed Nov 18, 2025

View reviewed changes

x/mongo/driver/errors.go Outdated Show resolved Hide resolved

prestonvasquez force-pushed the feature/godriver-3690-extend-event-failures-with-error-codes branch 2 times, most recently from 3b7f589 to 63d4781 Compare December 3, 2025 00:20

Expose server error codes via mongo package

58198cf

prestonvasquez force-pushed the feature/godriver-3690-extend-event-failures-with-error-codes branch from 63d4781 to 58198cf Compare December 3, 2025 00:23

prestonvasquez added review-priority-normal Medium Priority PR for Review: within 1 business day feature labels Dec 3, 2025

prestonvasquez changed the title ~~(POC) GODRIVER-3690 Extend CommandFailedEvent with error codes~~ GODRIVER-3690 Add ErrorCodesFrom to the mongo package Dec 3, 2025

prestonvasquez marked this pull request as ready for review December 3, 2025 00:41

prestonvasquez requested a review from qingyang-hu December 3, 2025 00:42

RafaelCenzano previously approved these changes Dec 4, 2025

View reviewed changes

matthewdale reviewed Dec 5, 2025

View reviewed changes

Rename ErrorCodesFrom to ErrorCodes to match error interface function

03fda7a

prestonvasquez dismissed RafaelCenzano’s stale review via 03fda7a December 5, 2025 22:33

prestonvasquez requested review from RafaelCenzano and matthewdale December 5, 2025 22:33

RafaelCenzano previously approved these changes Dec 8, 2025

View reviewed changes

qingyang-hu reviewed Dec 8, 2025

View reviewed changes

Add errorCoder compile check for mongo.ServerError

f498a53

prestonvasquez dismissed RafaelCenzano’s stale review via f498a53 December 9, 2025 04:49

prestonvasquez requested review from RafaelCenzano, Copilot and qingyang-hu December 9, 2025 04:49

Copilot AI reviewed Dec 9, 2025

View reviewed changes

qingyang-hu approved these changes Dec 9, 2025

View reviewed changes

RafaelCenzano approved these changes Dec 10, 2025

View reviewed changes

Merge branch 'master' into feature/godriver-3690-extend-event-failure…

4696628

…s-with-error-codes

GODRIVER-3690 Add ErrorCodesFrom to the mongo package #2241

Are you sure you want to change the base?

GODRIVER-3690 Add ErrorCodesFrom to the mongo package #2241

Conversation

prestonvasquez commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Background

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Performance Results

Uh oh!

mongodb-drivers-pr-bot bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Report

./v2/mongo

compatible changes

Uh oh!

RafaelCenzano left a comment

Choose a reason for hiding this comment

Uh oh!

matthewdale Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

prestonvasquez Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthewdale Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

prestonvasquez Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

qingyang-hu Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

prestonvasquez Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

qingyang-hu left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

prestonvasquez commented Nov 18, 2025 •

edited

Loading

mongodb-drivers-pr-bot bot commented Nov 18, 2025 •

edited

Loading

mongodb-drivers-pr-bot bot commented Nov 18, 2025 •

edited

Loading

prestonvasquez Dec 5, 2025 •

edited

Loading