Azure OpenTelemetry Metrics plugin library for Java

This package enables metrics from Azure SDK Java libraries through OpenTelemetry. OpenTelemetry is an open source, vendor-agnostic, single distribution of libraries to provide metrics collection and distributed tracing for services.

Source code | API reference documentation | Product documentation | Samples

Getting started

Prerequisites

• A Java Development Kit (JDK), version 8 or later.
  • Here are details about Java 8 client compatibility with Azure Certificate Authority.

Include the package

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-core-metrics-opentelemetry</artifactId>
  <version>1.0.0-beta.29</version>
</dependency>

Key concepts

Check out Metrics in OpenTelemetry for all the details on metrics.

Examples

The following sections provide several code snippets covering some of the most common client configuration scenarios.

• Default configuration: agent
• Default configuration: OpenTelemetry SDK
• Custom configuration

You can find more samples here.

Default configuration: agent

If you use OpenTelemetry Java agent or Application Insights Java agent version 3.3.0-BETA or higher, no additional Azure SDK configuration is needed.

Default configuration: OpenTelemetry SDK

Azure SDK uses global OpenTelemetry instance by default. You can use OpenTelemetry SDK Autoconfigure package to configure OpenTelemetry using environment variables (or system properties).

<dependency>
  <groupId>io.opentelemetry</groupId>
  <artifactId>opentelemetry-sdk-extension-autoconfigure</artifactId>
</dependency>

// configure OpenTelemetry SDK using io.opentelemetry:opentelemetry-sdk-extension-autoconfigure
// AutoConfiguredOpenTelemetrySdk.initialize();

// configure Azure Client, no metric configuration needed
// client will use global OpenTelemetry configured by OpenTelemetry autoconfigure package.
AzureClient sampleClient = new AzureClientBuilder()
    .endpoint("https://my-client.azure.com")
    .build();

// use client as usual, if it emits metric, they will be exported
sampleClient.methodCall("get items");

Custom configuration

If you want to pass MeterProvider explicitly, you can do it using MetricsOptions and passing them to Azure Clients. MetricsOptions can also be used to disable metrics from specific client.

// configure OpenTelemetry SDK explicitly per https://opentelemetry.io/docs/instrumentation/java/manual/
SdkMeterProvider meterProvider = SdkMeterProvider.builder()
    .registerMetricReader(PeriodicMetricReader.builder(OtlpGrpcMetricExporter.builder().build()).build())
    .build();

OpenTelemetrySdk openTelemetry = OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
// Pass OpenTelemetry instance to MetricsOptions.
MetricsOptions customMetricsOptions = new OpenTelemetryMetricsOptions()
    .setOpenTelemetry(openTelemetry);

// configure Azure Client to use customMetricsOptions - it will use meterProvider
// to create meters and instruments
AzureClient sampleClient = new AzureClientBuilder()
    .endpoint("https://my-client.azure.com")
    .clientOptions(new ClientOptions().setMetricsOptions(customMetricsOptions))
    .build();

// use client as usual, if it emits metric, they will be exported
sampleClient.methodCall("get items");

Troubleshooting

General

For more information on OpenTelemetry, see OpenTelemetry documentation and OpenTelemetry Java.

Enabling Logging

Azure SDKs for Java offer a consistent logging story to help aid in troubleshooting application errors and expedite their resolution. The logs produced will capture the flow of an application before reaching the terminal state to help locate the root issue. View the logging wiki for guidance about enabling logging.

Next steps

Get started with Azure libraries that are built using Azure Core.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.