Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/googleapis/java-monitoring
This library has moved to https://github.com/googleapis/google-cloud-java/tree/main/java-monitoring.
https://github.com/googleapis/java-monitoring
Last synced: 21 days ago
JSON representation
This library has moved to https://github.com/googleapis/google-cloud-java/tree/main/java-monitoring.
- Host: GitHub
- URL: https://github.com/googleapis/java-monitoring
- Owner: googleapis
- License: apache-2.0
- Archived: true
- Created: 2019-08-20T22:07:31.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T17:21:39.000Z (over 1 year ago)
- Last Synced: 2024-08-04T18:01:18.477Z (4 months ago)
- Size: 7.02 MB
- Stars: 14
- Watchers: 43
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Google Stackdriver Monitoring Client for Java
Java idiomatic client for [Stackdriver Monitoring][product-docs].
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]
:bus: In October 2022, this library has moved to
[google-cloud-java/java-monitoring](
https://github.com/googleapis/google-cloud-java/tree/main/java-monitoring).
This repository will be archived in the future.
Future releases will appear in the new repository (https://github.com/googleapis/google-cloud-java/releases).
The Maven artifact coordinates (`com.google.cloud:google-cloud-monitoring`) remain the same.
## Quickstart
If you are using Maven, add this to your pom.xml file:
```xml
com.google.cloud
google-cloud-monitoring
3.18.0
```
If you are using Gradle without BOM, add this to your dependencies:
```Groovy
implementation 'com.google.cloud:google-cloud-monitoring:3.18.0'
```
If you are using SBT, add this to your dependencies:
```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-monitoring" % "3.18.0"
```
## Authentication
See the [Authentication][authentication] section in the base directory's README.
## Authorization
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Stackdriver Monitoring APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Stackdriver Monitoring API calls.
## Getting Started
### Prerequisites
You will need a [Google Cloud Platform Console][developer-console] project with the Stackdriver Monitoring [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google Stackdriver Monitoring.
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][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](#quickstart) section
to add `google-cloud-monitoring` as a dependency in your code.
## About Stackdriver Monitoring
[Stackdriver Monitoring][product-docs] 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][javadocs] to learn how to
use this Stackdriver Monitoring Client Library.
## Troubleshooting
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
## Transport
Stackdriver Monitoring uses gRPC for the transport layer.
## Supported Java Versions
Java 8 or above is required for using this client.
Google's Java client libraries,
[Google Cloud Client Libraries][cloudlibs]
and
[Google Cloud API Libraries][apilibs],
follow the
[Oracle Java SE support roadmap][oracle]
(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][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][g-c-j].
## Versioning
This library follows [Semantic Versioning](http://semver.org/).
## Contributing
Contributions to this library are always welcome and highly encouraged.
See [CONTRIBUTING][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][code-of-conduct] for more
information.
## License
Apache 2.0 - See [LICENSE][license] for more information.
## CI Status
Java Version | Status
------------ | ------
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
Java is a registered trademark of Oracle and/or its affiliates.
[product-docs]: https://cloud.google.com/monitoring/docs
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-monitoring/latest/history
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-monitoring.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-monitoring&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-monitoring/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-monitoring/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-monitoring/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=monitoring.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[semver]: https://semver.org/
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
[g-c-j]: http://github.com/googleapis/google-cloud-java