client-side-metrics.md

View and manage client-side metrics

The Spanner Cassandra client provides client-side metrics that you can use along with server-side metrics to optimize performance and and troubleshoot any performance issues.

Client-side metrics measure the total time a request takes i.e. from when the client sends the request till when the client gets the full response back.

Server-side metrics measure only the time the server spends processing the request i.e. from when the server first receives the request till it has all the data back to the client.

Enable client-side metrics

CqlSession session = SpannerCqlSession.builder() 
        .setDatabaseUri(databaseUri)
        .addContactPoint(new InetSocketAddress("localhost", 9042))
        .withLocalDatacenter("datacenter1")
        .setBuiltInMetricsEnabled(true)
        .withConfigLoader(
            DriverConfigLoader.programmaticBuilder()
                .withString(DefaultDriverOption.PROTOCOL_VERSION, "V4")
                .withDuration(
                    DefaultDriverOption.CONNECTION_INIT_QUERY_TIMEOUT, Duration.ofSeconds(5))
                .build())
        .build();

Client-side metrics are available after you enable the Cloud Monitoring API.

Client-side metrics are available for users or service accounts that are granted the Identity and Access Management (IAM) monitoring.timeSeries.create permission. This permission is included in the following Spanner IAM roles:

• Cloud Spanner Admin (roles/spanner.admin)
• Cloud Spanner Database Admin (roles/spanner.databaseAdmin)
• Cloud Spanner Database Reader (roles/spanner.databaseReader)
• Cloud Spanner Database User (roles/spanner.databaseUser)

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required monitoring.timeSeries.create IAM permission through custom roles.

View metrics in the Metrics Explorer

1. In the Google Cloud console, go to the Metrics Explorer page.

   Go to Metrics Explorer

2. Select your project.

3. Click Select a metric.

4. Search for spanner.googleapis.com/client.

5. Select the metric, and then click Apply.

For more information about grouping or aggregating your metric, see Build queries using menus.

Your application needs to run for at least a minute before you can view any published metrics.

Pricing

There is no additional charge to view client-side metrics in Cloud Monitoring.