CXXCBC-756: Move metric instrumentation points to Public API #872
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR moves metric instrumentation points from the core layer to the Public API layer, standardizing observability handling across the codebase. The changes align metric attributes with OpenTelemetry conventions by renaming the "outcome" field to "error.type" and updating the meter name from "db.couchbase.operations" to "db.client.operation.duration".
Key Changes:
- Introduced a new
observability_recorderabstraction that encapsulates both tracing and metrics recording - Updated metric attribute field names to follow OpenTelemetry conventions
- Moved metric instrumentation from core HTTP/KV command handlers to Public API operation handlers
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| core/impl/observability_recorder.{hxx,cxx} | New abstraction unifying span and metric recording for operations |
| core/metrics/meter_wrapper.cxx | Updated to use new error_type attribute and added db.system.name tag |
| core/metrics/constants.hxx | Added new meter_name constant for standardized metric naming |
| test/test_unit_metrics.cxx | Updated tests to reflect new error.type attribute and db.system.name tag |
| test/test_integration_meter.cxx | Refactored to use Public API instead of core operations for testing |
| core/impl/*.cxx | Migrated from span-only tracking to observability_recorder for unified observability |
| core/io/{mcbp,http}_command.hxx | Wrapped existing core-level metric recording in preprocessor guard |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DemetrisChr
force-pushed
the
metrics
branch
2 times, most recently
from
8d4330d to
5cd8e87
Compare
test/test_integration_tracer.cxx:255:3: note: Same iterator is used with containers 'span->int_tags()' that are temporaries or defined in different scopes.
REQUIRE(span->int_tags().find("couchbase.retries") != span->int_tags().end());
^
test/test_integration_tracer.cxx:342:3: error: Same iterator is used with containers 'span->int_tags()' that are temporaries or defined in different scopes. [iterators3]
REQUIRE(span->int_tags().find("couchbase.retries") != span->int_tags().end());
avsej
approved these changes
Nov 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Operation-level spans are now in the Public API. The corresponding metrics should be moved at the same level, so our implementation is consistent with the RFC and to ensure we are measuring the entire duration of the high-level operation.
Changes
observability_recorderthat wraps the meter and tracer and creates the necessary spans & metrics for a given operation.db.client.operation.durationas per RFC and the Otel semantic conventionsdb.system.nameattribute to metricsoutcometoerror.type. If an error code is not one of the known Couchbase error categories, the value forerror.typeis now_OTHER.couchbase.retriesspan attribute, even if it's 0, as per RFC