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 Bigtable

Monitor Google Cloud Scalable NoSQL Database Service

📘

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 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
- bigtable.appProfiles.get
- bigtable.appProfiles.list
- bigtable.clusters.get
- bigtable.clusters.list
- bigtable.instances.get
- bigtable.instances.list
- bigtable.tables.checkConsistency
- bigtable.tables.generateConsistencyToken
- bigtable.tables.get
- bigtable.tables.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

App Profile

NameDescription
DescriptionOptional long form description of the use case for this AppProfile.
Entity TagStrongly validated entity tag for optimistic concurrency control. Preserve the value returned from appProfiles.get when calling appProfiles.patch to fail the request if there has been a modification in the mean time. The updateMask of the request need not include entity tag for this protection to apply. See Wikipedia and RFC 7232 for more details.
Multi Cluster Routing Use Any Allow Transactional WritesWhether or not CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Multi Cluster Routing Use Any Cluster IdThe cluster to which read/write requests should be routed.
NameThe unique name of the app profile.
Project IDThe project ID in which this resource was created.
Single Cluster Routing Allow Transactional WritesWhether or not CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Single Cluster Routing Cluster IdThe cluster to which read/write requests should be routed.

Cluster

NameDescription
CPU Load (%)CPU load of a cluster.
CPU Load (Hottest Node) (%)CPU load of the busiest node in a cluster.
Data Stored in Table (Bytes)Amount of compressed data stored in a table.
Data Stored on Disk (Bytes)Amount of compressed data for tables stored in a cluster.
Default Storage TypeThe type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
Disk Load (%)Average utilization of HDD disks in a cluster.
Error Count (Requests per Second)Rate of server requests for a table that failed with an error.
InstanceThe name of the parent instance.
Latencies (Milliseconds)Average server request latencies for a table.
Modified Rows (Rows per Second)Rate of rows modified by server requests for a table.
NameThe name of the cluster.
Project IdThe identifier of the project that the cluster belongs to.
Received Data (Bytes per Second)Rate of uncompressed request data received by servers for a table.
Replication Latencies (Milliseconds)Average latencies of replication requests for a table. Includes only requests that have been received by the destination cluster.
Replication Maximum Delay (Seconds)Upper bound for replication delay between clusters of a table. Indicates the time frame during which latency information may not be accurate.
Request Count (Requests per Second)Rate of server requests for a table.
Returned Rows (Rows per Second)Rate of rows returned by server requests for a table.
Sent Data (Bytes per Second)Rate of uncompressed response data sent by servers for a table.
Serve NodesThe number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
StateThe current state of the cluster.
Storage Utilization (%)Storage used as a fraction of total storage capacity.
ZoneThe zone in which the cluster resides.

Instance

NameDescription
Display NameThe descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
LabelsLabels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies.
NameThe unique name of the instance.
Project IDThe project ID in which this resource was created.
StateThe current state of the instance.
TypeThe type of the instance. Defaults to PRODUCTION.

Updated 8 months ago

Google Cloud Bigtable


Monitor Google Cloud Scalable NoSQL Database Service

Suggested Edits are limited on API Reference Pages

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