Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Google Cloud SQL

Not Included in the BindPlane with Google Stackdriver offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Stackdriver 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 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
- stackdriver.projects.get
- serviceusage.quotas.get
- serviceusage.services.get
- serviceusage.services.list
- cloudsql.backupRuns.get
- cloudsql.backupRuns.list
- cloudsql.databases.get
- cloudsql.databases.list
- cloudsql.instances.export
- cloudsql.instances.get
- cloudsql.instances.list
- cloudsql.instances.listServerCas
- cloudsql.sslCerts.get
- cloudsql.sslCerts.list
- cloudsql.users.list

Connection Parameters

Name
Required?
Description

Private Key JSON

Required

The contents of the private key JSON file created when setting up a service account.

Project ID

Required

The Google Cloud Platform Project ID.

Metrics

Backup Run

Name
Description

Description

The description of this run, only applicable to on-demand backups.

End Time

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Enqueued Time

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Error Code

Identifies the specific error that occurred.

Error Kind

This is always sql#operationError.

Error Message

Additional information about the error encountered.

ID

A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.

Instance

Name of the database instance.

Kind

This is always sql#backupRun.

Self Link

The URI of this resource.

Start Time

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Status

The status of this run.

Type

The type of this run; can be either "AUTOMATED" or "ON_DEMAND".

Window Start Time

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Flag

Name
Description

Name

The name of the flag. These flags are passed at instance startup. Flags should be specified with underscores, not hyphens.

Parent ID

The ID of the Cloud SQL instance this flag belongs to.

Value

The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

Instance

Name
Description

Activation Policy

The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. valid values: ALWAYS, NEVER, ON_DEMAND, PER_USE, PER_PACKAGE

Authorized Google App Engine Applications

The App Engine app IDs that can access this instance. This property is only applicable to First Generation instances.

Availability Type

Reserved for future use.

Available for Failover

This is > 0 if the failover operation is available on the master instance.master.

Backend Type

Backend type of the database.

Backup Binary Log Enabled

Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.

Backup Configuration Kind

This is always sql#backupConfiguration.

Backup Enabled

Whether this configuration is enabled.

Backup Start Time

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

Connection Name

Connection name of the Cloud SQL instance used in connection strings.

Connections (Connections)

Number of connections to the Cloud SQL instance.

CPU Reserved Cores

Number of cores reserved for the database.

CPU Usage Time (Seconds)

Cumulative CPU usage time in seconds.

CPU Utilization

The fraction of the reserved CPU that is currently in use.

Crash Safe Replication Enabled

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances.

Data Disk Size (Gigabytes)

The size of data disk, in GB. The data disk size minimum is 10GB. Applies only to Second Generation instances.

Data Disk Type

The type of data disk: PD_SSD (default) or PD_HDD. Applies only to Second Generation instances.

Database Replication Enabled

Configuration specific to read replica instances. Indicates whether replication is enabled or not.

Database version

The database engine type and version.

Day

Day of week (1-7), starting on Monday.

Disk Quota (Bytes)

Maximum data disk size in bytes

Disk Used (Bytes)

Data utilization in bytes.

Disk Utilization

The fraction of the disk quota that is currently in use.

Entity Tag

The identifier of the resource.

Failover Replica Available

The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The master can only failover to the falover replica when the status is true.

Failover Replica Name

The name of the failover replica. This property is applicable only to Second Generation instances.

Follow Google App Engine Application

The App Engine application to follow, it must be in the same region as the Cloud SQL instance.

fsync Calls (Calls)

Delta count of InnoDB fsync() calls.

fsync Log Calls (Calls)

Delta count of InnoDB fsync() calls to the log file.

Hour

Hour of day - 0 to 23.

IP Addresses

List of the assigned IP addresses for the instance

IPv4 Enabled

Whether the instance should be assigned an IP address or not.

IPv6 Address

The IPv6 address assigned to the instance. This property is applicable only to First Generation instances.

Location Preference Kind

This is always sql#locationPreference.

Maintenance Window Kind

This is always sql#maintenanceWindow.

Master Instance Name

The name of the instance which will act as master in the replication setup.

Maximum Disk Size (Bytes)

The maximum disk size of the instance in bytes.

Memory Quota (Bytes)

Maximum RAM size in bytes.

Memory Usage (Bytes)

RAM usage in bytes.

Memory Utilization

The fraction of the memory quota that is currently in use.

MySQL Replica Configuration CA Certificate

PEM representation of the trusted CA's x509 certificate.

MySQL Replica Configuration Client Certificate

PEM representation of the slave's x509 certificate.

MySQL Replica Configuration Client Key

PEM representation of the slave's private key. The corresponding public key is encoded in the client's certificate.

MySQL Replica Configuration Connect Retry Interval (Seconds)

Seconds to wait between connect retries. MySQL's default is 60 seconds.

MySQL Replica Configuration Dump File Path

Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.

MySQL Replica Configuration Kind

This is always sql#mysqlReplicaConfiguration.

MySQL Replica Configuration Master Heartbeat Period (Milliseconds)

Interval in milliseconds between replication heartbeats.

MySQL Replica Configuration Password

The password for the replication connection.

MySQL Replica Configuration SSL Cipher

A list of permissible ciphers to use for SSL encryption.

MySQL Replica Configuration Username

The username for the replication connection.

MySQL Replica Configuration Verify Server Certificate

Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.

Name

Name of the Cloud SQL instance. This does not include the project ID.

Network Sent Count (Bytes)

Delta count of bytes sent through the network.

On Premises Configuration Host Port

The host and port of the on-premises instance in host:port format.

On Premises Configuration Kind

This is always sql#onPremisesConfiguration.

Pages Read (Pages)

Delta count of InnoDB pages read.

Pages Total (Pages)

Total number of pages in the InnoDB buffer pool.

Pages Unflushed (Pages)

Number of unflushed pages in the InnoDB buffer pool.

Pages Unused (Pages)

Number of unused pages in the InnoDB buffer pool.

Pages Written (Pages)

Delta count of InnoDB pages written.

Pricing Plan

The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.

Project

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

Queries

Delta count of statements executed by the server.

Questions

Delta count of statements executed by the server sent by the client.

Read Operations (Reads)

Delta count of data disk read IO operations.

Region

The geographical region. Defaults to us-central or us-central1 depending on the instance type (First Generation or Second Generation/PostgreSQL).The region cannot be changed after instance creation.

Replica Configuration Failover Target

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance

Replica Configuration Kind

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance

Replica Names

The replicas of the instance.

Replication Type

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.

Require SSL

Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.

Self Link

The replicas of the instance.

Service Account Email Address

The service account email address assigned to the instance. This property is applicable only to Second Generation instances.

Settings Kind

This is always sql#settings.

Settings Version

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

Slave I/O Running

Indicates whether the I/O thread for reading the master's binary log is running. Possible values are Yes, No and Connecting.

Slave SQL Running

Indicates whether the SQL thread for executing events in the relay log is running.

State

The current serving state of the Cloud SQL instance. This can be one of the following: RUNNABLE, SUSPENDED, PENDING_CREATE, MAINTENANCE, FAILED, UNKNOWN_STATE.

Storage Auto Resize

Configuration to increase storage size automatically. The default value is true. Applies only to Second Generation instances.

Storage Auto Resize Limit

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Applies only to Second Generation instances.

Suspension Reason

If the instance state is SUSPENDED, the reason for the suspension. Potential values: BILLING_ISSUE, INTERNAL_MAINTENANCE, and OPERATIONAL_ISSUE.

Tier

The tier or machine type for this instance, for example db-n1-standard-1. For MySQL instances, this field determines whether the instance is Second Generation (recommended) or First Generation. For more information, see pricing.

Time Behind Master (Seconds)

Amount of time the read replica is behind its master (approximation).

Type Of Instance

The instance type. CLOUD_SQL_INSTANCE, ON_PREMISES_INSTANCE, READ_REPLICA_INSTANCE.

Up

Indicates if the server is up or not. On-demand instances are spun down if no connections are made for a sufficient amount of time.

Update Track

Update Track

Uptime (Seconds)

Delta count of the time in seconds the instance has been running.

Write Operations (Writes)

Delta count of data disk write IO operations.

Zone

The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).

Label

Name
Description

Name

The name of the label.

Parent ID

The ID of the Cloud SQL instance this label belongs to.

Value

The value of the label.

Updated 13 days ago

Google Cloud SQL


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.