OpenTelemetry.Resources.Azure 1.18.0-beta.2

Resource Detectors for Azure cloud environments

This package contains Resource Detectors for applications running in Azure environment.

Installation

dotnet add package --prerelease OpenTelemetry.Resources.Azure

App Service Resource Detector

Adds resource attributes for the applications running in Azure App Service. The following example shows how to add AppServiceResourceDetector to the ResourceBuilder.

using OpenTelemetry;
using OpenTelemetry.Resources;

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureAppServiceDetector())
    // other configurations
    .Build();

using var meterProvider = Sdk.CreateMeterProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureAppServiceDetector())
    // other configurations
    .Build();

using var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        options.SetResourceBuilder(ResourceBuilder.CreateDefault().AddAzureAppServiceDetector());
    });
});

VM Resource Detector

Adds resource attributes for the applications running in an Azure virtual machine. The following example shows how to add AzureVMResourceDetector to the ResourceBuilder.

using OpenTelemetry;
using OpenTelemetry.Resources;

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureVMDetector())
    // other configurations
    .Build();

using var meterProvider = Sdk.CreateMeterProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureVMDetector())
    // other configurations
    .Build();

Unlike the other detectors in this package, the VM detector reads these values from the Azure Instance Metadata Service rather than from environment variables.

Azure Container Apps Resource Detector

Adds resource attributes for the applications running in Azure Container Apps or Azure Container App jobs. The following example shows how to add AzureContainerAppsResourceDetector to the ResourceBuilder.

using OpenTelemetry;
using OpenTelemetry.Resources;

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureContainerAppsDetector())
    // other configurations
    .Build();

using var meterProvider = Sdk.CreateMeterProviderBuilder()
    .ConfigureResource(resource => resource.AddAzureContainerAppsDetector())
    // other configurations
    .Build();

Troubleshooting

This component uses an EventSource with the name "OpenTelemetry-Resources-Azure" for its internal logging. Please refer to SDK troubleshooting for instructions on seeing these internal logs.

A detector writes a Verbose event naming itself and the environment variables it looked for when none are set and it therefore contributes no attributes.