查看和管理客户端指标

本页面介绍了如何查看和管理客户端指标。客户端指标可提供有关客户端向 Spanner 发出的 RPC 请求的延迟时间信息。

Spanner 提供客户端指标，您可以将这些指标与服务器端指标结合使用，以优化性能并排查出现的性能问题。

客户端指标从请求离开应用开始计量，直到应用收到响应为止。相比之下，服务器端指标从 Spanner 收到请求开始计量，直到数据的最后一个字节发送到客户端为止。

访问客户端指标

以下客户端库提供客户端指标：

  • Java 6.81.0 版及更高版本。
  • Go 1.71.0 版及更高版本。

启用 Cloud Monitoring API 后，即可使用客户端指标。

启用 Monitoring API

客户端指标适用于被授予 Identity and Access Management (IAM) monitoring.timeSeries.create 权限的用户或服务账号。以下 Spanner IAM 角色可提供此权限：

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色来获取所需的 monitoring.timeSeries.create IAM 权限。

在 Metrics Explorer 中查看指标

  1. 在 Google Cloud 控制台中，前往 Metrics Explorer 页面。

    进入 Metrics Explorer

  2. 选择您的项目。

  3. 点击选择指标。

  4. 搜索 spanner.googleapis.com/client。

  5. 选择指标，然后点击应用。

如需详细了解如何对指标进行分组或汇总，请参阅使用菜单构建查询。

您的应用需要运行至少 1 分钟，然后您才能查看所有已发布的指标。

停用客户端指标

如果您已在使用 OpenTelemetry 捕获自定义客户端指标，则可以使用以下代码停用客户端指标：

Java

Spanner spanner =
  SpannerOptions.newBuilder()
    .setProjectId("test-project")
    .setBuiltInMetricsEnabled(false)
    .build()
    .getService();

Go

    client, err := spanner.NewClientWithConfig(ctx, database, spanner.ClientConfig{
    DisableNativeMetrics: true,
    })

价格

在 Cloud Monitoring 中查看客户端指标是免费的。 使用 Monitoring API 可能会产生费用。如需了解详情，请参阅 Google Cloud Observability 价格。

后续步骤