Google Stackdriver Monitoring Client for Java
Java idiomatic client for Stackdriver Monitoring.
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>25.3.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.3.0</version> </dependency>
If you are using Gradle 5.x or later, add this to your dependencies
implementation platform('com.google.cloud:libraries-bom:25.4.0') implementation 'com.google.cloud:google-cloud-monitoring'
If you are using Gradle without BOM, add this to your dependencies
If you are using SBT, add this to your dependencies
libraryDependencies += "com.google.cloud" % "google-cloud-monitoring" % "3.3.0"
See the Authentication section in the base directory's README.
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.
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
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 are in the
|Sample||Source Code||Try it|
|Create Alert Policy||source code|
|Create Metric Descriptor||source code|
|Create Time Series||source code|
|Delete Alert Policy||source code|
|Delete Metric Descriptor||source code|
|Delete Notification Channel||source code|
|Enable Disable Alert Policy||source code|
|Get Alert Policy||source code|
|Get Monitored Resource||source code|
|List Alert Policy||source code|
|List Metric Descriptor||source code|
|List Time Series||source code|
|Monitored Resources List||source code|
|Quickstart Sample||source code|
|Time Series Headers List||source code|
|Update Alert Policy||source code|
|Uptime Sample||source code|
To get help, follow the instructions in the shared Troubleshooting document.
Stackdriver Monitoring uses gRPC for the transport layer.
Supported Java Versions
Java 8 or above is required for using this client.
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).
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
and on google-cloud-java.
This library follows Semantic Versioning.
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.
Apache 2.0 - See LICENSE for more information.
|Java 8 OSX|
|Java 8 Windows|
Java is a registered trademark of Oracle and/or its affiliates.