Skip to content
This repository has been archived by the owner on Oct 2, 2023. It is now read-only.

Commit

Permalink
chore: update repo-metadata and regenerate README from templates (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
chingor13 committed Feb 4, 2020
1 parent edef416 commit df1fb93
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 1,304 deletions.
7 changes: 6 additions & 1 deletion .kokoro/linkage-monitor.sh
Expand Up @@ -23,7 +23,12 @@ cd github/java-monitoring/
java -version
echo ${JOB_TYPE}

mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgcloud.download.skip=true -B -V
mvn install -B -V \
-DskipTests=true \
-Dclirr.skip=true \
-Denforcer.skip=true \
-Dmaven.javadoc.skip=true \
-Dgcloud.download.skip=true

# Kokoro job cloud-opensource-java/ubuntu/linkage-monitor-gcs creates this JAR
JAR=linkage-monitor-latest-all-deps.jar
Expand Down
7 changes: 5 additions & 2 deletions .repo-metadata.json
Expand Up @@ -2,12 +2,15 @@
"name": "monitoring",
"name_pretty": "Stackdriver Monitoring",
"product_documentation": "https://cloud.google.com/monitoring/docs",
"client_documentation": "https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/monitoring/v3/package-summary.html",
"client_documentation": "https://googleapis.dev/java/google-cloud-monitoring/latest/",
"issue_tracker": "https://issuetracker.google.com/savedsearches/559785",
"release_level": "ga",
"language": "java",
"repo": "googleapis/java-monitoring",
"repo_short": "java-monitoring",
"distribution_name": "com.google.cloud:google-cloud-monitoring",
"api_id": "monitoring.googleapis.com"
"api_id": "monitoring.googleapis.com",
"transport": "grpc",
"requires_billing": true,
"api_description": "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."
}
166 changes: 100 additions & 66 deletions README.md
@@ -1,30 +1,27 @@
Google Cloud Java Client for Stackdriver Monitoring
======================================
# Google Stackdriver Monitoring Client for Java

Java idiomatic client for [Stackdriver Monitoring][stackdriver-monitoring].
Java idiomatic client for [Stackdriver Monitoring][product-docs].

[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-monitoring.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-monitoring.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][monitoring-product-docs]
- [Client Library Documentation][monitoring-client-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

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

If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
```xml
<!-- [START monitoring_install_with_bom] -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.1.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.5.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
Expand All @@ -33,19 +30,20 @@ If you are using Maven with a BOM, add this to your pom.xml file.
<artifactId>google-cloud-monitoring</artifactId>
</dependency>
</dependencies>
<!-- [END monitoring_install_with_bom] -->
```

[//]: # ({x-version-update-start:google-cloud-monitoring:released})
If you are using Maven without a BOM, add this to your dependencies.

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

```xml
<!-- [START monitoring_install_without_bom] -->
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-monitoring</artifactId>
<version>1.99.1</version>
</dependency>
<!-- [END monitoring_install_without_bom] -->
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-monitoring:1.99.1'
Expand All @@ -56,66 +54,102 @@ libraryDependencies += "com.google.cloud" % "google-cloud-monitoring" % "1.99.1"
```
[//]: # ({x-version-update-end})

Authentication
--------------
## Authentication

See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
See the [Authentication][authentication] section in the base directory's README.

About Stackdriver Monitoring
----------------------------
## Getting Started

[Stackdriver Monitoring][stackdriver-monitoring] provides visibility into the performance, uptime, and overall health of cloud-powered applications. Stackdriver collects metrics, events, and metadata from Google Cloud Platform, Amazon Web Services, hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch, and many others.
### Prerequisites

See the [Monitoring client library docs][monitoring-client-lib-docs] to learn how to use this client library.
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]`.

Getting Started
---------------
#### Prerequisites
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Stackdriver Monitoring API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
### Installation and setup

#### 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.
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.

Troubleshooting
---------------
## About Stackdriver Monitoring

To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).

Transport
---------
Monitoring uses gRPC for the transport layer.
[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.

Java Versions
-------------
See the [Stackdriver Monitoring client library docs][javadocs] to learn how to
use this Stackdriver Monitoring Client Library.

Java 7 or above is required for using this client.

Versioning
----------

This library follows [Semantic Versioning](http://semver.org/).

It is currently in major version one (``1.y.z``), which means that the public API should be considered stable.
## Troubleshooting

Contributing
------------
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

Contributions to this library are always welcome and highly encouraged.
## Transport

Stackdriver Monitoring uses gRPC for the transport layer.

See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
## Java Versions

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.
Java 7 or above is required for using this client.

License
-------
## Versioning

This library follows [Semantic Versioning](http://semver.org/).

Apache 2.0 - See [LICENSE] for more information.


[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
[cloud-platform]: https://cloud.google.com/
[stackdriver-monitoring]: https://cloud.google.com/monitoring/
[monitoring-product-docs]: https://cloud.google.com/monitoring/docs/
[monitoring-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/monitoring/v3/package-summary.html
## 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 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
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]

[product-docs]: https://cloud.google.com/monitoring/docs
[javadocs]: https://googleapis.dev/java/google-cloud-monitoring/latest/
[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-ga-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
[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/master/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-monitoring/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-monitoring/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-monitoring/blob/master/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
3 changes: 2 additions & 1 deletion renovate.json
Expand Up @@ -22,7 +22,8 @@
"^com.google.api:gax",
"^com.google.auth:",
"^com.google.cloud:google-cloud-core",
"^io.grpc:"
"^io.grpc:",
"^com.google.guava:"
],
"groupName": "core dependencies"
},
Expand Down

0 comments on commit df1fb93

Please sign in to comment.