pingcap / pingcap/tidb

metrics: expose IA remote-read scan details in TiDB observability

Open
#69,624 1 comment 0 reactions 0 assignees View on GitHub
component/metrics component/observability type/enhancement
Dominant language
Go
Stars
40.5k
Forks
6.2k
PR merge metrics
PR metrics pending

Description

## Enhancement

Expose IA remote-read scan detail fields in TiDB observability surfaces so operators can diagnose remote scan behavior consistently across slow logs, statement summary tables, and Prometheus metrics.

- add slow log fields for IA remote segment count, bytes, and wait time
- add statement summary and `INFORMATION_SCHEMA.SLOW_QUERY` columns for the same scan details
- add Prometheus metrics and metric-schema entries for cluster-level visibility
- depend on `github.com/tikv/client-go/v2` exposing `util.ScanDetail.IaRemoteReadSegment*` fields

Contributor guide

Open the contributing guide

Research direction

Start by tracing existing scan-detail handling across slow logs, statement summary tables, INFORMATION_SCHEMA.SLOW_QUERY, and Prometheus metric-schema entries. Confirm that github.com/tikv/client-go/v2 exposes the IaRemoteReadSegment* fields; done when segment count, bytes, and wait time are consistently visible in all requested observability surfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, prometheus
Domain
databases, observability-sre
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.