Skip to content

Commit d9dee13

Browse files
authored
Update readmes for latest release. (GoogleCloudPlatform#99)
1 parent 595a356 commit d9dee13

File tree

5 files changed

+30
-22
lines changed

5 files changed

+30
-22
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
# Open-Telemetry Operations Exporters for Java
22

3-
[![Build Status][circleci-image]][circleci-url]
3+
[![Maven Central][maven-image]][maven-url]
44

55
Provides OpenTelemetry Exporters for Google Cloud Operations.
66

7-
[circleci-image]: https://circleci.com/gh/GoogleCloudPlatform/opentelemetry-operations-java.svg?style=shield
8-
[circleci-url]: https://circleci.com/gh/GoogleCloudPlatform/opentelemetry-operations-java
9-
10-
11-
127
## Building
138

149
This project requires a mock server for Google Cloud APIs. To build and test, do the following:
@@ -44,3 +39,8 @@ See [Tracing Readme](exporters/trace/README.md) for installation and usage instr
4439
*Note: This is an alpha-release.*
4540

4641
See [Metrics Readme](exporters/metrics/README.md) for installation and usage instructions.
42+
43+
44+
45+
[maven-image]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-trace/badge.svg
46+
[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-trace

RELEASING.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,12 @@ Before any push to the upstream repository you need to create a [personal access
6262
token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
6363
6464
65-
## Download the mock server
66-
67-
- Run the `get_mock_server.sh` script, which downloads the [mock server
68-
executable](https://github.com/googleinterns/cloud-operations-api-mock/releases),
69-
and saves the path.
70-
71-
```bash
72-
$ source ./get_mock_server.sh
73-
```
74-
7565
## Release a Snapshot
7666
7767
If you've followed the above steps, you can release snapshots for consumption using the following:
7868
7969
```bash
80-
$ ./gradlew snapshot -Dmock.server.path=$MOCKSERVER
70+
$ ./gradlew snapshot
8171
```
8272

8373
## Releasing a Candidate
@@ -88,7 +78,7 @@ For example, to release the v0.14.0-RC1 candidate, do the following:
8878

8979
```bash
9080
# Create the Candidate.
91-
$ ./gradlew candidate -Prelease.version=0.14.0-RC1 -Dmock.server.path=$MOCKSERVER
81+
$ ./gradlew candidate -Prelease.version=0.14.0-RC1
9282
# Push the tag publically.
9383
$ git push origin v0.14.0-RC1
9484
```
@@ -106,8 +96,8 @@ After following the above steps, you can release candidates from `main` or `v<ma
10696
For example, to release the v0.14.0 candidate, do the following:
10797

10898
```bash
109-
# Create the Candidate.
110-
$ ./gradlew candidate -Prelease.version=0.14.0 -Dmock.server.path=$MOCKSERVER
99+
# Create the Release.
100+
$ ./gradlew candidate -Prelease.version=0.14.0
111101
# Push the tag publically.
112102
$ git push origin v0.14.0
113103
```

exporters/auto/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Auto-Instrumentation for OpenTelemetry in Google Cloud
22

3+
[![Maven Central][maven-image]][maven-url]
4+
35
## Setup
46

57
To instrument metrics and traces using the `opentelemetry-javaagent`, `opentelemetry-operations-java-auto-<version>.jar` can be used to provide opentelemetry exporters.
@@ -9,3 +11,7 @@ java -javaagent:path/to/opentelemetry-javaagent-<version>-all.jar \
911
-Dotel.exporter.jar=path/to/opentelemetry-operations-java-auto-<version>.jar \
1012
-jar myapp.jar
1113
```
14+
15+
16+
[maven-image]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-auto/badge.svg
17+
[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-auto

exporters/metrics/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Metrics Exporter
22

3+
[![Maven Central][maven-image]][maven-url]
4+
35
*NOTE: Metrics are still Alpha in OpenTelemetry, and the API is not guaranteed to be stable across versions.*
46

57
Opentelemetry Google Monitoring Metrics Exporter allows users to send collected metrics
@@ -73,3 +75,7 @@ IntervalMetricReader reader =
7375
| deadline | ??? | ??? | The deadline limit on export calls to Cloud Monitoring API | 10 seconds |
7476
| metricDescriptorStrategy | ??? | ??? | How to adapt OpenTelemetry metric definition into google cloud. `ALWAYS_SEND` will try to create metric descriptors on every export. `SEND_ONCE` will try to create metric descriptors once per Java instance/classloader. `NEVER_SEND` will rely on Cloud Monitoring's auto-generated MetricDescriptors from time series. | `SEND_ONCE` |
7577

78+
79+
80+
[maven-image]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-metrics/badge.svg
81+
[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-metrics

exporters/trace/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Cloud Trace Exporter for OpenTelemetry
22

33
OpenTelemetry Google Cloud Trace Exporter allows the user to send collected traces to Google Cloud.
4-
4+
5+
[![Maven Central][maven-image]][maven-url]
6+
57
[Google Cloud Trace](https://cloud.google.com/trace) is a distributed tracing backend system. It helps developers to gather timing data needed to troubleshoot latency problems in microservice & monolithic architectures. It manages both the collection and lookup of gathered trace data.
68

79
## Setup
@@ -27,7 +29,7 @@ config:
2729
<dependency>
2830
<groupId>com.google.cloud.opentelemetry</groupId>
2931
<artifactId>exporter-trace</artifactId>
30-
<version>0.11.0</version>
32+
<version>0.14.0</version>
3133
</dependency>
3234
```
3335

@@ -86,3 +88,7 @@ Java 8 or above is required for using this exporter.
8688
- For more information on OpenTelemetry, visit: https://opentelemetry.io/
8789
- For more about OpenTelemetry Java, visit: https://github.com/open-telemetry/opentelemetry-java
8890
- Learn more about Google Cloud Trace at https://cloud.google.com/trace
91+
92+
93+
[maven-image]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-trace/badge.svg
94+
[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-trace

0 commit comments

Comments
 (0)