Skip to content

fix(metrics): correct GFE metrics extraction and enable by default #17561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sinhasubham wants to merge 6 commits into
base: main
Choose a base branch
from
+919 −69
Open

fix(metrics): correct GFE metrics extraction and enable by default #17561

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bc4ca60
fix(metrics): correct GFE metrics extraction and enable by default
sinhasubham Jun 24, 2026
ee696db
feat(metrics): add AFE latency metrics and simplify metadata extraction
sinhasubham Jul 14, 2026
30e3122
fix(spanner): align GFE/AFE metric names and instruments with backend…
sinhasubham Jul 20, 2026
d938f30
feat(metrics): add support for AFE server timings
sinhasubham Jul 23, 2026
df80428
fix(metrics): fix OpenTelemetry resource detector import path
sinhasubham Jul 23, 2026
3f91b5f
fix(metrics): remove obsolete gfe_enabled flag and refine AFE timing …
sinhasubham Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/google-cloud-spanner/google/cloud/spanner_v1/metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Custom Metric Exporter
# Custom Metric Exporter
The custom metric exporter, as defined in [metrics_exporter.py](./metrics_exporter.py), is designed to work in conjunction with OpenTelemetry and the Spanner client. It converts data into its protobuf equivalent and sends it to Google Cloud Monitoring.

## Filtering Criteria
Expand All @@ -10,8 +10,10 @@ The exporter filters metrics based on the following conditions, utilizing values
* `attempt_count`
* `operation_latencies`
* `operation_count`
* `gfe_latency`
* `gfe_missing_header_count`
* `gfe_latencies`
* `gfe_connectivity_error_count`
* `afe_latencies`
* `afe_connectivity_error_count`

## Service Endpoint
The exporter sends metrics to the Google Cloud Monitoring [service endpoint](https://cloud.google.com/python/docs/reference/monitoring/latest/google.cloud.monitoring_v3.services.metric_service.MetricServiceClient#google_cloud_monitoring_v3_services_metric_service_MetricServiceClient_create_service_time_series), distinct from the regular client endpoint. This service endpoint operates under a different quota limit than the user endpoint and features an additional server-side filter that only permits a predefined set of metrics to pass through.
Expand Down
10 changes: 8 additions & 2 deletions packages/google-cloud-spanner/google/cloud/spanner_v1/metrics/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,19 @@
METRIC_NAME_ATTEMPT_LATENCIES = "attempt_latencies"
METRIC_NAME_OPERATION_COUNT = "operation_count"
METRIC_NAME_ATTEMPT_COUNT = "attempt_count"
METRIC_NAME_GFE_LATENCY = "gfe_latency"
METRIC_NAME_GFE_MISSING_HEADER_COUNT = "gfe_missing_header_count"
METRIC_NAME_GFE_LATENCY = "gfe_latencies"
METRIC_NAME_GFE_CONNECTIVITY_ERROR_COUNT = "gfe_connectivity_error_count"
METRIC_NAME_AFE_LATENCY = "afe_latencies"
METRIC_NAME_AFE_CONNECTIVITY_ERROR_COUNT = "afe_connectivity_error_count"
METRIC_NAMES = [
METRIC_NAME_OPERATION_LATENCIES,
METRIC_NAME_ATTEMPT_LATENCIES,
METRIC_NAME_OPERATION_COUNT,
METRIC_NAME_ATTEMPT_COUNT,
METRIC_NAME_GFE_LATENCY,
METRIC_NAME_GFE_CONNECTIVITY_ERROR_COUNT,
METRIC_NAME_AFE_LATENCY,
METRIC_NAME_AFE_CONNECTIVITY_ERROR_COUNT,
]

METRIC_EXPORT_INTERVAL_MS = 60000 # 1 Minute
Loading
Loading