Google Cloud Spanner

Monitor Google Distributed NewSQL Database Service

🚧

Not Included in the BindPlane with Google Cloud Monitoring offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Cloud Monitoring offering.

For more information on how to use the below LPU and other Google Cloud Data Collection setup. See the Google Cloud Platform Sources

Least Privileged User

A user role with the at least the following permissions is required:

📘

Deploying a Least Privileged User

To learn more about how to deploy a role with these permissions to a GCP Organization, or a GCP Project, please refer to this documentation:
Deploy an Individual LPU role to a GCP Project, or GCP Organization

- cloudnotifications.activities.list
- monitoring.alertPolicies.get
- monitoring.alertPolicies.list
- monitoring.dashboards.get
- monitoring.dashboards.list
- monitoring.groups.get
- monitoring.groups.list
- monitoring.metricDescriptors.get
- monitoring.metricDescriptors.list
- monitoring.monitoredResourceDescriptors.get
- monitoring.monitoredResourceDescriptors.list
- monitoring.notificationChannelDescriptors.get
- monitoring.notificationChannelDescriptors.list
- monitoring.notificationChannels.get
- monitoring.notificationChannels.list
- monitoring.publicWidgets.get
- monitoring.publicWidgets.list
- monitoring.timeSeries.list
- monitoring.uptimeCheckConfigs.get
- monitoring.uptimeCheckConfigs.list
- resourcemanager.projects.get
- resourcemanager.projects.list
- stackdriver.projects.get
- monitoring.timeSeries.list
- resourcemanager.projects.get
- spanner.databases.list
- spanner.instanceConfigs.get
- spanner.instanceConfigs.list
- spanner.instances.get
- spanner.instances.list

Connection Parameters

NameRequired?Description
Private Key JSONRequiredThe contents of the private key JSON file created when setting up a service account.
Metric CollectionControls which metrics get requested from GCP's Stackdriver API.
ProjectsRequiredA comma separated whitelist of project IDs. If the wildcard "*" is used, resources will be collected from all available projects.
Connection TimeoutThe number of seconds to allow for connecting to the target.

Metrics

Database

NameDescription
API Requests (Requests)Number of Cloud Spanner API requests.
CPU Utilization (%)Average utilization of provisioned CPU.
Data Received By Cloud Spanner (Bytes per Second)Rate of uncompressed request data received by Cloud Spanner.
Data Sent By Cloud Spanner (Bytes per Second)Rate of uncompressed response data sent by Cloud Spanner.
IDThe unique database ID.
Instance IDThe ID of the instance that holds the database.
Project IDThe ID of the project that holds the instance.
Request Latencies (Seconds)Distribution of server request latencies for a database. This includes latency of request processing in Cloud Spanner backends and API layer. It does not include network or reverse-proxy overhead between clients and servers.
Sessions (Sessions)Number of sessions in use.
StateThe current database state.
Storage Used (Bytes)Storage data used.

Instance

NameDescription
API Requests (Requests)Number of Cloud Spanner API requests.
ConfigurationThe name of the instance's configuration.
CPU Utilization (%)Utilization of provisioned CPU.
Data Received (Bytes per Second)Rate of uncompressed request data received by Cloud Spanner.
Data Sent (Bytes per Second)Rate of uncompressed response data sent by Cloud Spanner.
Display NameThe descriptive name for this instance as it appears in UIs. Must be unique per project.
IDThe unique ID for this instance.
LabelsCloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).
Node CountThe number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state READY.
NodesTotal number of nodes.
Project IDThe ID of the project that holds the instance.
Request Latencies (Seconds)Distribution of server request latencies for a database. This includes latency of request processing in Cloud Spanner backends and API layer. It does not include network or reverse-proxy overhead between clients and servers.
Sessions (Sessions)Number of sessions in use.
StateThe current instance state. For instances.create, the state must be either omitted or set to CREATING. For instances.patch, the state must be either omitted or set to READY.
Storage Used (Bytes)Total storage used.