Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 3.54 KB

README.md

File metadata and controls

79 lines (56 loc) · 3.54 KB
Raw

Auto-Configuration for OpenTelemetry in Google Cloud

Maven Central

SDK AutoConfiguration

OpenTelemetry Java SDK provides an autoconfigure module where all configuration can be done entirely through Java system properties or environment variables.

To leverage the GCP extensions to this, simply add the exporter-auto dependency to your project.

We also provide a shaded variant of the exporter-auto which is the recommended way for autoconfiguration if you are using the auto-exporter as a java agent extension.

Maven

<dependency>
  <groupId>com.google.cloud.opentelemetry</groupId>
  <artifactId>exporter-auto</artifactId>
  <version>0.31.0-alpha</version>
  <!-- Add the classifier if you explicitly wish to use the shaded variant -->
  <classifier>shaded</classifier>
</dependency>

Gradle

implementation "com.google.cloud.opentelemetry:exporter-auto:0.31.0-alpha"

To use the shaded variant with Gradle,

implementation "com.google.cloud.opentelemetry:exporter-auto:0.31.0-alpha:shaded"

Shaded Local JAR

You can download the shaded JAR for exporter-auto from the following link -

https://repo1.maven.org/maven2/com/google/cloud/opentelemetry/exporter-auto/<VERSION>-alpha/exporter-auto-<VERSION>-alpha-shaded.jar

Replace <VERSION> with the version you wish to download. For instance, shaded variant for v0.31.0, will be found at -

https://repo1.maven.org/maven2/com/google/cloud/opentelemetry/exporter-auto/0.31.0-alpha/exporter-auto-0.31.0-alpha-shaded.jar

Note: Make sure to use the latest release LatestRelease.

Then you can configure your sdk using the following system properties/environmnet variables:

Property Environment Variable Value Description
otel.traces.exporter N/A google_cloud_trace The exporter for traces.
otel.metrics.exporter N/A google_cloud_monitoring The exporter for metrics.
GOOGLE_CLOUD_PROJECT GOOGLE_CLOUD_PROJECT autodiscovered The project_id to report metrics/traces againt.
GOOGLE_APPLICATION_CREDENTIALS GOOGLE_APPLICATION_CREDENTIALS autodiscovered Credentials to use when talking to GCP APIs.

See the autoconfigure SDK module for general environmental setup configuration.

AutoInstrumentation Setup

You can use the auto-configuration jar as an Extension to the Java auto instrumentation agent.

To instrument metrics and traces using the opentelemetry-javaagent, opentelemetry-operations-java-auto-<version>.jar can be used to provide opentelemetry exporters.

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.javaagent.extensions=path/to/opentelemetry-operations-java-auto-<version>.jar \
     -Dotel.traces.exporter=google_cloud_trace \
     -Dotel.metrics.exporter=google_cloud_monitoring \
     -jar myapp.jar

NOTE: The use of custom exporter in Java auto instrumentation is still undergoing a lot of churn. Until it stabilizes, this module is provided for proof-of-concept work.