Bagikan melalui

Mengonfigurasi OpenTelemetry Azure Monitor

  • Artikel

Artikel ini membahas pengaturan konfigurasi untuk distro OpenTelemetry Azure Monitor.

String koneksi

string koneksi di Application Insights menentukan lokasi target untuk mengirim data telemetri.

Gunakan salah satu dari tiga cara berikut untuk mengonfigurasi string koneksi:

  • Tambahkan UseAzureMonitor() ke file Anda program.cs :

    var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
    options.ConnectionString = "<Your Connection String>";
});

var app = builder.Build();

app.Run();

  • Atur variabel lingkungan.

    APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

  • Tambahkan bagian berikut ke file konfigurasi Anda appsettings.json .

    {
  "AzureMonitor": {
      "ConnectionString": "<Your Connection String>"
  }
}

Catatan

Jika Anda mengatur string koneksi di lebih dari satu tempat, kami mematuhi prioritas berikut:

  1. Kode
  2. Variabel lingkungan
  3. File konfigurasi

Mengatur Nama Peran Cloud dan Instans Peran Cloud

Untuk bahasa yang didukung, Distro OpenTelemetry Azure Monitor secara otomatis mendeteksi konteks sumber daya dan menyediakan nilai default untuk Nama Peran Cloud dan properti Instans Peran Cloud komponen Anda. Namun, Anda mungkin ingin mengambil alih nilai default ke sesuatu yang masuk akal untuk tim Anda. Nilai nama peran cloud muncul di Peta Aplikasi sebagai nama di bawah simpul.

Atur Nama Peran Cloud dan Instans Peran Cloud melalui atribut Sumber Daya . Nama Peran Cloud menggunakan atribut service.namespace dan service.name walaupun akan kembali lagi ke service.name jika service.namespace tidak diatur. Instans Peran Cloud menggunakan nilai atribut service.instance.id. Untuk informasi tentang atribut standar untuk sumber daya, lihat Konvensi Semantik OpenTelemetry.

// Setting role name and role instance

// Create a dictionary of resource attributes.
var resourceAttributes = new Dictionary<string, object> {
    { "service.name", "my-service" },
    { "service.namespace", "my-namespace" },
    { "service.instance.id", "my-instance" }};

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry()
    .UseAzureMonitor()
    // Configure the ResourceBuilder to add the custom resource attributes to all signals.
    // Custom resource attributes should be added AFTER AzureMonitor to override the default ResourceDetectors.
    .ConfigureResource(resourceBuilder => resourceBuilder.AddAttributes(_testResourceAttributes));

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Aktifkan Pengambilan Sampel

Anda mungkin ingin mengaktifkan pengambilan sampel untuk mengurangi volume penyerapan data Anda, yang mengurangi biaya Anda. Azure Monitor menyediakan sampler laju tetap kustom yang mengisi peristiwa dengan rasio pengambilan sampel, yang dikonversi Application Insights ke ItemCount. Sampler laju tetap memastikan pengalaman dan jumlah peristiwa yang akurat. Sampler dirancang untuk mempertahankan jejak Anda di seluruh layanan, dan dapat dioperasikan dengan Application Insights Software Development Kits (SDK) yang lebih lama. Untuk informasi selengkapnya, lihat Pelajari selengkapnya tentang pengambilan sampel.

Catatan

Metrik dan Log tidak terpengaruh oleh pengambilan sampel.

Sampler mengharapkan laju sampel antara 0 dan 1 inklusif. Tingkat 0,1 berarti sekitar 10% jejak Anda dikirim.

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the sampling ratio to 10%. This means that 10% of all traces will be sampled and sent to Azure Monitor.
    options.SamplingRatio = 0.1F;
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Tip

Saat menggunakan pengambilan sampel laju/persentase tetap dan Anda tidak yakin apa yang harus ditetapkan laju pengambilan sampel sebagai, mulai dari 5% (yaitu, rasio pengambilan sampel 0,05) dan sesuaikan laju berdasarkan akurasi operasi yang ditunjukkan di panel kegagalan dan performa. Tingkat yang lebih tinggi umumnya menghasilkan akurasi yang lebih tinggi. Namun, pengambilan sampel APA PUN akan memengaruhi akurasi sehingga kami menyarankan pemberitahuan tentang metrik OpenTelemetry, yang tidak terpengaruh oleh pengambilan sampel.

Metrik langsung

Metrik langsung menyediakan dasbor analitik real-time untuk wawasan tentang aktivitas dan performa aplikasi.

Penting

Lihat Ketentuan Penggunaan Tambahan untuk Pratinjau Microsoft Azure untuk persyaratan hukum yang berlaku pada fitur Azure dalam versi beta, pratinjau, atau belum dirilis secara umum.

Fitur ini diaktifkan secara default.

Pengguna dapat menonaktifkan Metrik Langsung saat mengonfigurasi Distro.

builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
	// Disable the Live Metrics feature.
    options.EnableLiveMetrics = false;
});

Mengaktifkan autentikasi MICROSOFT Entra ID (sebelumnya Azure AD)

Anda mungkin ingin mengaktifkan autentikasi Microsoft Entra untuk koneksi yang lebih aman ke Azure, yang mencegah telemetri yang tidak sah diserap ke dalam langganan Anda.

Kami mendukung kelas kredensial yang disediakan oleh Azure Identity.

  • Kami merekomendasikan DefaultAzureCredential untuk pengembangan lokal.
  • Kami merekomendasikan ManagedIdentityCredential untuk identitas terkelola yang ditetapkan sistem dan ditetapkan pengguna.
    • Untuk sistem yang ditetapkan, gunakan konstruktor default tanpa parameter.
    • Untuk pengguna yang ditetapkan, berikan ID klien ke konstruktor.
  • Kami merekomendasikan ClientSecretCredential untuk perwakilan layanan.
    • Berikan ID penyewa, ID klien, dan rahasia klien ke konstruktor.

  1. Instal paket Azure.Identity terbaru:

    dotnet add package Azure.Identity

  2. Berikan kelas kredensial yang diinginkan:

    // Create a new ASP.NET Core web application builder.    
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
    // Set the Azure Monitor credential to the DefaultAzureCredential.
    // This credential will use the Azure identity of the current user or
    // the service principal that the application is running as to authenticate
    // to Azure Monitor.
    options.Credential = new DefaultAzureCredential();
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Penyimpanan Offline dan Coba Lagi Otomatis

Untuk meningkatkan keandalan dan ketahanan, penawaran berbasis OpenTelemetry Azure Monitor menulis ke penyimpanan offline/lokal secara default ketika aplikasi kehilangan koneksinya dengan Application Insights. Ini menyimpan telemetri aplikasi ke disk dan secara berkala mencoba mengirimnya lagi hingga 48 jam. Dalam aplikasi beban tinggi, telemetri kadang-kadang dihilangkan karena dua alasan. Pertama, ketika waktu yang diizinkan terlampaui, dan kedua, ketika ukuran file maksimum terlampaui atau SDK tidak memiliki kesempatan untuk menghapus file. Jika kita perlu memilih, produk menyimpan peristiwa yang lebih baru daripada yang lama. Pelajari Selengkapnya

Paket Distro mencakup AzureMonitorExporter, yang secara default menggunakan salah satu lokasi berikut untuk penyimpanan offline (tercantum dalam urutan prioritas):

  • Windows
    • %LOCALAPPDATA%\Microsoft\AzureMonitor
    • %TEMP%\Microsoft\AzureMonitor
  • Non-Windows
    • %TMPDIR%/Microsoft/AzureMonitor
    • /var/tmp/Microsoft/AzureMonitor
    • /tmp/Microsoft/AzureMonitor

Untuk mengambil alih direktori default, Anda harus mengatur AzureMonitorOptions.StorageDirectory.

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
    // This is the directory where the OpenTelemetry SDK will store any telemetry data that cannot be sent to Azure Monitor immediately.
    options.StorageDirectory = "C:\\SomeDirectory";
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Untuk menonaktifkan fitur ini, Anda harus mengatur AzureMonitorOptions.DisableOfflineStorage = true.

Mengaktifkan Pengekspor OTLP

Anda mungkin ingin mengaktifkan Pengekspor Protokol OpenTelemetry (OTLP) bersama Pengekspor Azure Monitor untuk mengirim telemetri Anda ke dua lokasi.

Catatan

Pengekspor OTLP hanya ditampilkan untuk kenyamanan. Kami tidak mendukung secara resmi Pengekspor OTLP atau komponen apa pun atau pengalaman pihak ketiga di bagian hilirnya.

  1. Instal paket OpenTelemetry.Exporter.OpenTelemetryProtocol di proyek Anda.

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

  2. Tambahkan cuplikan kode berikut ini. Contoh ini mengasumsikan bahwa Anda memiliki Pengumpul OpenTelemetry dengan penerima OTLP yang sedang berjalan. Untuk detailnya, lihat contoh pada GitHub.

    // Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Add the OpenTelemetry OTLP exporter to the application.
// This exporter will send telemetry data to an OTLP receiver, such as Prometheus
builder.Services.AddOpenTelemetry().WithTracing(builder => builder.AddOtlpExporter());
builder.Services.AddOpenTelemetry().WithMetrics(builder => builder.AddOtlpExporter());

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

Konfigurasi OpenTelemetry

Konfigurasi OpenTelemetry berikut dapat diakses melalui variabel lingkungan saat menggunakan Distro OpenTelemetry Azure Monitor.

Variabel lingkungan Deskripsi
APPLICATIONINSIGHTS_CONNECTION_STRING Atur ke string koneksi untuk sumber daya Application Insights Anda.
APPLICATIONINSIGHTS_STATSBEAT_DISABLED Atur ke true untuk menolak pengumpulan metrik internal.
OTEL_RESOURCE_ATTRIBUTES Pasangan kunci-nilai yang akan digunakan sebagai atribut sumber daya. Untuk informasi selengkapnya tentang atribut sumber daya, lihat spesifikasi Resource SDK.
OTEL_SERVICE_NAME Mengatur nilai service.name atribut sumber daya. Jika service.name juga disediakan dalam OTEL_RESOURCE_ATTRIBUTES, maka OTEL_SERVICE_NAME diutamakan.