Memantau Azure Digital Twins dengan log diagnostik

  • Artikel
  • 9 menit untuk membaca

Artikel ini menunjukkan kepada Anda cara mengonfigurasi pengaturan diagnostik di portal Microsoft Azure, termasuk jenis log apa yang akan dikumpulkan dan di mana menyimpannya (seperti Analitik log atau akun penyimpanan pilihan Anda). Lalu, Anda juga bisa mengkueri log untuk mengumpulkan wawasan kustom dengan cepat.

Azure Digital Twins dapat mengumpulkan log untuk instans layanan Anda untuk memantau performa, akses, dan data lainnya. Anda dapat menggunakan log ini untuk mendapatkan gambaran tentang apa yang terjadi di instans Azure Digital Twins Anda, dan menganalisis akar penyebab masalah tanpa perlu menghubungi dukungan Azure.

Artikel ini juga berisi informasi tentang semua kategori log yang dapat dikumpulkan oleh Azure Digital Twins, dan skemanya.

Aktifkan pengaturan diagnostik

Aktifkan pengaturan diagnostik untuk mulai mengumpulkan log di instans Azure Digital Twins Anda. Anda juga dapat memilih tujuan tempat log yang diekspor harus disimpan. Berikut adalah cara mengaktifkan pengaturan diagnostik untuk instans Azure Digital Twins Anda.

  1. Masuk ke portal Microsoft Azure dan navigasikan ke instans Azure Digital Twins Anda. Anda dapat menemukannya dengan mengetikkan namanya di bilah pencarian portal.

  2. Pilih Pengaturan diagnostik dari menu, lalu Tambahkan pengaturan diagnostik.

    Screenshot showing the diagnostic settings page in the Azure portal and button to add.

  3. Pada halaman berikutnya, isi nilai berikut ini:

    • Nama pengaturan diagnostik: Beri nama pengaturan diagnostik.

    • Detail kategori: Pilih operasi mana yang ingin Anda pantau, dan centang kotak untuk mengaktifkan diagnostik untuk operasi tersebut. Operasi yang dapat dilaporkan oleh pengaturan diagnostik adalah:

      • DigitalTwinsOperation
      • EventRoutesOperation
      • ModelsOperation
      • QueryOperation
      • SemuaMetrics

      Untuk detail selengkapnya tentang kategori ini dan informasi yang dikandungnya, lihat bagian Kategori log di bawah ini.

    • Detail tujuan: Pilih tempat Anda ingin mengirim log. Anda dapat memilih kombinasi apa pun dari tiga opsi berikut:

      • Mengirim ke Analitik Log
      • Mengarsipkan ke akun penyimpanan
      • Melakukan streaming ke pusat aktivitas

      Anda mungkin diminta untuk mengisi detail tambahan jika diperlukan untuk pilihan tujuan Anda.

  4. Simpan pengaturan baru.

    Screenshot showing the diagnostic setting page in the Azure portal where the user has filled in a diagnostic setting information.

Pengaturan baru berlaku dalam waktu sekitar 10 menit. Setelah itu, log muncul di target yang dikonfigurasikan kembali di halaman Pengaturan diagnostik untuk instans Anda.

Untuk informasi lebih rinci tentang pengaturan diagnostik dan opsi pengaturannya, Anda dapat mengunjungi Buat pengaturan diagnostik untuk mengirim log platform dan metrik ke tujuan yang berbeda.

Menampilkan dan mengkueri log

Setelah mengonfigurasi detail penyimpanan log Azure Digital Twins Anda, Anda dapat menulis kueri khusus agar dapat menghasilkan wawasan dan memecahkan masalah. Layanan ini juga menyediakan beberapa contoh pertanyaan yang dapat membantu Anda memulai, dengan menjawab pertanyaan umum yang mungkin dimiliki pelanggan tentang instans mereka.

Berikut adalah cara untuk mengkueri log untuk instans Anda.

  1. Masuk ke portal Microsoft Azure dan navigasikan ke instans Azure Digital Twins Anda. Anda dapat menemukannya dengan mengetikkan namanya di bilah pencarian portal.

  2. Pilih Log dari menu untuk membuka halaman kueri log. Halaman terbuka ke jendela yang disebut Kueri.

    Screenshot showing the Logs page for an Azure Digital Twins instance in the Azure portal with the Queries window overlaid, showing prebuilt queries.

    Ini adalah contoh kueri bawaan yang ditulis untuk berbagai log. Anda dapat memilih salah satu kueri untuk memuatnya ke editor kueri dan menjalankannya untuk melihat log ini untuk instans Anda.

    Anda juga bisa menutup jendela Kueri tanpa menjalankan apa pun untuk langsung masuk ke halaman editor kueri, tempat Anda bisa menulis atau mengedit kode kueri kustom.

  3. Setelah keluar dari jendela Kueri, Anda akan melihat halaman editor kueri utama. Di sini Anda dapat melihat dan mengedit teks contoh kueri, atau menulis kueri Anda sendiri dari awal. Screenshot showing the Logs page for an Azure Digital Twins instance in the Azure portal. It includes a list of logs, query code, and Queries History.

    Di panel kiri,

    • Tab Tabel memperlihatkan berbagai kategori log Azure Digital Twins yang tersedia untuk digunakan dalam kueri Anda.
    • Tab Kueri berisi contoh kueri yang bisa Anda muat ke editor.
    • Tab Filter memungkinkan Anda mengkustomisasi tampilan data yang difilter yang dikembalikan kueri.

Untuk informasi lebih rinci tentang kueri log dan cara menulisnya, Anda dapat mengunjungi Ringkasan kueri log di Azure Monitor.

Kategori log

Berikut adalah detail selengkapnya tentang kategori log yang dikumpulkan Azure Digital Twins.

Kategori log Deskripsi
ADTModelsOperation Catat semua panggilan API yang berkaitan dengan Model
ADTQueryOperation Catat semua panggilan API yang berkaitan dengan Kueri
ADTEventRoutesOperation Catat semua panggilan API yang berkaitan dengan Rute Peristiwa serta keluarnya acara dari Azure Digital Twins ke layanan titik akhir seperti Event Grid, Azure Event Hub, dan Azure Service Bus
ADTDigitalTwinsOperation Catat semua panggilan API yang berkaitan dengan twins individu

Setiap kategori log terdiri dari operasi tulis, baca, hapus, dan tindakan. Peta kategori untuk panggilan REST API sebagai berikut:

Jenis peristiwa Operasi REST API
Tulis PUT dan PATCH
Baca GET
Hapus DELETE
Tindakan POST

Berikut adalah daftar komprehensif operasi dan panggilan REST API Azure Digital Twins yang sesuai yang dicatat di setiap kategori.

Catatan

Setiap kategori log berisi beberapa operasi/panggilan REST API. Dalam tabel di bawah ini, setiap peta kategori log ke semua operasi/panggilan REST API di bawahnya hingga kategori log berikutnya tercantum.

Kategori log Operasi Panggilan REST API dan peristiwa lainnya
ADTModelsOperation Microsoft.DigitalTwins/models/write API Pembaruan Model Kembar Digital
Microsoft.DigitalTwins/models/read Model Kembar Digital Dapatkan Berdasarkan ID dan Daftar API
Microsoft.DigitalTwins/models/delete Model Kembar Digital Hapus API
Microsoft.DigitalTwins/models/delete Model Kembar Digital Tambahkan API
ADTQueryOperation Microsoft.DigitalTwins/query/action API Kueri Kembar
ADTEventRoutesOperation Microsoft.DigitalTwins/eventroutes/write Rute Peristiwa Tambahkan API
Microsoft.DigitalTwins/eventroutes/read Rute Peristiwa Dapatkan Berdasarkan ID dan Daftar API
Microsoft.DigitalTwins/eventroutes/delete API Hapus Rute Peristiwa
Microsoft.DigitalTwins/eventroutes/read Kegagalan saat mencoba memublikasikan peristiwa ke layanan titik akhir (bukan panggilan API)
ADTDigitalTwinsOperation Microsoft.DigitalTwins/digitaltwins/write Digital Twins Tambahkan, Tambahkan Hubungan, Perbarui, Perbarui Komponen
Microsoft.DigitalTwins/digitaltwins/read Digital Twins Dapatkan Berdasarkan ID, Dapatkan Komponen, Dapatkan Hubungan dengan ID, Daftar Hubungan Masuk, Daftar Hubungan
Microsoft.DigitalTwins/digitaltwins/delete Hapus Azure Digital Twins, Hapus Hubungan
Microsoft.DigitalTwins/digitaltwins/action Azure Digital Twins Mengirim Komponen Telemetri, Mengirim Telemetri

Skema log

Setiap kategori log memiliki skema yang menentukan bagaimana peristiwa dalam kategori tersebut dilaporkan. Setiap entri log individu disimpan sebagai teks dan diformat sebagai blob JSON. Bidang dalam log dan contoh badan JSON disediakan untuk setiap jenis log di bawah ini.

ADTDigitalTwinsOperation, ADTModelsOperation, dan ADTQueryOperationmenggunakan skema log API yang konsisten. ADTEventRoutesOperation memperluas skema untuk memuat bidang endpointName dalam properti.

Skema log API

Skema log ini konsisten untuk ADTDigitalTwinsOperation, ADTModelsOperation, ADTQueryOperation. Skema yang sama juga digunakan untuk ADTEventRoutesOperation, kecuali nama operasi Microsoft.DigitalTwins/eventroutes/action (untuk informasi lebih lanjut tentang skema tersebut, lihat bagian berikutnya, skema log Egress).

Skema ini berisi informasi yang berkaitan dengan panggilan API ke instans Azure Digital Twins.

Berikut adalah deskripsi bidang dan properti untuk log API.

Nama bidang Jenis data Deskripsi
Time DateTime Tanggal dan waktu peristiwa ini terjadi, dalam UTC
ResourceId Untai (karakter) ID Sumber Daya Azure Resource Manager untuk sumber daya tempat peristiwa berlangsung
OperationName Untai (karakter) Jenis tindakan yang dilakukan selama peristiwa
OperationVersion Untai (karakter) Versi API yang digunakan selama peristiwa
Category Untai (karakter) Jenis sumber daya yang dipancarkan
ResultType Untai (karakter) Hasil peristiwa
ResultSignature Untai (karakter) Kode status http untuk peristiwa
ResultDescription Untai (karakter) Informasi tambahan mengenai masalah tersebut
DurationMs Untai (karakter) Berapa lama waktu yang dibutuhkan untuk melakukan peristiwa dalam milidetik
CallerIpAddress Untai (karakter) Alamat IP sumber bertopeng untuk peristiwa tersebut
CorrelationId Guid Pengidentifikasi unik untuk peristiwa
ApplicationId Guid ID aplikasi yang digunakan dalam otorisasi token pembawa
Level Int Tingkat keparahan pengelogan peristiwa
Location Untai (karakter) Wilayah tempat peristiwa berlangsung
RequestUri Uri Titik akhir yang digunakan selama peristiwa
TraceId Untai (karakter) TraceId, sebagai bagian dari Konteks Jejak W3C. ID dari seluruh jejak yang digunakan untuk mengidentifikasi jejak terdistribusi secara unik di seluruh sistem.
SpanId Untai (karakter) SpanId sebagai bagian dari Konteks Jejak W3C. ID permintaan ini dalam jejak.
ParentId Untai (karakter) ParentId sebagai bagian dari Konteks Jejak W3C. Permintaan tanpa ID induk adalah akar dari jejak.
TraceFlags Untai (karakter) TraceFlags sebagai bagian dari Konteks Jejak W3C. Mengontrol pelacakan bendera seperti pengambilan sampel, tingkat pelacakan, dll.
TraceState Untai (karakter) TraceState sebagai bagian dari Konteks Jejak W3C. Informasi identifikasi jejak khusus vendor tambahan untuk menjangkau berbagai sistem pelacakan terdistribusi.

Di bawah ini adalah contoh badan JSON untuk jenis log ini.

ADTDigitalTwinsOperation

{
  "time": "2020-03-14T21:11:14.9918922Z",
  "resourceId": "/SUBSCRIPTIONS/BBED119E-28B8-454D-B25E-C990C9430C8F/RESOURCEGROUPS/MYRESOURCEGROUP/PROVIDERS/MICROSOFT.DIGITALTWINS/DIGITALTWINSINSTANCES/MYINSTANCENAME",
  "operationName": "Microsoft.DigitalTwins/digitaltwins/write",
  "operationVersion": "2020-10-31",
  "category": "DigitalTwinOperation",
  "resultType": "Success",
  "resultSignature": "200",
  "resultDescription": "",
  "durationMs": 8,
  "callerIpAddress": "13.68.244.*",
  "correlationId": "2f6a8e64-94aa-492a-bc31-16b9f0b16ab3",
  "identity": {
    "claims": {
      "appId": "872cd9fa-d31f-45e0-9eab-6e460a02d1f1"
    }
  },
  "level": "4",
  "location": "southcentralus",
  "uri": "https://myinstancename.api.scus.digitaltwins.azure.net/digitaltwins/factory-58d81613-2e54-4faa-a930-d980e6e2a884?api-version=2020-10-31",
  "properties": {},
  "traceContext": {
    "traceId": "95ff77cfb300b04f80d83e64d13831e7",
    "spanId": "b630da57026dd046",
    "parentId": "9f0de6dadae85945",
    "traceFlags": "01",
    "tracestate": "k1=v1,k2=v2"
  }
}

ADTModelsOperation

{
  "time": "2020-10-29T21:12:24.2337302Z",
  "resourceId": "/SUBSCRIPTIONS/BBED119E-28B8-454D-B25E-C990C9430C8F/RESOURCEGROUPS/MYRESOURCEGROUP/PROVIDERS/MICROSOFT.DIGITALTWINS/DIGITALTWINSINSTANCES/MYINSTANCENAME",
  "operationName": "Microsoft.DigitalTwins/models/write",
  "operationVersion": "2020-10-31",
  "category": "ModelsOperation",
  "resultType": "Success",
  "resultSignature": "201",
  "resultDescription": "",
  "durationMs": "80",
  "callerIpAddress": "13.68.244.*",
  "correlationId": "9dcb71ea-bb6f-46f2-ab70-78b80db76882",
  "identity": {
    "claims": {
      "appId": "872cd9fa-d31f-45e0-9eab-6e460a02d1f1"
    }
  },
  "level": "4",
  "location": "southcentralus",
  "uri": "https://myinstancename.api.scus.digitaltwins.azure.net/Models?api-version=2020-10-31",
  "properties": {},
  "traceContext": {
    "traceId": "95ff77cfb300b04f80d83e64d13831e7",
    "spanId": "b630da57026dd046",
    "parentId": "9f0de6dadae85945",
    "traceFlags": "01",
    "tracestate": "k1=v1,k2=v2"
  }
}

ADTQueryOperation

{
  "time": "2020-12-04T21:11:44.1690031Z",
  "resourceId": "/SUBSCRIPTIONS/BBED119E-28B8-454D-B25E-C990C9430C8F/RESOURCEGROUPS/MYRESOURCEGROUP/PROVIDERS/MICROSOFT.DIGITALTWINS/DIGITALTWINSINSTANCES/MYINSTANCENAME",
  "operationName": "Microsoft.DigitalTwins/query/action",
  "operationVersion": "2020-10-31",
  "category": "QueryOperation",
  "resultType": "Success",
  "resultSignature": "200",
  "resultDescription": "",
  "durationMs": "314",
  "callerIpAddress": "13.68.244.*",
  "correlationId": "1ee2b6e9-3af4-4873-8c7c-1a698b9ac334",
  "identity": {
    "claims": {
      "appId": "872cd9fa-d31f-45e0-9eab-6e460a02d1f1"
    }
  },
  "level": "4",
  "location": "southcentralus",
  "uri": "https://myinstancename.api.scus.digitaltwins.azure.net/query?api-version=2020-10-31",
  "properties": {},
  "traceContext": {
    "traceId": "95ff77cfb300b04f80d83e64d13831e7",
    "spanId": "b630da57026dd046",
    "parentId": "9f0de6dadae85945",
    "traceFlags": "01",
    "tracestate": "k1=v1,k2=v2"
  }
}

ADTEventRoutesOperation

Berikut adalah contoh isi JSON untuk ADTEventRoutesOperation yang bukan jenis Microsoft.DigitalTwins/eventroutes/action (untuk informasi selengkapnya tentang skema tersebut, lihat bagian berikutnya, skema log Egress).

  {
    "time": "2020-10-30T22:18:38.0708705Z",
    "resourceId": "/SUBSCRIPTIONS/BBED119E-28B8-454D-B25E-C990C9430C8F/RESOURCEGROUPS/MYRESOURCEGROUP/PROVIDERS/MICROSOFT.DIGITALTWINS/DIGITALTWINSINSTANCES/MYINSTANCENAME",
    "operationName": "Microsoft.DigitalTwins/eventroutes/write",
    "operationVersion": "2020-10-31",
    "category": "EventRoutesOperation",
    "resultType": "Success",
    "resultSignature": "204",
    "resultDescription": "",
    "durationMs": 42,
    "callerIpAddress": "212.100.32.*",
    "correlationId": "7f73ab45-14c0-491f-a834-0827dbbf7f8e",
    "identity": {
      "claims": {
        "appId": "872cd9fa-d31f-45e0-9eab-6e460a02d1f1"
      }
    },
    "level": "4",
    "location": "southcentralus",
    "uri": "https://myinstancename.api.scus.digitaltwins.azure.net/EventRoutes/egressRouteForEventHub?api-version=2020-10-31",
    "properties": {},
    "traceContext": {
      "traceId": "95ff77cfb300b04f80d83e64d13831e7",
      "spanId": "b630da57026dd046",
      "parentId": "9f0de6dadae85945",
      "traceFlags": "01",
      "tracestate": "k1=v1,k2=v2"
    }
  },

Skema log Egress

Ini adalah skema untuk log ADTEventRoutesOperation khusus untuk nama operasi Microsoft.DigitalTwins/eventroutes/action. Contoh ini berisi detail yang berkaitan dengan pengecualian dan operasi API di sekitar titik akhir jalan keluar yang terhubung ke instans Azure Digital Twins.

Nama bidang Jenis data Deskripsi
Time DateTime Tanggal dan waktu peristiwa ini terjadi, dalam UTC
ResourceId Untai (karakter) ID Sumber Daya Azure Resource Manager untuk sumber daya tempat peristiwa berlangsung
OperationName Untai (karakter) Jenis tindakan yang dilakukan selama peristiwa
Category Untai (karakter) Jenis sumber daya yang dipancarkan
ResultDescription Untai (karakter) Informasi tambahan mengenai masalah tersebut
CorrelationId Guid Pelanggan menyediakan pengidentifikasi unik untuk peristiwa tersebut
ApplicationId Guid ID aplikasi yang digunakan dalam otorisasi token pembawa
Level Int Tingkat keparahan pengelogan peristiwa
Location Untai (karakter) Wilayah tempat peristiwa berlangsung
TraceId Untai (karakter) TraceId, sebagai bagian dari Konteks Jejak W3C. ID dari seluruh jejak yang digunakan untuk mengidentifikasi jejak terdistribusi secara unik di seluruh sistem.
SpanId Untai (karakter) SpanId sebagai bagian dari Konteks Jejak W3C. ID permintaan ini dalam jejak.
ParentId Untai (karakter) ParentId sebagai bagian dari Konteks Jejak W3C. Permintaan tanpa ID induk adalah akar dari jejak.
TraceFlags Untai (karakter) TraceFlags sebagai bagian dari Konteks Jejak W3C. Mengontrol pelacakan bendera seperti pengambilan sampel, tingkat pelacakan, dll.
TraceState Untai (karakter) TraceState sebagai bagian dari Konteks Jejak W3C. Informasi identifikasi jejak khusus vendor tambahan untuk menjangkau berbagai sistem pelacakan terdistribusi.
EndpointName Untai (karakter) Nama titik akhir jalan keluar yang dibuat di Azure Digital Twins

Di bawah ini adalah contoh badan JSON untuk jenis log ini.

ADTEventRoutesOperation untuk Microsoft.DigitalTwins/eventroutes/action

Berikut adalah contoh badan JSON untuk ADTEventRoutesOperation jenis Microsoft.DigitalTwins/eventroutes/action tersebut.

{
  "time": "2020-11-05T22:18:38.0708705Z",
  "resourceId": "/SUBSCRIPTIONS/BBED119E-28B8-454D-B25E-C990C9430C8F/RESOURCEGROUPS/MYRESOURCEGROUP/PROVIDERS/MICROSOFT.DIGITALTWINS/DIGITALTWINSINSTANCES/MYINSTANCENAME",
  "operationName": "Microsoft.DigitalTwins/eventroutes/action",
  "operationVersion": "",
  "category": "EventRoutesOperation",
  "resultType": "",
  "resultSignature": "",
  "resultDescription": "Unable to send EventHub message to [myPath] for event Id [f6f45831-55d0-408b-8366-058e81ca6089].",
  "durationMs": -1,
  "callerIpAddress": "",
  "correlationId": "7f73ab45-14c0-491f-a834-0827dbbf7f8e",
  "identity": {
    "claims": {
      "appId": "872cd9fa-d31f-45e0-9eab-6e460a02d1f1"
    }
  },
  "level": "4",
  "location": "southcentralus",
  "uri": "",
  "properties": {
    "endpointName": "myEventHub"
  },
  "traceContext": {
    "traceId": "95ff77cfb300b04f80d83e64d13831e7",
    "spanId": "b630da57026dd046",
    "parentId": "9f0de6dadae85945",
    "traceFlags": "01",
    "tracestate": "k1=v1,k2=v2"
  }
},

Langkah berikutnya