Menyiapkan log diagnostik melalui REST API Azure Monitor
Artikel ini menjelaskan cara menyiapkan log diagnostik untuk Azure Data Factory menggunakan REST API Azure Monitor.
Pengaturan diagnostik
Gunakan pengaturan diagnostik untuk mengonfigurasi log diagnostik untuk sumber daya non-komputasi. Pengaturan untuk kontrol sumber daya memiliki fitur berikut:
- Mereka menentukan lokasi pengiriman log diagnostik. Contohnya termasuk akun penyimpanan Azure, pusat aktivitas Azure, atau log Monitor.
- Mereka menentukan kategori log mana yang dikirim.
- Mereka menentukan durasi penyimpanan tiap kategori log di akun penyimpanan.
- Retensi nol hari berarti log disimpan selamanya. Jika tidak, nilainya dapat berupa jumlah hari dari 1 hingga 2.147.483.647.
- Jika kebijakan retensi ditetapkan, tetapi menyimpan log di akun penyimpanan dinonaktifkan, kebijakan retensi tidak berpengaruh. Misalnya, kondisi ini dapat terjadi ketika hanya Azure Event Hubs atau opsi log Monitor yang dipilih.
- Kebijakan retensi diterapkan per hari. Batas di antara hari terjadi pada tengah malam Waktu Universal Terkoordinasi (UTC). Pada akhir hari, log dari hari-hari yang berada di luar kebijakan retensi akan dihapus. Misalnya, jika Anda memiliki kebijakan retensi satu hari, pada awal hari ini, log dari sebelum kemarin dihapus.
Mengaktifkan log diagnostik melalui REST API Azure Monitor
Gunakan REST API Azure Monitor untuk mengaktifkan log diagnostik.
Membuat atau memperbarui pengaturan diagnostik di REST API Monitor
Permintaan
PUT
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}
Header
- Ganti
{api-version}
dengan2016-09-01
. - Ganti
{resource-id}
dengan ID sumber daya yang ingin Anda edit pengaturan diagnostiknya. Untuk mengetahui informasi selengkapnya, lihat Menggunakan grup sumber daya untuk mengelola sumber daya Azure Anda. - Atur header
Content-Type
keapplication/json
. - Atur header otorisasi ke token web JSON yang Anda dapatkan dari ID Microsoft Entra. Untuk informasi selengkapnya, lihat Mengautentikasi permintaan.
Isi
{
"properties": {
"storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
"serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
"workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
"metrics": [
],
"logs": [
{
"category": "PipelineRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "TriggerRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "ActivityRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
]
},
"location": ""
}
Properti | Tipe | Deskripsi |
---|---|---|
storageAccountId | String | ID sumber daya akun penyimpanan tempat Anda ingin mengirim log diagnostik. |
serviceBusRuleId | String | ID aturan bus layanan dari namespace bus layanan tempat Anda ingin membuat Azure Event Hubs untuk mengalirkan log diagnostik. ID aturan memiliki format {service bus resource ID}/authorizationrules/{key name} . |
workspaceId | String | ID ruang kerja dari ruang kerja tempat log akan disimpan. |
metrics | Nilai parameter dari eksekusi alur yang diteruskan ke alur yang dipanggil | Objek JSON yang memetakan nama parameter ke nilai argumen. |
log | Jenis Kompleks | Nama kategori log diagnostik untuk jenis sumber daya. Untuk mendapatkan daftar kategori log diagnostik untuk sumber daya, lakukan operasi pengaturan diagnostik GET. |
category | String | Rangkaian kategori log dan kebijakan retensinya. |
timeGrain | String | Granularitas metrik, yang ditangkap dalam format durasi ISO 8601. Nilai properti harus PT1M , yang menentukan satu menit. |
diaktifkan | Boolean | Menentukan apakah kumpulan metrik atau kategori log diaktifkan untuk sumber daya ini. |
retentionPolicy | Jenis Kompleks | Mendeskripsikan kebijakan retensi untuk kategori metrik atau log. Properti ini hanya digunakan untuk akun penyimpanan. |
days | Int | Jumlah hari untuk menyimpan metrik atau log. Jika nilai properti adalah 0, log disimpan selamanya. Properti ini hanya digunakan untuk akun penyimpanan. |
Respons
200 OK.
{
"id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
"type": null,
"name": "service",
"location": null,
"kind": null,
"tags": null,
"properties": {
"storageAccountId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.Storage/storageAccounts/<storageAccountName>",
"serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.EventHub/namespaces/<eventHubName>/authorizationrules/RootManageSharedAccessKey",
"workspaceId": "/subscriptions/<subID>/resourceGroups/<resourceGroupName>//providers/Microsoft.OperationalInsights/workspaces/<LogAnalyticsName>",
"eventHubAuthorizationRuleId": null,
"eventHubName": null,
"metrics": [],
"logs": [
{
"category": "PipelineRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "TriggerRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "ActivityRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
]
},
"identity": null
}
Mendapatkan informasi tentang pengaturan diagnostik di REST API Monitor
Permintaan
GET
https://management.azure.com/{resource-id}/providers/microsoft.insights/diagnosticSettings/service?api-version={api-version}
Header
- Ganti
{api-version}
dengan2016-09-01
. - Ganti
{resource-id}
dengan ID sumber daya yang ingin Anda edit pengaturan diagnostiknya. Untuk mengetahui informasi selengkapnya, lihat Menggunakan grup sumber daya untuk mengelola sumber daya Azure Anda. - Atur header
Content-Type
keapplication/json
. - Atur header otorisasi ke token web JSON yang Anda dapatkan dari ID Microsoft Entra. Untuk informasi selengkapnya, lihat Mengautentikasi permintaan.
Respons
200 OK.
{
"id": "/subscriptions/<subID>/resourcegroups/adf/providers/microsoft.datafactory/factories/shloadobetest2/providers/microsoft.insights/diagnosticSettings/service",
"type": null,
"name": "service",
"location": null,
"kind": null,
"tags": null,
"properties": {
"storageAccountId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.Storage/storageAccounts/azmonlogs",
"serviceBusRuleId": "/subscriptions/<subID>/resourceGroups/shloprivate/providers/Microsoft.EventHub/namespaces/shloeventhub/authorizationrules/RootManageSharedAccessKey",
"workspaceId": "/subscriptions/<subID>/resourceGroups/ADF/providers/Microsoft.OperationalInsights/workspaces/mihaipie",
"eventHubAuthorizationRuleId": null,
"eventHubName": null,
"metrics": [],
"logs": [
{
"category": "PipelineRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "TriggerRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": "ActivityRuns",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
]
},
"identity": null
}
Untuk informasi selengkapnya, lihat Pengaturan diagnostik.