Kontrola telemetrických dat pomocí řídicího panelu Aspire

Řídicí panel Aspire je součástí nabídky .NET Aspire . Řídicí panel umožňuje vývojářům monitorovat a kontrolovat distribuované aplikace.

V tomto příkladu použijeme samostatný režim a naučíme se exportovat telemetrická data do řídicího panelu Aspire a prozkoumat data tam.

Vývozce

Exportéři zodpovídají za odesílání telemetrických dat do cíle. Přečtěte si další informace o vývozcích zde. V tomto příkladu použijeme vývozce protokolu OTLP (OpenTelemetry Protocol) k odesílání telemetrických dat do řídicího panelu Aspire.

Požadavky

• Nasazení dokončení chatu Azure OpenAI
• Docker
• Nejnovější sada .NET SDK pro váš operační systém.

• Nasazení dokončení chatu Azure OpenAI
• Docker
• Na počítači je nainstalovaný Python 3.10, 3.11 nebo 3.12 .

Poznámka:

Sémantická pozorovatelnost jádra zatím není pro Javu k dispozici.

Nastavení

Vytvoření nové konzolové aplikace

Spuštěním následujícího příkazu v terminálu vytvořte novou konzolovou aplikaci v jazyce C#:

dotnet new console -n TelemetryAspireDashboardQuickstart

Po dokončení příkazu přejděte do nově vytvořeného adresáře projektu.

Instalace požadovaných balíčků

• Sémantické jádro

  dotnet add package Microsoft.SemanticKernel
  

• Exportér konzoly OpenTelemetry

  dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
  

Vytvoření jednoduché aplikace pomocí sémantického jádra

V adresáři projektu otevřete Program.cs soubor v oblíbeném editoru. Vytvoříme jednoduchou aplikaci, která používá sémantické jádro k odeslání výzvy do modelu dokončování chatu. Nahraďte stávající obsah následujícím kódem a vyplňte požadované hodnoty pro deploymentName, endpointa apiKey:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.SemanticKernel;
using OpenTelemetry;
using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;

namespace TelemetryAspireDashboardQuickstart
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // Telemetry setup code goes here

            IKernelBuilder builder = Kernel.CreateBuilder();
            // builder.Services.AddSingleton(loggerFactory);
            builder.AddAzureOpenAIChatCompletion(
                deploymentName: "your-deployment-name",
                endpoint: "your-azure-openai-endpoint",
                apiKey: "your-azure-openai-api-key"
            );

            Kernel kernel = builder.Build();

            var answer = await kernel.InvokePromptAsync(
                "Why is the sky blue in one sentence?"
            );

            Console.WriteLine(answer);
        }
    }
}

Přidání telemetrie

Pokud teď spustíte konzolovou aplikaci, měli byste očekávat větu s vysvětlením, proč je obloha modrá. Pokud chcete sledovat jádro prostřednictvím telemetrie, nahraďte // Telemetry setup code goes here komentář následujícím kódem:

// Endpoint to the Aspire Dashboard
var endpoint = "http://localhost:4317";

var resourceBuilder = ResourceBuilder
    .CreateDefault()
    .AddService("TelemetryAspireDashboardQuickstart");

// Enable model diagnostics with sensitive data.
AppContext.SetSwitch("Microsoft.SemanticKernel.Experimental.GenAI.EnableOTelDiagnosticsSensitive", true);

using var traceProvider = Sdk.CreateTracerProviderBuilder()
    .SetResourceBuilder(resourceBuilder)
    .AddSource("Microsoft.SemanticKernel*")
    .AddOtlpExporter(options => options.Endpoint = new Uri(endpoint))
    .Build();

using var meterProvider = Sdk.CreateMeterProviderBuilder()
    .SetResourceBuilder(resourceBuilder)
    .AddMeter("Microsoft.SemanticKernel*")
    .AddOtlpExporter(options => options.Endpoint = new Uri(endpoint))
    .Build();

using var loggerFactory = LoggerFactory.Create(builder =>
{
    // Add OpenTelemetry as a logging provider
    builder.AddOpenTelemetry(options =>
    {
        options.SetResourceBuilder(resourceBuilder);
        options.AddOtlpExporter(options => options.Endpoint = new Uri(endpoint));
        // Format log messages. This is default to false.
        options.IncludeFormattedMessage = true;
        options.IncludeScopes = true;
    });
    builder.SetMinimumLevel(LogLevel.Information);
});

Nakonec odkomentujte řádek // builder.Services.AddSingleton(loggerFactory); pro přidání objektu pro protokolování do tvůrce.

Další informace o kódu nastavení telemetrie najdete v tomto článku . Jediným rozdílem je, že používáme AddOtlpExporter k exportu telemetrických dat do řídicího panelu Aspire.

Vytvoření nového virtuálního prostředí Pythonu

python -m venv telemetry-aspire-dashboard-quickstart

Aktivujte virtuální prostředí.

telemetry-aspire-dashboard-quickstart\Scripts\activate

Instalace požadovaných balíčků

pip install semantic-kernel opentelemetry-exporter-otlp-proto-grpc

Vytvoření jednoduchého skriptu Pythonu s sémantickým jádrem

Vytvořte nový skript Pythonu a otevřete ho v oblíbeném editoru.

Powershell

New-Item -Path telemetry_aspire_dashboard_quickstart.py -ItemType file

Udeřit

touch telemetry_aspire_dashboard_quickstart.py

Vytvoříme jednoduchý skript Pythonu, který používá sémantické jádro k odeslání výzvy do modelu dokončování chatu. Nahraďte stávající obsah následujícím kódem a vyplňte požadované hodnoty pro deployment_name, endpointa api_key:

import asyncio
import logging

from opentelemetry._logs import set_logger_provider
from opentelemetry.exporter.otlp.proto.grpc._log_exporter import OTLPLogExporter
from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.metrics import set_meter_provider
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
from opentelemetry.sdk.metrics.view import DropAggregation, View
from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.semconv.resource import ResourceAttributes
from opentelemetry.trace import set_tracer_provider

from semantic_kernel import Kernel
from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion


# Telemetry setup code goes here

async def main():
    # Create a kernel and add a service
    kernel = Kernel()
    kernel.add_service(AzureChatCompletion(
        api_key="your-azure-openai-api-key",
        endpoint="your-azure-openai-endpoint",
        deployment_name="your-deployment-name"
    ))

    answer = await kernel.invoke_prompt("Why is the sky blue in one sentence?")
    print(answer)


if __name__ == "__main__":
    asyncio.run(main())

Přidání telemetrie

Proměnné prostředí

Další informace o nastavení požadovaných proměnných prostředí pro povolení generování rozsahů pro konektory AI najdete v tomto článku .

Kód

Pokud skript spustíte teď, měli byste očekávat, že uvidíte větu s vysvětlením, proč je obloha modrá. Pokud chcete sledovat jádro prostřednictvím telemetrie, nahraďte # Telemetry setup code goes here komentář následujícím kódem:

# Endpoint to the Aspire Dashboard
endpoint = "http://localhost:4317"

# Create a resource to represent the service/sample
resource = Resource.create({ResourceAttributes.SERVICE_NAME: "telemetry-aspire-dashboard-quickstart"})


def set_up_logging():
    exporter = OTLPLogExporter(endpoint=endpoint)

    # Create and set a global logger provider for the application.
    logger_provider = LoggerProvider(resource=resource)
    # Log processors are initialized with an exporter which is responsible
    # for sending the telemetry data to a particular backend.
    logger_provider.add_log_record_processor(BatchLogRecordProcessor(exporter))
    # Sets the global default logger provider
    set_logger_provider(logger_provider)

    # Create a logging handler to write logging records, in OTLP format, to the exporter.
    handler = LoggingHandler()
    # Add filters to the handler to only process records from semantic_kernel.
    handler.addFilter(logging.Filter("semantic_kernel"))
    # Attach the handler to the root logger. `getLogger()` with no arguments returns the root logger.
    # Events from all child loggers will be processed by this handler.
    logger = logging.getLogger()
    logger.addHandler(handler)
    logger.setLevel(logging.INFO)


def set_up_tracing():
    exporter = OTLPSpanExporter(endpoint=endpoint)

    # Initialize a trace provider for the application. This is a factory for creating tracers.
    tracer_provider = TracerProvider(resource=resource)
    # Span processors are initialized with an exporter which is responsible
    # for sending the telemetry data to a particular backend.
    tracer_provider.add_span_processor(BatchSpanProcessor(exporter))
    # Sets the global default tracer provider
    set_tracer_provider(tracer_provider)


def set_up_metrics():
    exporter = OTLPMetricExporter(endpoint=endpoint)

    # Initialize a metric provider for the application. This is a factory for creating meters.
    meter_provider = MeterProvider(
        metric_readers=[PeriodicExportingMetricReader(exporter, export_interval_millis=5000)],
        resource=resource,
        views=[
            # Dropping all instrument names except for those starting with "semantic_kernel"
            View(instrument_name="*", aggregation=DropAggregation()),
            View(instrument_name="semantic_kernel*"),
        ],
    )
    # Sets the global default meter provider
    set_meter_provider(meter_provider)


# This must be done before any other telemetry calls
set_up_logging()
set_up_tracing()
set_up_metrics()

Další informace o kódu nastavení telemetrie najdete v tomto článku . Jediným rozdílem je, že používáme OTLP[Span|Metric|Log]Exporter k exportu telemetrických dat do řídicího panelu Aspire.

Poznámka:

Sémantická pozorovatelnost jádra zatím není pro Javu k dispozici.

Spuštění řídicího panelu Aspire

Podle zde uvedených pokynů spusťte řídicí panel. Po spuštění řídicího panelu otevřete prohlížeč a přejděte na http://localhost:18888 řídicí panel.

Spustit

Spusťte konzolovou aplikaci pomocí následujícího příkazu:

dotnet run

Spusťte skript Pythonu pomocí následujícího příkazu:

python telemetry_aspire_dashboard_quickstart.py

Poznámka:

Sémantická pozorovatelnost jádra zatím není pro Javu k dispozici.

Kontrola telemetrických dat

Po spuštění aplikace přejděte na řídicí panel a zkontrolujte telemetrická data.

Tip

Pokud chcete prozkoumat rozhraní řídicího panelu Aspire, postupujte podle tohoto průvodce .

Trasování

Pokud aplikaci spustíte poprvé po spuštění řídicího panelu, měla by se zobrazit karta s jedním trasováním Traces . Kliknutím na trasování zobrazíte další podrobnosti.

V podrobnostech trasování můžete zobrazit rozsah, který představuje funkci výzvy, a rozsah, který představuje model dokončení chatu. Kliknutím na rozsah dokončení chatu zobrazíte podrobnosti o žádosti a odpovědi.

Tip

Atributy rozsahů můžete filtrovat a najít ten, který vás zajímá.

Protokoly

Přejděte na Structured kartu a zobrazte protokoly generované aplikací. V tomto průvodci se dozvíte, jak pracovat se strukturovanými protokoly na řídicím panelu.

Další kroky

Teď, když úspěšně vypíšete telemetrická data do řídicího panelu Aspire, můžete prozkoumat další funkce sémantického jádra, které vám pomůžou monitorovat a diagnostikovat aplikaci:

Pokročilá telemetrie s sémantickým jádrem