Paket kueri di Azure Monitor Logs

  • Artikel

Paket kueri bertindak sebagai kontainer untuk kueri log di Azure Monitor. Mereka memungkinkan Anda menyimpan kueri log dan membagikannya di seluruh ruang kerja dan konteks lain di Analitik Log.

Izin

Anda dapat mengatur izin pada paket kueri saat Anda menampilkannya di portal Azure. Anda memerlukan izin berikut untuk menggunakan paket kueri:

  • Pembaca: Pengguna dapat melihat dan menjalankan semua kueri dalam paket kueri.

  • Kontributor: Pengguna dapat mengubah kueri yang sudah ada dan menambahkan kueri baru ke paket kueri.

    Penting

    Saat pengguna perlu memodifikasi atau menambahkan kueri, selalu beri pengguna izin Kontributor pada DefaultQueryPack. Jika tidak, pengguna tidak akan dapat menyimpan kueri apa pun ke langganan, termasuk dalam paket kueri lainnya.

Menampilkan paket kueri

Anda dapat menampilkan dan mengelola paket kueri di portal Azure dari menu Paket kueri Log Analytics. Pilih paket kueri untuk menampilkan dan mengedit izinnya. Artikel ini menjelaskan cara membuat paket kueri dengan menggunakan API.

Screenshot that shows query packs.

Paket kueri default

Azure Monitor secara otomatis membuat paket kueri yang disebut DefaultQueryPack di setiap langganan dalam grup sumber daya yang dipanggil LogAnalyticsDefaultResources saat Anda menyimpan kueri pertama Anda. Anda dapat menyimpan kueri ke paket kueri ini atau membuat paket kueri lain tergantung pada kebutuhan Anda.

Menggunakan beberapa paket kueri

Paket kueri default cukup bagi sebagian besar pengguna untuk menyimpan dan menggunakan kembali kueri. Anda mungkin ingin membuat beberapa paket kueri untuk pengguna di organisasi Anda jika, misalnya, Anda ingin memuat serangkaian kueri yang berbeda di sesi Analitik Log yang berbeda dan memberikan izin yang berbeda untuk kumpulan kueri yang berbeda.

Saat membuat paket kueri baru, Anda bisa menambahkan tag yang mengklasifikasikan kueri berdasarkan kebutuhan bisnis Anda. Misalnya, Anda dapat menandai paket kueri untuk menghubungkannya ke departemen tertentu di organisasi Anda atau untuk tingkat keparahan masalah yang dimaksudkan untuk ditangani oleh kueri yang disertakan. Dengan menggunakan tag, Anda dapat membuat serangkaian kueri yang berbeda yang ditujukan untuk set pengguna yang berbeda dan situasi yang berbeda.

Untuk menambahkan paket kueri ke ruang kerja Analitik Log Anda:

  1. Buka Analitik Log dan pilih Kueri di sudut kanan atas.
  2. Di sudut kiri atas pada dialog Kueri, di samping Paket kueri, klik Pilih paket kueri atau 0 dipilih.
  3. Pilih paket kueri yang ingin Anda tambahkan ke ruang kerja.

Screenshot that shows the Select query packs page in Log Analytics, where you can add query packs to a Log Analytics workspace.

Penting

Anda dapat menambahkan hingga lima paket kueri ke ruang kerja Analitik Log.

Membuat paket kueri

Anda dapat membuat paket kueri dengan menggunakan REST API atau dari panel paket kueri Analitik Log di portal Azure. Untuk membuka panel paket kueri Analitik Log di portal, pilih Semua layanan>Lainnya.

Catatan

Kueri yang disimpan dalam paket kueri tidak dienkripsi dengan kunci yang dikelola Pelanggan. Pilih Simpan sebagai kueri Warisan saat menyimpan kueri sebagai gantinya, untuk melindunginya dengan kunci yang dikelola pelanggan.

Membuat token

Anda harus memiliki token untuk autentikasi permintaan API. Ada beberapa metode untuk mendapatkan token. Salah satu metodenya adalah menggunakan armclient.

Pertama, masuk ke Azure dengan menggunakan perintah berikut:

armclient login

Kemudian buat token dengan menggunakan perintah berikut. Token secara otomatis disalin ke clipboard sehingga Anda dapat menempelkannya ke alat lain.

armclient token

Membuat payload

Payload permintaan adalah JSON yang menentukan satu atau beberapa kueri dan lokasi tempat paket kueri harus disimpan. Nama paket kueri ditentukan dalam permintaan API yang dijelaskan di bagian berikutnya.

{
    "location": "eastus",
    "properties":
    {
        "displayName": "Query name that will be displayed in the UI",
        "description": "Query description that will be displayed in the UI",
        "body": "<<query text, standard KQL code>>",
        "related": {
            "categories": [
                "workloads"
            ],
            "resourceTypes": [
                "microsoft.insights/components"
            ],
            "solutions": [
                "logmanagement"
            ]
        },
        "tags": {
            "Tag1": [
                "Value1",
                "Value2"
            ]
        }
    }
}

Setiap kueri dalam paket kueri memiliki properti berikut:

Properti Deskripsi
displayName Nama tampilan tercantum di Log Analytics untuk setiap kueri.
description Deskripsi kueri ditampilkan di Log Analytics untuk setiap kueri.
body Kueri ditulis dalam Bahasa Kueri Kusto.
related Kategori terkait, jenis sumber daya, dan solusi untuk kueri. Digunakan untuk pengelompokan dan pemfilteran di Log Analytics oleh pengguna untuk membantu menemukan kueri mereka. Setiap kueri dapat memiliki hingga 10 dari setiap jenis. Ambil nilai yang diizinkan dari https://api.loganalytics.io/v1/metadata?select=resourceTypes, solusi, dan kategori.
tags Tag lain yang digunakan oleh pengguna untuk mengurutkan dan memfilter di Analitik Log. Setiap tag akan ditambahkan ke Kategori, Jenis Sumber Daya, dan Solusi saat Anda mengelompokkan dan memfilter kueri.

Buat permintaan

Gunakan permintaan berikut untuk membuat paket kueri baru dengan menggunakan REST API. Permintaan harus menggunakan otorisasi token pembawa. Jenis konten harus .application/json

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack?api-version=2019-09-01

Gunakan alat yang dapat mengirimkan permintaan REST API, seperti Fiddler atau Postman, untuk mengirimkan permintaan dengan menggunakan payload yang dijelaskan di bagian sebelumnya. ID kueri akan dibuat dan dikembalikan dalam payload.

Memperbarui paket kueri

Untuk memperbarui paket kueri, kirimkan permintaan berikut dengan payload yang diperbarui. Perintah ini memerlukan ID paket kueri.

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack/queries/query-id/?api-version=2019-09-01

Langkah berikutnya

Lihat Menggunakan kueri di Log Analytics Azure Monitor untuk melihat bagaimana pengguna berinteraksi dengan paket kueri di Log Analytics.