Skip to content

Add keyspace observability labels for NextGen deployments #68405

@zeminzhou

Description

@zeminzhou

Feature Request

Is your feature request related to a problem? Please describe:

NextGen deployments need TiDB observability outputs to include keyspace identity so metrics can be grouped and queried by keyspace. Starter mode also needs selected keyspace metadata values to be attached to metrics, slow logs, and statement summary logs for operational correlation.

Describe the feature you'd like:

Add a keyspace observability configuration that maps selected keyspace metadata entries to observability outputs:

  • metric labels
  • slow log fields
  • statement summary log fields

For NextGen non-Starter deployments, TiDB should add keyspace ID and keyspace name to metrics labels. For NextGen Starter deployments, TiDB should also resolve configured keyspace metadata at startup and attach the resolved values to the configured observability outputs.

Describe alternatives you've considered:

One alternative is for each observability component to query keyspace metadata independently, but that duplicates PD access and scatters startup-time metadata resolution across unrelated packages.

Teachability, Documentation, Adoption, Migration Strategy:

The feature can be configured through TiDB configuration. Existing deployments without the new configuration should keep current behavior, while NextGen deployments gain keyspace labels for metrics when keyspace information is available.

Suggested labels: type/feature-request, component/observability, component/metrics, component/config

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions