Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
Konsol telemetri verilerini incelemenin önerilen bir yolu olmasa da, kullanmaya başlamanın basit ve hızlı bir yoludur. Bu makalede, en düşük Çekirdek kurulumuyla denetleme için konsola telemetri verilerinin nasıl çıkışını oluşturabileceğiniz gösterilmektedir.
İhracatçı
Bir hedefe telemetri verileri göndermek, ihracatçıların sorumluluğundadır. İhracatçılar hakkında daha fazla bilgiyi burada bulabilirsiniz. Bu örnekte, konsola telemetri verilerinin çıkışını almak için konsol dışarı aktarmayı kullanırız.
Önkoşullar
- Azure OpenAI sohbet tamamlama dağıtımı.
- İşletim sisteminiz için en son .Net SDK'sı .
- Azure OpenAI sohbet tamamlama dağıtımı.
- Python 3.10, 3.11 veya 3.12 makinenizde yüklüdür.
Not
Semantik Çekirdek Gözlemlenebilirliği henüz Java için kullanılamıyor.
Ayarlama
Yeni konsol uygulaması oluşturma
Bir terminalde aşağıdaki komutu çalıştırarak C# dilinde yeni bir konsol uygulaması oluşturun:
dotnet new console -n TelemetryConsoleQuickstart
Komut tamamlandıktan sonra yeni oluşturulan proje dizinine gidin.
Gerekli paketleri yükleme
Semantik Çekirdek
dotnet add package Microsoft.SemanticKernelOpenTelemetry Konsolu Dışarı Aktarma
dotnet add package OpenTelemetry.Exporter.Console
Anlam Çekirdeği ile basit bir uygulama oluşturma
Proje dizininden dosyayı sık kullandığınız düzenleyiciyle açın Program.cs . Sohbet tamamlama modeline istem göndermek için Anlam Çekirdeği kullanan basit bir uygulama oluşturacağız. Var olan içeriği aşağıdaki kodla değiştirin ve , deploymentNameve endpointiçin apiKeygerekli değerleri doldurun:
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 TelemetryConsoleQuickstart
{
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);
}
}
}
Telemetri ekleme
Konsol uygulamasını şimdi çalıştırıyorsanız gökyüzünün neden mavi olduğunu açıklayan bir cümle görmeniz gerekir. Telemetri yoluyla çekirdeği gözlemlemek için açıklamasını aşağıdaki kodla değiştirin // Telemetry setup code goes here :
var resourceBuilder = ResourceBuilder
.CreateDefault()
.AddService("TelemetryConsoleQuickstart");
// Enable model diagnostics with sensitive data.
AppContext.SetSwitch("Microsoft.SemanticKernel.Experimental.GenAI.EnableOTelDiagnosticsSensitive", true);
using var traceProvider = Sdk.CreateTracerProviderBuilder()
.SetResourceBuilder(resourceBuilder)
.AddSource("Microsoft.SemanticKernel*")
.AddConsoleExporter()
.Build();
using var meterProvider = Sdk.CreateMeterProviderBuilder()
.SetResourceBuilder(resourceBuilder)
.AddMeter("Microsoft.SemanticKernel*")
.AddConsoleExporter()
.Build();
using var loggerFactory = LoggerFactory.Create(builder =>
{
// Add OpenTelemetry as a logging provider
builder.AddOpenTelemetry(options =>
{
options.SetResourceBuilder(resourceBuilder);
options.AddConsoleExporter();
// Format log messages. This is default to false.
options.IncludeFormattedMessage = true;
options.IncludeScopes = true;
});
builder.SetMinimumLevel(LogLevel.Information);
});
Son olarak, günlükçü fabrikasını oluşturucuya eklemek için satırın // builder.Services.AddSingleton(loggerFactory); açıklamasını kaldırın.
Yukarıdaki kod parçacığında, önce kaynak örnekleri oluşturmak için bir kaynak oluşturucu oluştururuz. Kaynak, telemetri verileri üreten varlığı temsil eder. Kaynaklar hakkında daha fazla bilgiyi buradan okuyabilirsiniz. Sağlayıcılar için kaynak oluşturucu isteğe bağlıdır. Sağlanmazsa, varsayılan özniteliklere sahip varsayılan kaynak kullanılır.
Ardından hassas verilerle tanılamayı açacağız. Bu, Anlam Çekirdeğindeki yapay zeka hizmetleri için tanılamayı etkinleştirmenizi sağlayan deneysel bir özelliktir. Bu açıkken, gönderilen istemler ve yapay zeka modellerinden alınan yanıtlar gibi hassas veriler olarak kabul edilen ek telemetri verileri görürsünüz. Telemetrinize hassas veriler eklemek istemiyorsanız model adı, işlem adı ve belirteç kullanımı gibi hassas olmayan verilerle tanılamayı etkinleştirmek için başka bir anahtar Microsoft.SemanticKernel.Experimental.GenAI.EnableOTelDiagnostics kullanabilirsiniz.
Ardından bir izleyici sağlayıcı oluşturucusu ve ölçüm sağlayıcısı oluşturucusu oluşturacağız. Bir sağlayıcı telemetri verilerini işlemek ve bunları ihracatçılara göndermekle sorumludur. Semantik Çekirdek ad alanından telemetri verilerini almak için kaynağa aboneyiz Microsoft.SemanticKernel* . Hem izleyici sağlayıcısına hem de ölçüm sağlayıcısına bir konsol verme sağlayıcısı ekliyoruz. Konsol veren, telemetri verilerini konsola gönderir.
Son olarak bir günlükçü fabrikası oluşturup OpenTelemetry'i günlük verilerini konsola gönderen bir günlük sağlayıcısı olarak ekleyeceğiz. En düşük günlük düzeyini Information olarak ayarlayıp biçimlendirilmiş iletileri ve kapsamları günlük çıkışına dahil ediyoruz. Daha sonra günlükçü fabrikası oluşturucuya eklenir.
Önemli
Sağlayıcı tekil olmalı ve tüm uygulama ömrü boyunca canlı olmalıdır. Uygulama kapatılırken sağlayıcı atılmalıdır.
Yeni bir Python sanal ortamı oluşturma
python -m venv telemetry-console-quickstart
Sanal ortamı etkinleştirin.
telemetry-console-quickstart\Scripts\activate
Gerekli paketleri yükleme
pip install semantic-kernel
Anlam Çekirdeği ile basit bir Python betiği oluşturma
Yeni bir Python betiği oluşturun ve en sevdiğiniz düzenleyiciyle açın.
New-Item -Path telemetry_console_quickstart.py -ItemType file
Sohbet tamamlama modeline istem göndermek için Anlam Çekirdeği kullanan basit bir Python betiği oluşturacağız. Var olan içeriği aşağıdaki kodla değiştirin ve , deployment_nameve endpointiçin api_keygerekli değerleri doldurun:
import asyncio
import logging
from opentelemetry._logs import set_logger_provider
from opentelemetry.metrics import set_meter_provider
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor, ConsoleLogExporter
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import ConsoleMetricExporter, 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, ConsoleSpanExporter
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())
Telemetri ekleme
Ortam değişkenleri
Varsayılan olarak, bu span'lar deneysel olarak kabul edilen öznitelikleri taşıdığından gen_ai çekirdek yapay zeka bağlayıcıları için yayılmaz. Özelliği etkinleştirmek için ortam değişkenini SEMANTICKERNEL_EXPERIMENTAL_GENAI_ENABLE_OTEL_DIAGNOSTICS veya SEMANTICKERNEL_EXPERIMENTAL_GENAI_ENABLE_OTEL_DIAGNOSTICS_SENSITIVE olarak trueayarlayın.
Önemli
İstemler ve tamamlamalar hassas veriler olarak kabul edilir. Semantik Çekirdek, ortam değişkeni olarak ayarlanmadığı SEMANTICKERNEL_EXPERIMENTAL_GENAI_ENABLE_OTEL_DIAGNOSTICS_SENSITIVEsürece true yapay zeka bağlayıcılarından bu verileri yaymaz. ayarı SEMANTICKERNEL_EXPERIMENTAL_GENAI_ENABLE_OTEL_DIAGNOSTICStrue yalnızca model adı, işlem adı ve belirteç kullanımı gibi hassas olmayan verileri yayar.
Betiğinizle aynı dizinde adlı .env yeni bir dosya oluşturun ve aşağıdaki içeriği ekleyin:
SEMANTICKERNEL_EXPERIMENTAL_GENAI_ENABLE_OTEL_DIAGNOSTICS_SENSITIVE=true
Kod
Betiği şimdi çalıştırırsanız gökyüzünün neden mavi olduğunu açıklayan bir cümle görmeniz gerekir. Telemetri yoluyla çekirdeği gözlemlemek için açıklamasını aşağıdaki kodla değiştirin # Telemetry setup code goes here :
# Create a resource to represent the service/sample
resource = Resource.create({ResourceAttributes.SERVICE_NAME: "telemetry-console-quickstart"})
def set_up_logging():
exporter = ConsoleLogExporter()
# 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 = ConsoleSpanExporter()
# 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 = ConsoleMetricExporter()
# 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()
Yukarıdaki kod parçacığında, önce hizmeti temsil eden bir kaynak oluştururuz. Kaynak, telemetri verileri üreten varlığı temsil eder. Kaynaklar hakkında daha fazla bilgiyi buradan okuyabilirsiniz. Ardından günlüğe kaydetme, izleme ve ölçümleri ayarlamak için üç işlev oluştururuz. Her işlev, ilgili telemetri verileri için bir sağlayıcı oluşturur ve sağlayıcıya bir konsol dışarı aktarması ekler.
Son olarak günlüğe kaydetme, izleme ve ölçümleri ayarlamak için üç işlevi çağırırız. Bu, diğer telemetri çağrıları öncesinde yapılmalıdır.
Not
Semantik Çekirdek Gözlemlenebilirliği henüz Java için kullanılamıyor.
Çalıştır
Konsol uygulamasını aşağıdaki komutla çalıştırın:
dotnet run
Python betiğini aşağıdaki komutla çalıştırın:
python telemetry_console_quickstart.py
Not
Semantik Çekirdek Gözlemlenebilirliği henüz Java için kullanılamıyor.
Telemetri verilerini inceleme
Kayıtları günlüğe kaydetme
Konsol çıkışında birden çok günlük kaydı görmeniz gerekir. Bunlar aşağıdakine benzer:
LogRecord.Timestamp: 2024-09-12T21:48:35.2295938Z
LogRecord.TraceId: 159d3f07664838f6abdad7af6a892cfa
LogRecord.SpanId: ac79a006da8a6215
LogRecord.TraceFlags: Recorded
LogRecord.CategoryName: Microsoft.SemanticKernel.KernelFunction
LogRecord.Severity: Info
LogRecord.SeverityText: Information
LogRecord.FormattedMessage: Function InvokePromptAsync_290eb9bece084b00aea46b569174feae invoking.
LogRecord.Body: Function {FunctionName} invoking.
LogRecord.Attributes (Key:Value):
FunctionName: InvokePromptAsync_290eb9bece084b00aea46b569174feae
OriginalFormat (a.k.a Body): Function {FunctionName} invoking.
Resource associated with LogRecord:
service.name: TelemetryConsoleQuickstart
service.instance.id: a637dfc9-0e83-4435-9534-fb89902e64f8
telemetry.sdk.name: opentelemetry
telemetry.sdk.language: dotnet
telemetry.sdk.version: 1.9.0
Her günlük kaydının iki bölümü vardır:
- Günlük kaydının kendisi: Günlük kaydının oluşturulduğu zaman damgasını ve ad alanını, günlük kaydının önem derecesini ve gövdesini ve günlük kaydıyla ilişkili tüm öznitelikleri içerir.
- Günlük kaydıyla ilişkilendirilmiş kaynak: Günlük kaydını oluşturmak için kullanılan hizmet, örnek ve SDK hakkında bilgi içerir.
Aktiviteler
Not
.Net'teki etkinlikler OpenTelemetry'deki span'lara benzer. Uygulamadaki bir iş birimini temsil etmek için kullanılırlar.
Konsol çıkışında birden çok etkinlik görmeniz gerekir. Bunlar aşağıdakine benzer:
Activity.TraceId: 159d3f07664838f6abdad7af6a892cfa
Activity.SpanId: 8c7c79bc1036eab3
Activity.TraceFlags: Recorded
Activity.ParentSpanId: ac79a006da8a6215
Activity.ActivitySourceName: Microsoft.SemanticKernel.Diagnostics
Activity.DisplayName: chat.completions gpt-4o
Activity.Kind: Client
Activity.StartTime: 2024-09-12T21:48:35.5717463Z
Activity.Duration: 00:00:02.3992014
Activity.Tags:
gen_ai.operation.name: chat.completions
gen_ai.system: openai
gen_ai.request.model: gpt-4o
gen_ai.response.prompt_tokens: 16
gen_ai.response.completion_tokens: 29
gen_ai.response.finish_reason: Stop
gen_ai.response.id: chatcmpl-A6lxz14rKuQpQibmiCpzmye6z9rxC
Activity.Events:
gen_ai.content.prompt [9/12/2024 9:48:35 PM +00:00]
gen_ai.prompt: [{"role": "user", "content": "Why is the sky blue in one sentence?"}]
gen_ai.content.completion [9/12/2024 9:48:37 PM +00:00]
gen_ai.completion: [{"role": "Assistant", "content": "The sky appears blue because shorter blue wavelengths of sunlight are scattered in all directions by the gases and particles in the Earth\u0027s atmosphere more than other colors."}]
Resource associated with Activity:
service.name: TelemetryConsoleQuickstart
service.instance.id: a637dfc9-0e83-4435-9534-fb89902e64f8
telemetry.sdk.name: opentelemetry
telemetry.sdk.language: dotnet
telemetry.sdk.version: 1.9.0
Her etkinliğin iki bölümü vardır:
- Etkinliğin kendisi: APM araçlarının izlemeleri, etkinliğin süresini ve etkinlikle ilişkili etiketleri ve olayları oluşturmak için kullandığı yayılma kimliği ve üst yayılma kimliği içerir.
- Etkinlikle ilişkili kaynak: etkinliği oluşturmak için kullanılan hizmet, örnek ve SDK hakkında bilgi içerir.
Önemli
ek dikkat etmeniz gereken öznitelikler ile gen_aibaşlayan özniteliklerdir. Bunlar, GenAI Anlam Kuralları'nda belirtilen özniteliklerdir.
Ölçümler
Konsol çıkışında birden çok ölçüm kaydı görmeniz gerekir. Bunlar aşağıdakine benzer:
Metric Name: semantic_kernel.connectors.openai.tokens.prompt, Number of prompt tokens used, Unit: {token}, Meter: Microsoft.SemanticKernel.Connectors.OpenAI
(2024-09-12T21:48:37.9531072Z, 2024-09-12T21:48:38.0966737Z] LongSum
Value: 16
Burada adı, açıklamayı, birimi, zaman aralığını, türü, ölçümün değerini ve ölçümün ait olduğu ölçümü görebilirsiniz.
Not
Yukarıdaki ölçüm bir Sayaç ölçümüdür. Ölçüm türlerinin tam listesi için buraya bakın. Ölçümün türüne bağlı olarak çıkış değişebilir.
Günlükler
Konsol çıkışında birden çok günlük kaydı görmeniz gerekir. Bunlar aşağıdakine benzer:
{
"body": "Function SyVCcBjaULqEhItH invoking.",
"severity_number": "<SeverityNumber.INFO: 9>",
"severity_text": "INFO",
"attributes": {
"code.filepath": "C:\\tmp\\telemetry-console-quickstart\\Lib\\site-packages\\semantic_kernel\\functions\\kernel_function_log_messages.py",
"code.function": "log_function_invoking",
"code.lineno": 19
},
"dropped_attributes": 0,
"timestamp": "2024-09-13T17:55:45.504983Z",
"observed_timestamp": "2024-09-13T17:55:45.504983Z",
"trace_id": "0xe23e2c10785ea61ffc9f28be19482a80",
"span_id": "0x686bd592e27661d7",
"trace_flags": 1,
"resource": {
"attributes": {
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": "1.27.0",
"service.name": "telemetry-console-quickstart"
},
"schema_url": ""
}
}
Yayılan
Konsol çıkışında birden çok yayılma alanı görmeniz gerekir. Bunlar aşağıdakine benzer:
{
"name": "chat.completions gpt-4o",
"context": {
"trace_id": "0xe23e2c10785ea61ffc9f28be19482a80",
"span_id": "0x8b20e9655610c3c9",
"trace_state": "[]"
},
"kind": "SpanKind.INTERNAL",
"parent_id": "0x686bd592e27661d7",
"start_time": "2024-09-13T17:55:45.515198Z",
"end_time": "2024-09-13T17:55:46.469471Z",
"status": {
"status_code": "UNSET"
},
"attributes": {
"gen_ai.operation.name": "chat.completions",
"gen_ai.system": "openai",
"gen_ai.request.model": "gpt-4o",
"gen_ai.response.id": "chatcmpl-A74oD7WGDjawnZ44SJZrj9fKrEv1B",
"gen_ai.response.finish_reason": "FinishReason.STOP",
"gen_ai.response.prompt_tokens": 16,
"gen_ai.response.completion_tokens": 29
},
"events": [
{
"name": "gen_ai.content.prompt",
"timestamp": "2024-09-13T17:55:45.515198Z",
"attributes": {
"gen_ai.prompt": "[{\"role\": \"user\", \"content\": \"Why is the sky blue in one sentence?\"}]"
}
},
{
"name": "gen_ai.content.completion",
"timestamp": "2024-09-13T17:55:46.469471Z",
"attributes": {
"gen_ai.completion": "[{\"role\": \"assistant\", \"content\": \"The sky appears blue because shorter blue wavelengths of sunlight are scattered in all directions by the molecules and particles in the atmosphere more effectively than other colors.\"}]"
}
}
],
"links": [],
"resource": {
"attributes": {
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": "1.27.0",
"service.name": "telemetry-console-quickstart"
},
"schema_url": ""
}
}
ile gen_aibaşlayan özniteliklere dikkat edin. Bunlar, GenAI Anlam Kuralları'nda belirtilen özniteliklerdir. AI modellerine gönderilen istekler ve yapay zeka modellerinden alınan yanıtlar hakkında yararlı bilgiler sağlar.
Ölçümler
Konsol çıkışında birden çok ölçüm kaydı görmeniz gerekir. Bunlar aşağıdakine benzer:
{
"resource_metrics": [
{
"resource": {
"attributes": {
"telemetry.sdk.language": "python",
"telemetry.sdk.name": "opentelemetry",
"telemetry.sdk.version": "1.27.0",
"service.name": "telemetry-console-quickstart"
},
"schema_url": ""
},
"scope_metrics": [
{
"scope": {
"name": "semantic_kernel.functions.kernel_function",
"version": null,
"schema_url": "",
"attributes": null
},
"metrics": [
{
"name": "semantic_kernel.function.invocation.duration",
"description": "Measures the duration of a function's execution",
"unit": "s",
"data": {
"data_points": [
{
"attributes": {
"semantic_kernel.function.name": "SyVCcBjaULqEhItH"
},
"start_time_unix_nano": 1726250146470468300,
"time_unix_nano": 1726250146478526600,
"count": 1,
"sum": 0.9650602999900002,
"bucket_counts": [
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"explicit_bounds": [
0.0,
5.0,
10.0,
25.0,
50.0,
75.0,
100.0,
250.0,
500.0,
750.0,
1000.0,
2500.0,
5000.0,
7500.0,
10000.0
],
"min": 0.9650602999900002,
"max": 0.9650602999900002
}
],
"aggregation_temporality": 2
}
}
],
"schema_url": ""
}
],
"schema_url": ""
}
]
}
Yukarıda gösterilen ölçüm bir histogram ölçümüdür. Ölçüm türlerinin tam listesi için buraya bakın.
Not
Semantik Çekirdek Gözlemlenebilirliği henüz Java için kullanılamıyor.
Sonraki adımlar
Artık konsola telemetri verilerini başarıyla çıkardığınıza göre, telemetri verilerini görselleştirmek ve analiz etmek için APM araçlarını kullanma hakkında daha fazla bilgi edinebilirsiniz.