feat: add metrics tracers#2319
Merged
surbhigarg92 merged 5 commits intogoogleapis:mainfrom Jun 13, 2025
Merged
Conversation
|
|
||
| private _createMetricInstruments() { | ||
| // This uses the globally registered provider (defaults to Noop provider) | ||
| const meterProvider = MetricsTracerFactory.getMeterProvider(); |
Contributor
There was a problem hiding this comment.
getMeterProvider takes resourceAttributes now ?
Contributor
Author
There was a problem hiding this comment.
Removed the comment, but the intention is that the provider should be instantiated at spanner client creation (right before these metrics instruments are expected to be created), so the call here would just be retrieving it, and thus why the resourceAttributes argument isn't needed here.
- Set Metric location detector to use the one defined in
@google-cloud/opentelemetry-resource-util
- Fixed createResourceAttributes to use previously generated client
UID
surbhigarg92
approved these changes
Jun 13, 2025
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Jul 29, 2025
🤖 I have created a release *beep* *boop* --- ## [8.1.0](https://togithub.com/googleapis/nodejs-spanner/compare/v8.0.0...v8.1.0) (2025-07-28) ### Features * Add Custom OpenTelemetry Exporter in for Service Metrics ([#2272](https://togithub.com/googleapis/nodejs-spanner/issues/2272)) ([610d1b9](https://togithub.com/googleapis/nodejs-spanner/commit/610d1b989ba186c0758791343deaa7f683c4bd26)) * Add methods from gax to cache proto root and process custom error details ([#2330](https://togithub.com/googleapis/nodejs-spanner/issues/2330)) ([1b3931a](https://togithub.com/googleapis/nodejs-spanner/commit/1b3931a799bdd052adc91703e59e1d0c83270065)) * Add metrics tracers ([#2319](https://togithub.com/googleapis/nodejs-spanner/issues/2319)) ([192bf2b](https://togithub.com/googleapis/nodejs-spanner/commit/192bf2bb603bca4ac481fcfd1f04974173adc6a1)) * Add support for AFE latency metrics ([#2348](https://togithub.com/googleapis/nodejs-spanner/issues/2348)) ([0666f05](https://togithub.com/googleapis/nodejs-spanner/commit/0666f05d589e2f229b44dffae8e9649220bccf8b)) * Add throughput_mode to UpdateDatabaseDdlRequest to be used by Spanner Migration Tool. See https://togithub.com/GoogleCloudPlatform/spanner-migration-tool ([#2304](https://togithub.com/googleapis/nodejs-spanner/issues/2304)) ([a29af56](https://togithub.com/googleapis/nodejs-spanner/commit/a29af56ae3c31f07115cb938bcf3f0f77241b725)) * Operation, Attempt, and GFE metrics ([#2328](https://togithub.com/googleapis/nodejs-spanner/issues/2328)) ([646e6ea](https://togithub.com/googleapis/nodejs-spanner/commit/646e6ea6f1dc5fa1937e512ae9e81ae4d2637ed0)) * Proto changes for an internal api ([#2356](https://togithub.com/googleapis/nodejs-spanner/issues/2356)) ([380e770](https://togithub.com/googleapis/nodejs-spanner/commit/380e7705a23a692168db386ba5426c91bf1587b6)) * **spanner:** A new field `snapshot_timestamp` is added to message `.google.spanner.v1.CommitResponse` ([#2350](https://togithub.com/googleapis/nodejs-spanner/issues/2350)) ([0875cd8](https://togithub.com/googleapis/nodejs-spanner/commit/0875cd82e99fa6c95ab38807e09c5921303775f8)) * **spanner:** Add new change_stream.proto ([#2315](https://togithub.com/googleapis/nodejs-spanner/issues/2315)) ([57d67be](https://togithub.com/googleapis/nodejs-spanner/commit/57d67be2e3b6d6ac2a8a903acf8613b27a049c3b)) * **spanner:** Add tpc support ([#2333](https://togithub.com/googleapis/nodejs-spanner/issues/2333)) ([a381cab](https://togithub.com/googleapis/nodejs-spanner/commit/a381cab92c31373a6a10edca0f8a8bdfc4415e4b)) * Track precommit token in r/w apis(multiplexed session) ([#2312](https://togithub.com/googleapis/nodejs-spanner/issues/2312)) ([3676bfa](https://togithub.com/googleapis/nodejs-spanner/commit/3676bfa60725c43f85a04ead87943be92e4a99f0)) ### Bug Fixes * Docs-test ([#2297](https://togithub.com/googleapis/nodejs-spanner/issues/2297)) ([61c571c](https://togithub.com/googleapis/nodejs-spanner/commit/61c571c729c2a065df6ff166db784a6e6eaef74d)) * Ensure context propagation works in Node.js 22 with async/await ([#2326](https://togithub.com/googleapis/nodejs-spanner/issues/2326)) ([e8cdbed](https://togithub.com/googleapis/nodejs-spanner/commit/e8cdbedd55f049b8c7766e97388ed045fedd1b4e)) * Pass the Span correctly ([#2332](https://togithub.com/googleapis/nodejs-spanner/issues/2332)) ([edaee77](https://togithub.com/googleapis/nodejs-spanner/commit/edaee7791b2d814f749ed35119dd705924984a78)) * System test against emulator ([#2339](https://togithub.com/googleapis/nodejs-spanner/issues/2339)) ([2a6af4c](https://togithub.com/googleapis/nodejs-spanner/commit/2a6af4c36484f44929a2fac80d8f225dad5d702c)) * Unhandled exceptions from gax ([#2338](https://togithub.com/googleapis/nodejs-spanner/issues/2338)) ([6428bcd](https://togithub.com/googleapis/nodejs-spanner/commit/6428bcd2980852c1bdbc4c3d0ab210a139e5f193)) ### Performance Improvements * Skip gRPC trailers for StreamingRead & ExecuteStreamingSql ([#2313](https://togithub.com/googleapis/nodejs-spanner/issues/2313)) ([8bd0781](https://togithub.com/googleapis/nodejs-spanner/commit/8bd0781e8b434a421f0e0f3395439a5a86c7847c)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces a metrics factory to the codebase. It's a direct follow-up to the previously merged metrics exporter (see PR #2272). This factory is responsible for creating and managing the specific service metrics that will be instrumented throughout the code in subsequent changes.
This is a re-opening of #2311 with comments addressed, and rebased over main as the PR branch had gotten largely out of sync.
Impact
This change introduces new components but has no immediate impact as the factory is not called at this time.
Testing
Unit tests have been added to verify the correct functionality of the metrics factory and its interaction with the exporter. Additionally, manual verification confirmed that the factory and exporter correctly create and are capable of emitting metrics to Google Cloud Platform (GCP).
This PR introduces no breaking changes.
Additional Information
Future metrics work will involve:
Checklist