Azure Cosmos DB SDK 가시성

적용 대상: NoSQL

Azure Cosmos DB .NET 및 Java SDK는 애플리케이션을 모니터링하는 데 도움이 되는 분산 추적을 지원합니다. 요청 흐름을 추적하면 디버깅, 대기 시간,업 성능 분석 및 진단 수집에 유용합니다. OpenTelemetry를 사용하여 애플리케이션에 대한 계측 및 추적을 수행하세요. 이는 공급업체에 구애받지 않으며, 선택한 내보내기와 관계없이 표준화된 데이터 형식을 보장하기 위한 의미 체계 규칙 세트를 제공합니다. 또는 Application Insights SDK 또는 Azure Monitor OpenTelemetry Distro를 사용할 수 있습니다.

시작하기

분산 추적은 다음 SDK에서 사용할 수 있습니다.

추적 특성

Azure Cosmos DB 추적은 OpenTelemetry 데이터베이스 사양을 따르며 몇 가지 사용자 지정 특성도 제공합니다. 요청 작업에 따라 다른 특성을 볼 수 있으며 이러한 특성은 모든 요청에 대한 핵심 특성입니다.

진단 수집

추적 공급자에서 로그를 구성한 경우 실패했거나 대기 시간이 긴 Azure Cosmos DB 요청에 대한 진단을 자동으로 받을 수 있습니다. 이러한 로그는 사용자 지정 코드를 캡처할 필요 없이 실패한 요청과 느린 요청을 진단하는 데 도움이 될 수 있습니다.

CosmosClientOptions options = new CosmosClientOptions()
{
    CosmosClientTelemetryOptions = new CosmosClientTelemetryOptions()
    {
        DisableDistributedTracing = false,
        CosmosThresholdOptions = new CosmosThresholdOptions()
        {
            PointOperationLatencyThreshold = TimeSpan.FromMilliseconds(100),
            NonPointOperationLatencyThreshold = TimeSpan.FromMilliseconds(500)
        }
    },
};

{ 
    "Logging": {​
        "LogLevel": {​
            "Azure-Cosmos-Operation-Request-Diagnostics": "Information"​
        }​
    }
}

    CosmosAsyncClient client = new CosmosClientBuilder()
            .endpoint("<Your account endpoint>")
            .key("<Your account key>")
            .clientTelemetryConfig(new CosmosClientTelemetryConfig()
                .diagnosticsThresholds(
                    new CosmosDiagnosticsThresholds()
                        .setPointOperationLatencyThreshold(Duration.ofMillis(100))
                        .setNonPointOperationLatencyThreshold(Duration.ofMillis(2000))
                        .setRequestChargeThreshold(100)))
            .buildAsyncClient();

OpenTelemetry 구성

Azure Cosmos DB SDK에서 OpenTelemetry를 사용하려면 추적 공급자에 Azure.Cosmos.Operation 원본을 추가합니다. OpenTelemetry는 데이터를 수집할 수 있는 다양한 내보내기 도구와 호환됩니다. 다음 샘플에서는 Azure Monitor OpenTelemetry Exporter를 사용하지만 원하는 내보내기를 구성하도록 선택할 수 있습니다. 선택한 내보내기자에 따라 최대 몇 분의 데이터 수집이 지연될 수 있습니다.

이 샘플에서는 .NET 콘솔 앱에 대해 OpenTelemetry를 구성하는 방법을 보여줍니다. GitHub에서 전체 샘플을 참조하세요.

ResourceBuilder resource = ResourceBuilder.CreateDefault().AddService(
            serviceName: serviceName,
            serviceVersion: "1.0.0");

// Set up logging to forward logs to chosen exporter
using ILoggerFactory loggerFactory
    = LoggerFactory.Create(builder => builder
                                        .AddConfiguration(configuration.GetSection("Logging"))
                                        .AddOpenTelemetry(options =>
                                        {
                                            options.IncludeFormattedMessage = true;
                                            options.SetResourceBuilder(resource);
                                            options.AddAzureMonitorLogExporter(o => o.ConnectionString = aiConnectionString); // Set up exporter of your choice
                                        }));
/*.AddFilter(level => level == LogLevel.Error) // Filter  is irrespective of event type or event name*/

AzureEventSourceLogForwarder logforwader = new AzureEventSourceLogForwarder(loggerFactory);
logforwader.Start();

// Configure OpenTelemetry trace provider
AppContext.SetSwitch("Azure.Experimental.EnableActivitySource", true);
_traceProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("Azure.Cosmos.Operation", // Cosmos DB source for operation level telemetry
               "Sample.Application") 
    .AddAzureMonitorTraceExporter(o => o.ConnectionString = aiConnectionString) // Set up exporter of your choice
    .AddHttpClientInstrumentation() // Added to capture HTTP telemetry
    .SetResourceBuilder(resource)
    .Build();

Application Insights SDK 구성

애플리케이션이 작성된 언어와 컴퓨팅 환경에 따라 Application Insights를 구성하는 방법에는 여러 가지가 있습니다. 자세한 내용은 Application Insights 설명서를 참조하세요. Application Insights로 데이터를 수집하는 데 최대 몇 분이 걸릴 수 있습니다.

다음 샘플에서는 .NET 콘솔 앱에 대해 Application Insights를 구성하는 방법을 보여 줍니다. GitHub에서 전체 샘플을 참조하세요.

IServiceCollection services = new ServiceCollection();
services.AddApplicationInsightsTelemetryWorkerService((ApplicationInsightsServiceOptions options) => options.ConnectionString = aiConnectionString);

IServiceProvider serviceProvider = services.BuildServiceProvider();
telemetryClient = serviceProvider.GetRequiredService<TelemetryClient>();

추적 데이터가 Application Insights로 수집되면 Azure Portal에서 시각화하여 애플리케이션의 요청 흐름을 이해할 수 있습니다. 다음은 Azure Portal의 왼쪽 탐색에 있는 트랜잭션 검색에서 파티션 간 쿼리의 추적 데이터 예입니다.

다음 단계

• .NET SDK 시작
• Java SDK 시작
• Azure Cosmos DB 모니터링