Mengaktifkan Azure Monitor OpenTelemetry untuk aplikasi .NET, Node.js, Python, dan Java

Artikel ini menjelaskan cara mengaktifkan dan mengonfigurasi pengumpulan data berbasis OpenTelemetry untuk mendukung pengalaman dalam Azure Monitor Application Insights. Kami menjelaskan cara menginstal Distro OpenTelemetry Azure Monitor. Distro OpenTelemetry Azure Monitor menyediakan distribusi OpenTelemetry yang menyertakan dukungan untuk fitur khusus untuk Azure Monitor. Distro memungkinkan telemetri otomatis dengan menyertakan pustaka instrumentasi OpenTelemetry untuk mengumpulkan jejak, metrik, log, dan pengecualian, dan memungkinkan pengumpulan telemetri kustom . Anda juga dapat menggunakan fitur Metrik Langsung yang disertakan dalam Distro untuk memantau dan mengumpulkan lebih banyak telemetri dari aplikasi web langsung dalam produksi. Untuk informasi selengkapnya tentang keuntungan menggunakan Distro OpenTelemetry Azure Monitor, lihat Mengapa saya harus menggunakan "Azure Monitor OpenTelemetry Distro"? di FAQ OpenTelemetry.

Untuk mempelajari selengkapnya tentang mengumpulkan data menggunakan OpenTelemetry, lihat Data Collection Basics atau OpenTelemetry FAQ.

Status Rilis OpenTelemetry

Penawaran OpenTelemetry tersedia untuk aplikasi .NET, Node.js, Python, dan Java.

Catatan

Untuk status rilis fitur demi fitur, lihat FAQ.

Memulai

Ikuti langkah-langkah pada bagian ini untuk melengkapi aplikasi Anda dengan OpenTelemetry.

Prasyarat

Memasang pustaka klien

Instal paket Azure.Monitor.OpenTelemetry.AspNetCore NuGet terbaru:

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

Aktifkan Application Insights Azure Monitor

Untuk mengaktifkan Azure Monitor Application Insights, Anda membuat modifikasi kecil pada aplikasi Anda dan mengatur "string Koneksi ion." String Koneksi ion memberi tahu aplikasi Anda tempat mengirim telemetri yang dikumpulkan Distro, dan unik untuk Anda.

Ubah Aplikasi Anda

Tambahkan UseAzureMonitor() ke startup aplikasi Anda, yang terletak di kelas Anda program.cs .

// Import the Azure.Monitor.OpenTelemetry.AspNetCore namespace.
using Azure.Monitor.OpenTelemetry.AspNetCore;

// Create a new WebApplicationBuilder instance.
var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry and configure it to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the application.
var app = builder.Build();

// Run the application.
app.Run();

Salin String Koneksi ion dari Sumber Daya Application Insights Anda

Tip

Jika Anda belum memilikinya, sekarang saat yang tepat untuk Membuat Sumber Daya Application Insights. Berikut adalah ketika kami menyarankan Anda membuat Sumber Daya Application Insights baru versus menggunakan sumber daya yang sudah ada.

Untuk menyalin String Koneksi unik Anda:

Cuplikan layar yang menampilkan gambaran umum Application Insights dan string koneksi.

  1. Buka panel Gambaran Umum sumber daya Application Insights Anda.
  2. Temukan String Koneksi ion Anda.
  3. Arahkan mouse ke atas string koneksi dan pilih ikon Salin ke clipboard.

Tempelkan String Koneksi ion di lingkungan Anda

Untuk menempelkan String Koneksi ion Anda, pilih dari opsi berikut:

J. Atur melalui Variabel Lingkungan (Disarankan)

Ganti <Your Connection String> dalam perintah berikut dengan string koneksi unik Anda.

APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

B. Atur melalui File Konfigurasi - Java Saja (Disarankan)

Buat file konfigurasi bernama applicationinsights.json, dan letakkan di direktori yang sama seperti applicationinsights-agent-3.5.1.jar dengan konten berikut:

{
  "connectionString": "<Your Connection String>"
}

Ganti <Your Connection String> di JSON sebelumnya dengan string koneksi unik Anda.

C. Atur melalui Kode - ASP.NET Core, Node.js, dan Python Only (Tidak disarankan)

Lihat Konfigurasi String Koneksi ion untuk contoh pengaturan String Koneksi ion melalui kode.

Catatan

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

  1. Kode
  2. Variabel lingkungan
  3. File konfigurasi

Mengonfirmasi data sedang mengalir

Jalankan aplikasi Anda dan buka tab Sumber Daya Application Insights Anda di portal Microsoft Azure. Mungkin perlu waktu beberapa menit hingga data muncul di portal.

Cuplikan layar tab gambaran umum Application Insights dengan permintaan server dan waktu respons server disorot.

Application Insights sekarang diaktifkan untuk aplikasi Anda. Semua langkah berikut bersifat opsional dan memungkinkan penyesuaian lebih lanjut.

Penting

Jika Anda memiliki dua atau lebih layanan yang memancarkan telemetri ke sumber daya Application Insights yang sama, Anda perlu mengatur Nama Peran Cloud untuk mewakili mereka dengan benar di Peta Aplikasi.

Sebagai bagian dari penggunaan instrumentasi Application Insights, kami mengumpulkan dan mengirim data diagnostik ke Microsoft. Data ini membantu kami menjalankan dan meningkatkan Application Insights. Untuk mempelajari selengkapnya, lihat Statsbeat di Azure Application Insights.

Sampel

Aplikasi sampel OpenTelemetry Azure Monitor tersedia untuk semua bahasa yang didukung.

Langkah berikutnya

Tanya jawab umum

Bagian ini menyediakan jawaban atas pertanyaan umum.

Apa itu OpenTelemetry?

Ini adalah standar sumber terbuka baru untuk pengamatan. Pelajari lebih lanjut di OpenTelemetry.

Mengapa Microsoft Azure Monitor berinvestasi di OpenTelemetry?

Microsoft adalah salah satu kontributor terbesar untuk OpenTelemetry.

Proposisi nilai utama dari OpenTelemetry termasuk bersifat netral terhadap vendor dan menyediakan API/SDK yang konsisten di seluruh bahasa.

Seiring waktu, kami percaya OpenTelemetry akan memungkinkan pelanggan Azure Monitor untuk mengamati aplikasi yang ditulis dalam bahasa di luar bahasa yang didukung. Ini juga memperluas jenis data yang dapat Anda kumpulkan melalui serangkaian pustaka instrumentasi yang kaya. Selain itu, SDK OpenTelemetry cenderung lebih berkinerja dalam skala besar daripada pendahulunya, SDK Application Insights.

Terakhir, OpenTelemetry juga selaras dengan strategi Microsoft untuk merangkul sumber terbuka.

Bagaimana status OpenTelemetry?

Lihat Status OpenTelemetry.

Apa itu "Distro OpenTelemetry Azure Monitor"?

Anda dapat menganggapnya sebagai pembungkus tipis yang menggabungkan semua komponen OpenTelemetry untuk pengalaman kelas satu di Azure. Pembungkus ini juga disebut distribusi di OpenTelemetry.

Mengapa saya harus menggunakan "Distro OpenTelemetry Azure Monitor"?

Ada beberapa keuntungan menggunakan Distro OpenTelemetry Azure Monitor daripada OpenTelemetry asli dari komunitas:

Dalam semangat OpenTelemetry, kami merancang distro agar terbuka dan dapat diperluas. Misalnya, Anda dapat menambahkan:

  • Pengekspor OpenTelemetry Protocol (OTLP) dan mengirim ke tujuan kedua secara bersamaan
  • Pustaka instrumentasi lain yang tidak termasuk dalam distro

Karena Distro menyediakan distribusi OpenTelemetry, Distro mendukung apa pun yang didukung oleh OpenTelemetry. Misalnya, Anda dapat menambahkan lebih banyak prosesor telemetri, pengekspor, atau pustaka instrumentasi, jika OpenTelemetry mendukungnya.

Catatan

Distro mengatur sampler ke sampler laju tetap kustom untuk Application Insights. Anda dapat mengubah ini ke sampler yang berbeda, tetapi melakukannya mungkin menonaktifkan beberapa kemampuan yang disertakan Distro. Untuk informasi selengkapnya tentang sampler yang didukung, lihat bagian Aktifkan Pengambilan Sampel di Mengonfigurasi Azure Monitor OpenTelemetry.

Untuk bahasa tanpa pengekspor OpenTelemetry mandiri yang didukung, Distro OpenTelemetry Azure Monitor adalah satu-satunya cara yang saat ini didukung untuk menggunakan OpenTelemetry dengan Azure Monitor. Untuk bahasa dengan pengekspor OpenTelemetry mandiri yang didukung, Anda memiliki opsi untuk menggunakan Distro OpenTelemetry Azure Monitor atau pengekspor OpenTelemetry mandiri yang sesuai tergantung pada skenario telemetri Anda. Untuk informasi selengkapnya, lihat Kapan saya harus menggunakan pengekspor OpenTelemetry Azure Monitor?.

Bagaimana cara menguji Distro OpenTelemetry Azure Monitor?

Lihat dokumen pengaktifan kami untuk .NET, Java, JavaScript (Node.js), dan Python.

Haruskah saya menggunakan OpenTelemetry atau Application Insights SDK?

Sebaiknya gunakan Distro OpenTelemetry kecuali Anda memerlukan fitur yang hanya tersedia dengan dukungan formal di Application Insights SDK.

Mengadopsi OpenTelemetry sekarang mencegah harus bermigrasi di kemudian hari.

Kapan saya harus menggunakan pengekspor OpenTelemetry Azure Monitor?

Untuk ASP.NET Core, Java, Node.js, dan Python, sebaiknya gunakan Distro OpenTelemetry Azure Monitor. Ini adalah satu baris kode untuk memulai.

Untuk semua skenario .NET lainnya, termasuk ASP.NET klasik, aplikasi konsol, dll., sebaiknya gunakan pengekspor OpenTelemetry .NET Azure Monitor: Azure.Monitor.OpenTelemetry.Exporter.

Untuk skenario telemetri Python yang lebih kompleks yang memerlukan konfigurasi tingkat lanjut, sebaiknya gunakan Python Azure Monitor OpenTelemetry Exporter.

Apa status rilis fitur saat ini dalam Distro OpenTelemetry Azure Monitor?

Bagan berikut memecah dukungan fitur OpenTelemetry untuk setiap bahasa.

Fitur .NET Node.js Python Java
Pelacakan terdistribusi
Metrik kustom
Metrik standar (akurasi saat ini dipengaruhi oleh pengambilan sampel)
Pengambilan sampel laju tetap
Penyimpanan offline dan percobaan ulang otomatis
Pelaporan pengecualian
Koleksi log ⚠️
Kejadian Kustom ⚠️ ⚠️ ⚠️
Autentikasi Microsoft Entra
Metrik langsung
Mendeteksi Konteks Sumber Daya untuk VM/VMSS dan App Service
Mendeteksi Konteks Sumber Daya untuk AKS dan Fungsi
Pemfilteran Rentang Pengujian Ketersediaan
Pengisian otomatis ID pengguna, ID pengguna yang diautentikasi, dan IP pengguna
Mengesampingkan/mengatur nama operasi, ID pengguna, atau ID pengguna yang diautentikasi secara manual
Pengambilan sampel adaptif
Profiler ⚠️
Snapshot Debugger

Kunci

  • ✅ Fitur ini tersedia untuk semua pelanggan dengan dukungan formal.
  • ⚠️ Fitur ini tersedia sebagai pratinjau publik. Lihat Ketentuan penggunaan tambahan untuk pratinjau Microsoft Azure.
  • ❌ Fitur ini tidak tersedia atau tidak berlaku.

Dapatkah OpenTelemetry digunakan untuk browser web?

Ya, tetapi kami tidak merekomendasikannya dan Azure tidak mendukungnya. OpenTelemetry JavaScript sangat dioptimalkan untuk Node.js. Sebagai gantinya, sebaiknya gunakan Application Insights JavaScript SDK.

Kapan kita dapat mengharapkan OpenTelemetry SDK tersedia untuk digunakan di browser web?

SDK web OpenTelemetry tidak memiliki garis waktu ketersediaan yang ditentukan. Kami kemungkinan beberapa tahun lagi dari SDK browser yang merupakan alternatif yang layak untuk Application Insights JavaScript SDK.

Dapatkah saya menguji OpenTelemetry di browser web hari ini?

Kotak pasir web OpenTelemetry adalah fork yang dirancang untuk membuat OpenTelemetry berfungsi di browser. Belum dimungkinkan untuk mengirim telemetri ke Application Insights. SDK tidak menentukan peristiwa klien umum.

Apakah menjalankan Application Insights bersama agen pesaing seperti AppDynamics, DataDog, dan NewRelic didukung?

Tidak. Praktik ini bukan sesuatu yang kami rencanakan untuk diuji atau didukung, meskipun Distro kami memungkinkan Anda mengekspor ke titik akhir OTLP bersama Azure Monitor secara bersamaan.

Dapatkah saya menggunakan fitur pratinjau di lingkungan produksi?

Kami tidak merekomendasikannya. Lihat Ketentuan penggunaan tambahan untuk pratinjau Microsoft Azure.

Apa perbedaan antara instrumentasi manual dan otomatis?

Lihat Gambaran Umum OpenTelemetry.

Dapatkah saya menggunakan OpenTelemetry Collector?

Beberapa pelanggan menggunakan OpenTelemetry Collector sebagai alternatif agen, meskipun Microsoft belum secara resmi mendukung pendekatan berbasis agen untuk pemantauan aplikasi. Sementara itu, komunitas sumber terbuka berkontribusi pada Pengumpul OpenTelemetry Azure Monitor Exporter yang digunakan beberapa pelanggan untuk mengirim data ke Azure Monitor Application Insights. Ini tidak didukung oleh Microsoft.

Apa perbedaan antara OpenCensus dan OpenTelemetry?

OpenCensus adalah pendahulu OpenTelemetry. Microsoft membantu menyatukan OpenTracing dan OpenCensus untuk membuat OpenTelemetry, satu standar pengamatan untuk dunia. Python SDK yang direkomendasikan produksi saat ini untuk Azure Monitor didasarkan pada OpenCensus. Microsoft berkomitmen untuk membuat Azure Monitor berdasarkan OpenTelemetry.

Pemecahan Masalah

Tidak bekerja? Lihat halaman pemecahan masalah untuk ASP.NET Core.

Dukungan

Pilih tab untuk bahasa pilihan Anda untuk menemukan opsi dukungan.

Umpan balik OpenTelemetry

Untuk memberikan umpan balik: