chore(spanner): add support of client side native metrics collection and export #10419

rahul2393 · 2024-06-24T06:45:05Z

This PR adds built-in metrics to the Go spanner client library. This will introduce below metrics for the consumers of this library .

This feature is not currently available for customers to use. Once GA'ed consumers of this library will start getting these metrics in the MetricsExplorer

Attempt Latency The latency of an RPC attempt. Useful for monitoring the general health of the applicationWith attributes like “Token Expiry”, “Status” etc, this metric can help us troubleshoot a wide range of issues.

Attempt Count The count of RPC attempts Useful for monitoring trafficUseful for deriving “Error Rate” with status attributes

Operation Latency The total end-to-end latency across all request attempts, including retries. Useful for monitoring the general health of the applicationThe combination of this metric and Attempt Latency can help us troubleshoot connectivity issues.

Operation Count The count of operations Useful for monitoring trafficUseful for deriving “Error Rate” with status labelThe combination of this metric and Attempt Count can be used for deriving Retry Count

odeke-em

Please separate non-standard library imports from standard library imports.

odeke-em · 2024-08-21T17:03:52Z

spanner/apiv1/spanner_client_options.go

+import (
+	"cloud.google.com/go/spanner"
+	"context"
+	"github.com/googleapis/gax-go/v2"
+	"google.golang.org/api/option"
+)


Stylistically in Go, please separate standard library imports from other imports so

import ( "context" "cloud.google.com/go/spanner" "github.com/googleapis/gax-go/v2" "google.golang.org/api/option" )

odeke-em · 2024-08-21T17:18:58Z

spanner/metrics.go

+	"github.com/google/uuid"
+	"github.com/googleapis/gax-go/v2"
+	"go.opentelemetry.io/otel/metric/noop"


Please move these downloads out of the standard library imports block.

odeke-em · 2024-08-21T17:19:09Z

spanner/metrics.go

+package spanner
+
+import (
+	"cloud.google.com/go/spanner/internal"


This too, please move down.

rahul2393 · 2024-08-22T21:22:17Z

@igorbernstein2 @codyoss
Can you please help providing review here.

Note: PR message is chore intentionally since we want this feature disabled(will be done in next commit here) but other things can be reviewed.

HailongWen · 2024-08-22T21:53:47Z

spanner/metrics.go

+
+	clientName = fmt.Sprintf("go-spanner v%v", internal.Version)
+
+	bucketBounds = []float64{0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 8.0, 10.0, 13.0, 16.0, 20.0, 25.0, 30.0, 40.0,


See internal discussion - please sync with Surbhi on the default buckets we use.

Took reference from Java PR https://github.com/googleapis/java-spanner/pull/3125/files#diff-be4eb8b7d32f038815df792bedaf4b93ee596806ed2aeaccec8afbcf89b2f342R100-R103

cc: @surbhigarg92

rahul2393 · 2024-08-23T05:01:55Z

[Update]
Integration tests passed: http://sponge2/3febe9d1-660f-4743-a310-69195e7ccbc5

zchee

@rahul2393 I'm not a Googler, so sorry for my external review.
I made a few comments about the code style, but it nits.

spanner/client.go

hengfengli

LGTM.

…lable before Send

# Conflicts: # spanner/go.mod # spanner/test/opentelemetry/test/go.mod

rahul2393 requested review from a team as code owners June 24, 2024 06:45

product-auto-label bot added the api: spanner Issues related to the Spanner API. label Jun 24, 2024

rahul2393 marked this pull request as draft June 24, 2024 06:45

rahul2393 force-pushed the client_side_metrics branch 2 times, most recently from 26dc986 to faf5cdb Compare June 25, 2024 05:30

googleapis deleted a comment from conventional-commit-lint-gcf bot Jun 25, 2024

rahul2393 force-pushed the client_side_metrics branch 2 times, most recently from 765633c to ee86524 Compare June 25, 2024 06:09

github-actions bot added the breaking change label Jun 25, 2024

rahul2393 force-pushed the client_side_metrics branch 2 times, most recently from 2d2b5a6 to 23ca77a Compare August 16, 2024 11:52

rahul2393 marked this pull request as ready for review August 16, 2024 11:53

rahul2393 force-pushed the client_side_metrics branch 2 times, most recently from c507ea3 to 7ba036f Compare August 22, 2024 20:51

odeke-em suggested changes Aug 22, 2024

View reviewed changes

rahul2393 force-pushed the client_side_metrics branch 5 times, most recently from 95db2af to 1affbec Compare August 22, 2024 21:17

rahul2393 requested review from codyoss and igorbernstein2 August 22, 2024 21:20

rahul2393 force-pushed the client_side_metrics branch from 1affbec to fae02f9 Compare August 22, 2024 21:28

HailongWen reviewed Aug 22, 2024

View reviewed changes

rahul2393 requested a review from odeke-em August 23, 2024 03:39

rahul2393 requested review from harshachinta and removed request for odeke-em August 23, 2024 05:02

rahul2393 requested a review from odeke-em September 2, 2024 12:14

rahul2393 force-pushed the client_side_metrics branch from 93fa217 to d6e2f11 Compare September 2, 2024 20:49

fix header

8f3dbc3

rahul2393 force-pushed the client_side_metrics branch from d6e2f11 to 8f3dbc3 Compare September 2, 2024 21:20

fix tests

4b050ea

zchee reviewed Sep 2, 2024

View reviewed changes

spanner/client.go Outdated Show resolved Hide resolved

spanner/client.go Show resolved Hide resolved

hengfengli approved these changes Sep 3, 2024

View reviewed changes

rahul2393 added 2 commits September 4, 2024 11:45

return wrappedStream from stream interceptor to fix peerInfo not avai…

cbafe39

…lable before Send

fix tests

9d8ee5e

rahul2393 force-pushed the client_side_metrics branch from 020802d to 9d8ee5e Compare September 4, 2024 07:20

fix tests

da6b8ce

rahul2393 force-pushed the client_side_metrics branch from 7d37c41 to da6b8ce Compare September 4, 2024 07:35

skip holding client connection on wrapper

1dceb29

rahul2393 force-pushed the client_side_metrics branch from fa026aa to 1dceb29 Compare September 4, 2024 09:47

rahul2393 and others added 7 commits September 4, 2024 15:26

Merge branch 'main' into client_side_metrics

de67be7

Merge branch 'main' into client_side_metrics

956a510

Merge remote-tracking branch 'origin' into client_side_metrics

a7cf8eb

# Conflicts: # spanner/go.mod # spanner/test/opentelemetry/test/go.mod

do not emil metrics if env is not set

d432e67

fix tests

5a61105

mark env to enable native metrics as experimental

cba2d24

Merge branch 'main' into client_side_metrics

cd61438

rahul2393 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 24, 2024

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Sep 24, 2024

rahul2393 and others added 3 commits September 25, 2024 15:28

add resource label client_hash and updated export duration to 1 minutes

78cd730

fix tests

8d9db29

Merge branch 'main' into client_side_metrics

a988837

rahul2393 merged commit 6fbd687 into main Sep 25, 2024
13 checks passed

rahul2393 deleted the client_side_metrics branch September 25, 2024 10:43

rahul2393 mentioned this pull request Oct 16, 2024

feat(spanner): client built in metrics #10998

Merged

apstndb mentioned this pull request Nov 4, 2024

spanner: panic on native metrics #11080

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(spanner): add support of client side native metrics collection and export #10419

chore(spanner): add support of client side native metrics collection and export #10419

rahul2393 commented Jun 24, 2024 •

edited

Loading

odeke-em left a comment

odeke-em Aug 21, 2024

odeke-em Aug 21, 2024

odeke-em Aug 21, 2024

rahul2393 commented Aug 22, 2024 •

edited

Loading

HailongWen Aug 22, 2024

rahul2393 Aug 23, 2024

rahul2393 commented Aug 23, 2024 •

edited

Loading

zchee left a comment •

edited

Loading

hengfengli left a comment

Attempt Latency	The latency of an RPC attempt.	Useful for monitoring the general health of the applicationWith attributes like “Token Expiry”, “Status” etc, this metric can help us troubleshoot a wide range of issues.
Attempt Count	The count of RPC attempts	Useful for monitoring trafficUseful for deriving “Error Rate” with status attributes
Operation Latency	The total end-to-end latency across all request attempts, including retries.	Useful for monitoring the general health of the applicationThe combination of this metric and Attempt Latency can help us troubleshoot connectivity issues.
Operation Count	The count of operations	Useful for monitoring trafficUseful for deriving “Error Rate” with status labelThe combination of this metric and Attempt Count can be used for deriving Retry Count


		clientName = fmt.Sprintf("go-spanner v%v", internal.Version)

		bucketBounds = []float64{0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 8.0, 10.0, 13.0, 16.0, 20.0, 25.0, 30.0, 40.0,

chore(spanner): add support of client side native metrics collection and export #10419

chore(spanner): add support of client side native metrics collection and export #10419

Conversation

rahul2393 commented Jun 24, 2024 • edited Loading

odeke-em left a comment

Choose a reason for hiding this comment

odeke-em Aug 21, 2024

Choose a reason for hiding this comment

odeke-em Aug 21, 2024

Choose a reason for hiding this comment

odeke-em Aug 21, 2024

Choose a reason for hiding this comment

rahul2393 commented Aug 22, 2024 • edited Loading

HailongWen Aug 22, 2024

Choose a reason for hiding this comment

rahul2393 Aug 23, 2024

Choose a reason for hiding this comment

rahul2393 commented Aug 23, 2024 • edited Loading

zchee left a comment • edited Loading

Choose a reason for hiding this comment

hengfengli left a comment

Choose a reason for hiding this comment

rahul2393 commented Jun 24, 2024 •

edited

Loading

rahul2393 commented Aug 22, 2024 •

edited

Loading

rahul2393 commented Aug 23, 2024 •

edited

Loading

zchee left a comment •

edited

Loading