lmolkova

OpenTelemetry Metrics Semantic Conventions for Azure Messaging Libraries

Context: https://gist.github.com/lmolkova/b9004307a09be788af04f05ebe22ad3c

Follows general OTel Metrics conventions and depends on OTel Messaging conventions changes

AMQP-level metric instruments

Name	Description	Units	Instrument Type (*)	Value Type	Attribute Key(s)	Attribute Values

lmolkova

Kafka

• Host: net.peer.name:net.peer.port (actual host contacted)
  • always present
• Topic name: messaging.destination.name
  • maybe present per message, not per publish call - https://stackoverflow.com/questions/39093488/can-single-kafka-producer-produce-messages-to-multiple-topics-and-how

no url notion

JMS

lmolkova

Metrics in Azure SDK for Java

The immediate goal is to report metrics from Azure messaging SDKs (EventHubs and ServiceBus) to help customers detect and investigate configuration issues, performance bottlenecks, application and SDK bugs.

It can be broken down into smaller goals:

• define metrics essential for messaging scenarios
• define Metrics API in azure-core
• metrics plugin implementations

lmolkova

Quarkus configuration

Quarkus configuration is very similar to Spring:

• supports application.properties and application.yaml
• conventions on property names are the same: '.' as separator, kebab-case.
• supports property sources, iterating over them and getting value by name programmatically or with annotation

What's different:

• Quarkus uses smallrye-config which is implementation of microprofile-config. Annotation and feature-wise, it's similar to spring, but more explicit (reflection is discouraged)
• Property metadata can be extended with microprofile language-server extension (example)

lmolkova

Note: New APIs are still work in progress and need polishing

Please build azure-core and azure-data-appconfiguration from https://github.com/lmolkova/azure-sdk-for-java/tree/configuration-sdk/ branch

PR: Azure/azure-sdk-for-java#26420

Usage

// 1. Implement a ConfigurationSource
// 2. Build client-specific Configuration

lmolkova

• SDKs expose IAzureClientBuilder<EventHubProducerClient, EventHubProducerClientOptions> AddEventHubProducerClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration) where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>

  • Configuration format and binding to options are not defined in Azure SDKs

• Implementation lives in Microsoft.Extensions.Azure

  • binding to options is done by microsoft.extensions.configuration through IConfiguration.Bind() and relies on *Options following microsoft.extensions.configuration conventions (i.e. properties)
  • options sources are whatever microsoft.extensions.configuration supports:
    • appsettings.json
    • env var config (flat) is supported through ASP.NET Core conventions

• Config

lmolkova

Azure SDK configuration

Prior art

• Azure SDK supports global configuration through Common environment variables
• .NET allows to configure SDKs through appsettings.json or any other MS.Extensions.Configuration-compatible source using additional Microsoft.Extensions.Azure package.
  • .NET configuration and examples
• Java Azure Spring Cloud works on extensive list of configuration options
• Cloud Configuration draft

lmolkova

@Autowired
ServiceBusSenderClient  serviceBusClient;

@PostMapping("/queues")
public String send(@RequestParam("message") String message) {
    serviceBusClient.sendMessage(new ServiceBusMessage(message));
    return message;
}

lmolkova

public static class MessagingExtensions
{
    // potential addition to event hubs SDK. service bus is similar
    // The only concern is availability of ActivityContext prior to .NET 5
    // there is a potential to update DiagnosticSource, but it's problematic because of 
    // version conflict: binding redirects on .NET Fx and version conflicts with Functions load contexts
    public static ActivityContext ExtractTraceContext(this EventData @event)
    {
        if (@event.Properties.TryGetValue("Diagnostic-Id", out var tp) && tp is string traceparent)
        {

lmolkova

package org.example.functions;

import com.azure.core.models.CloudEvent;
import com.azure.core.util.serializer.TypeReference;
import com.azure.messaging.eventgrid.EventGridEvent;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.microsoft.azure.functions.ExecutionContext;
import com.microsoft.azure.functions.HttpMethod;
import com.microsoft.azure.functions.HttpRequestMessage;