Skip to content

Commit 11c85b9

Browse files
authored
Update Metrics Exporter README (#352)
The updated readme removes text indicating that the exporter is still in alpha.
1 parent 7a8dcf4 commit 11c85b9

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ See [Tracing Readme](exporters/trace/README.md) for installation and usage instr
3636

3737
## Google Cloud Monitoring Exporter
3838

39-
*Note: This is an alpha-release.*
40-
4139
See [Metrics Readme](exporters/metrics/README.md) for installation and usage instructions.
4240

4341
## Google Cloud Autoconfigure module

exporters/metrics/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
[![Maven Central][maven-image]][maven-url]
44

5-
*NOTE: While Opentelemetry Metrics API is stable, the SDK is still Alpha in OpenTelemetry, and this exporter is not guaranteed to work across versions.*
6-
75
Opentelemetry Google Monitoring Metrics Exporter allows users to send collected metrics
86
to Google Cloud.
97

@@ -15,13 +13,21 @@ Google Cloud Monitoring is a managed service provided by Google Cloud Platform.
1513

1614
## Usage
1715

18-
TODO(jsuereth): Write this.
19-
2016
See [the code example](../../examples/metrics) for details.
2117

2218
## Authentication
2319

24-
TODO(jsuereth): Write this section.
20+
If you are running in a GCP environment, the exporter will automatically authenticate using the environment's service account. If not, you will need to follow the instructions in Authentication.
21+
22+
This exporter uses [google-cloud-java](https://github.com/googleapis/google-cloud-java), which uses the [google-auth-library-java](https://github.com/googleapis/google-auth-library-java) for authentication. For details about how to configure the authentication see [here](https://github.com/googleapis/google-cloud-java#authentication).
23+
24+
If you prefer to manually set the credentials, they can be passed to the exporter using the [`setCredentials`](https://github.com/GoogleCloudPlatform/opentelemetry-operations-java/blob/7a8dcf420f5551bf0df969f83928b18c443da5aa/exporters/metrics/src/main/java/com/google/cloud/opentelemetry/metric/MetricConfiguration.java) method:
25+
```java
26+
MetricConfiguration.builder()
27+
.setCredentials(new GoogleCredentials(new AccessToken(accessToken, expirationTime)))
28+
.setProjectId("MyProjectId")
29+
.build();
30+
```
2531

2632
## Configuration
2733

@@ -73,7 +79,8 @@ MeterProvider provider = SdkMeterProvider.builder()
7379
| deadline | ??? | ??? | The deadline limit on export calls to Cloud Monitoring API | 12 seconds |
7480
| 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` |
7581

76-
82+
## Java Versions
83+
Java 8 or above is required for using this exporter.
7784

7885
[maven-image]: https://img.shields.io/maven-central/v/com.google.cloud.opentelemetry/exporter-metrics?color=dark-green
7986
[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/exporter-metrics

0 commit comments

Comments
 (0)