Google Stackdriver Monitoring Client for Java

Java idiomatic client for Stackdriver Monitoring.

Maven Stability

Quickstart

If you are using Maven with BOM, add this to your pom.xml file

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>23.0.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-monitoring</artifactId>
  </dependency>
</dependencies>

If you are using Maven without BOM, add this to your dependencies:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-monitoring</artifactId>
  <version>3.0.5-SNAPSHOT</version>
</dependency>

If you are using Gradle 5.x or later, add this to your dependencies

implementation platform('com.google.cloud:libraries-bom:23.1.0')

implementation 'com.google.cloud:google-cloud-monitoring'

If you are using Gradle without BOM, add this to your dependencies

implementation 'com.google.cloud:google-cloud-monitoring:3.0.7'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-monitoring" % "3.0.7"

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Stackdriver Monitoring APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Stackdriver Monitoring API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Stackdriver Monitoring API enabled. You will need to enable billing to use Google Stackdriver Monitoring. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-monitoring library. See the Quickstart section to add google-cloud-monitoring as a dependency in your code.

About Stackdriver Monitoring

Stackdriver Monitoring collects metrics, events, and metadata from Google Cloud, Amazon Web Services (AWS), hosted uptime probes, and application instrumentation. Using the BindPlane service, you can also collect this data from over 150 common application components, on-premise systems, and hybrid cloud systems. Stackdriver ingests that data and generates insights via dashboards, charts, and alerts. BindPlane is included with your Google Cloud project at no additional cost.

See the Stackdriver Monitoring client library docs to learn how to use this Stackdriver Monitoring Client Library.

Samples

Samples are in the samples/ directory.

SampleSource CodeTry it
Create Alert Policysource codeOpen in Cloud Shell
Create Metric Descriptorsource codeOpen in Cloud Shell
Create Time Seriessource codeOpen in Cloud Shell
Delete Alert Policysource codeOpen in Cloud Shell
Delete Metric Descriptorsource codeOpen in Cloud Shell
Delete Notification Channelsource codeOpen in Cloud Shell
Enable Disable Alert Policysource codeOpen in Cloud Shell
Get Alert Policysource codeOpen in Cloud Shell
Get Monitored Resourcesource codeOpen in Cloud Shell
List Alert Policysource codeOpen in Cloud Shell
List Metric Descriptorsource codeOpen in Cloud Shell
List Time Seriessource codeOpen in Cloud Shell
Monitored Resources Listsource codeOpen in Cloud Shell
Quickstart Samplesource codeOpen in Cloud Shell
Time Series Headers Listsource codeOpen in Cloud Shell
Update Alert Policysource codeOpen in Cloud Shell
Uptime Samplesource codeOpen in Cloud Shell

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Stackdriver Monitoring uses gRPC for the transport layer.

Supported Java Versions

Java 7 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

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 VersionStatus
Java 7Kokoro CI
Java 8Kokoro CI
Java 8 OSXKokoro CI
Java 8 WindowsKokoro CI
Java 11Kokoro CI

Java is a registered trademark of Oracle and/or its affiliates.