You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exporters/metrics/README.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,6 @@
2
2
3
3
[![Maven Central][maven-image]][maven-url]
4
4
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
-
7
5
Opentelemetry Google Monitoring Metrics Exporter allows users to send collected metrics
8
6
to Google Cloud.
9
7
@@ -15,13 +13,21 @@ Google Cloud Monitoring is a managed service provided by Google Cloud Platform.
15
13
16
14
## Usage
17
15
18
-
TODO(jsuereth): Write this.
19
-
20
16
See [the code example](../../examples/metrics) for details.
21
17
22
18
## Authentication
23
19
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:
| deadline | ??? | ??? | The deadline limit on export calls to Cloud Monitoring API | 12 seconds |
74
80
| 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`|
75
81
76
-
82
+
## Java Versions
83
+
Java 8 or above is required for using this exporter.
0 commit comments