Google Cloud Bigtable HBase client for Java
Google Cloud Bigtable is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, Analytics, Maps, and Gmail.
Bigtable is designed to handle massive workloads at consistent low latency and high throughput, so it's a great choice for both operational and analytical applications, including IoT, user analytics, and financial data analysis.
Bigtable provisions and scales to hundreds of petabytes automatically, and can smoothly handle millions of operations per second. Changes to the deployment configuration are immediate, so there is no downtime during reconfiguration.
Bigtable integrates easily with popular Big Data tools like Hadoop, as well as Google Cloud Platform products like Cloud Dataflow and Dataproc. Plus, Bigtable supports the open-source, industry-standard HBase API, which makes it easy for development teams to get started.
Note: These artifacts are meant to wrap HBase over the Bigtable API. If you are looking for a Java client to access Bigtable APIs directly, please use google-cloud-bigtable.
Project setup, installation, and configuration
Prerequisites
Using the Java client
- Add the appropriate Cloud Bigtable artifact dependencies to your Maven project.
bigtable-hbase-1.x: use for standalone applications where you are in control of your dependencies.bigtable-hbase-1.x-hadoop: use in hadoop environments.bigtable-hbase-1.x-mapreduce: use for map/reduce utilities.bigtable-hbase-1.x-shaded: use in environments (other than hadoop) that require older versions of protobuf, guava, etc.bigtable-hbase-2.x: use for standalone applications where you are in control of your dependencies. This includes an HBase async client.bigtable-hbase-2.x-hadoop: use in hadoop environments.bigtable-hbase-2.x-shaded: use in environments (other than hadoop) that require older versions of protobuf, guava, etc.
Maven:
<dependency>
<groupId>com.google.cloud.bigtable</groupId>
<artifactId>bigtable-hbase-1.x</artifactId>
<version>2.6.5</version>
</dependency>Gradle:
compile 'com.google.cloud.bigtable:bigtable-hbase-1.x:2.6.5'SBT:
libraryDependencies += "com.google.cloud.bigtable" % "bigtable-hbase-1.x" % "2.6.5"-
Refer to the Connecting to Bigtable documentation for detailed demonstrations of how to configure the properties to connect to Cloud Bigtable.
-
Refer to the Java samples documentation for detailed demonstrations of how to read and write data with Cloud Bigtable. The code for these samples is available in the Cloud Bigtable examples project.
Enabling Client Side Metrics
Cloud Bigtable client supports publishing client side metrics to Cloud Monitoring under the bigtable.googleapis.com/client namespace.
This feature is available once you upgrade to version 2.6.4 and above. Follow the guide on https://cloud.google.com/bigtable/docs/client-side-metrics-setup to enable.
Note: Beam / Dataflow integration is currently not supported.
OpenCensus Integration
Tracing
The code example below shows how to enable tracing. For more details, see here.
Maven Setup
If you are not using the shaded Bigtable HBase Client artifact, you need to define the OpenCensus dependencies.
<!-- OpenCensus dependencies -->
<dependency>
<groupId>com.google.cloud.bigtable</groupId>
<artifactId>bigtable-hbase-1.x</artifactId>
<version>2.6.5</version>
</dependency><dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>0.31.1</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-exporter-trace-stackdriver</artifactId>
<version>0.31.1</version>
<exclusions>
<exclusion>
<groupId>io.grpc</groupId>
<artifactId>*</artifactId>
</exclusion>
<exclusion>
<groupId>com.google.auth</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>If you are using the shaded Bigtable HBase Client artifact, then the OpenCensus dependencies are embedded in the shaded artifact; i.e. nothing additional for you to do.
<!-- OpenCensus dependencies -->
<dependency>
<groupId>com.google.cloud.bigtable</groupId>
<artifactId>bigtable-hbase-1.x-shaded</artifactId>
<version>2.6.5</version>
</dependency>Java Example
// For the non-shaded client, remove the package prefix "com.google.bigtable.repackaged."
import com.google.bigtable.repackaged.io.opencensus.exporter.trace.stackdriver.StackdriverTraceConfiguration;
import com.google.bigtable.repackaged.io.opencensus.exporter.trace.stackdriver.StackdriverTraceExporter;
import com.google.bigtable.repackaged.io.opencensus.trace.Tracing;
import com.google.bigtable.repackaged.io.opencensus.trace.samplers.Samplers;
import java.io.IOException;
public class OpenCensusExample {
String projectId = "your-project-id";
void setupTracing() throws Exception {
// Setup tracing.
StackdriverTraceExporter.createAndRegister(
StackdriverTraceConfiguration.builder()
.setProjectId(projectId)
.build()
);
Tracing.getTraceConfig().updateActiveTraceParams(
Tracing.getTraceConfig().getActiveTraceParams().toBuilder()
// Adjust the sampling rate as you see fit.
.setSampler(Samplers.probabilitySampler(0.01))
.build()
);
}
}Stats
Note: We recommend enabling client side built-in metrics if you want to view your metrics on cloud monitoring. This integration is only for exporting the metrics to a third party dashboard.
The code example below shows how to enable metrics. For more details, see the gRPC Java Guide.
Maven Setup
If you are not using the shaded Bigtable HBase Client artifact, you need to define the OpenCensus dependencies.
<!-- OpenCensus dependencies -->
<dependency>
<groupId>com.google.cloud.bigtable</groupId>
<artifactId>bigtable-hbase-1.x</artifactId>
<version>2.6.5</version>
</dependency><dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-impl</artifactId>
<version>0.31.1</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.opencensus</groupId>
<artifactId>opencensus-exporter-stats-stackdriver</artifactId>
<version>0.31.1</version>
<exclusions>
<exclusion>
<groupId>io.grpc</groupId>
<artifactId>*</artifactId>
</exclusion>
<exclusion>
<groupId>com.google.auth</groupId>
<artifactId>*</artifactId>
</exclusion>
</exclusions>
</dependency>If you are using the shaded Bigtable HBase Client artifact, then the OpenCensus dependencies are embedded in the shaded artifact; i.e. nothing additional for you to do.
<!-- OpenCensus dependencies -->
<dependency>
<groupId>com.google.cloud.bigtable</groupId>
<artifactId>bigtable-hbase-1.x-shaded</artifactId>
<version>2.6.5</version>
</dependency>Java Example
// For the non-shaded client, remove the package prefix "com.google.bigtable.repackaged."
import com.google.bigtable.repackaged.io.opencensus.contrib.grpc.metrics.RpcViews;
import com.google.bigtable.repackaged.io.opencensus.exporter.stats.stackdriver.StackdriverStatsConfiguration;
import com.google.bigtable.repackaged.io.opencensus.exporter.stats.stackdriver.StackdriverStatsExporter;
import java.io.IOException;
public class OpenCensusExample {
String projectId = "your-project-id";
void setupStatsExport() throws Exception {
// Option 1: Automatic Configuration (from GCP Resources only):
// If you are running from a GCP Resource (e.g. a GCE VM), the Stackdriver metrics are automatically
// configured to upload to your resource.
// For examples of monitored resources, see here: https://cloud.google.com/monitoring/api/resources
StackdriverStatsExporter.createAndRegister();
// Then register your gRPC views in OpenCensus.
RpcViews.registerClientGrpcViews();
// Option 2: Manual Configuration
// If you are not running from a GCP Resource (e.g. if you are running on-prem), then you should
// configure the monitored resource yourself.
// Use the code snippet below as a starting example.
// For examples of monitored resources, see here: https://cloud.google.com/monitoring/api/resources
StackdriverStatsExporter.createAndRegister(
StackdriverStatsConfiguration.builder()
.setProjectId(projectId)
// This example uses generic_node as the MonitoredResource, with your host name as the node ID.
.setMonitoredResource(MonitoredResource.newBuilder()
.setType("generic_node")
.putLabels("project_id", projectId)
.putLabels("location", "us-west1-b") // Specify the region in which your service is running (e.g. us-west1-b).
.putLabels("namespace", "anyNamespaceYouChoose")
.putLabels("node_id", InetAddress.getLocalHost().getHostName()) // Specify any node you choose (e.g. the local hostname).
.build())
.build()
);
// Then register your gRPC views in OpenCensus.
RpcViews.registerClientGrpcViews();
}
}Viewing Your Metrics in Google Cloud Console
The above steps will expose Bigtable's gRPC metrics under the custom.googleapis.com/opencensus/grpc.io/client prefix.
Follow these instructions for viewing the metrics in Google Cloud Console.
Be sure to choose your Resource Type as the one you defined in your Stackdriver configuration in the code.
Questions and discussions
If you have questions or run into issues with Google Cloud Bigtable or the client libraries, use any of the following forums:
- Stack Overflow: tag questions with
google-cloud-bigtable - Mailing list: google-cloud-bigtable-discuss@
You can also subscribe to google-cloud-bigtable-announce@ list to receive infrequent product and client library announcements.
Contributing
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information how to get started.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.
License
Apache 2.0 - See LICENSE for more information.
CI Status
| Java Version | Status |
|---|---|
| Java 8 |  |
| Java 8 OSX |  |
| Java 11 |  |
| Integration |  |
Java is a registered trademark of Oracle and/or its affiliates.