Praktik terbaik analitik
Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019
Analytics adalah platform pelaporan untuk Azure DevOps, yang memungkinkan Anda mendapatkan wawasan dari data Anda dan membuat keputusan berbasis data. Analitik dioptimalkan untuk akses baca yang cepat dan agregasi berbasis server, dan menyediakan berbagai alat untuk memvisualisasikan dan menganalisis data Anda. Dalam artikel ini, kami berbagi beberapa praktik terbaik untuk menggunakan Analytics di Azure DevOps.
Prasyarat
- Akses: Menjadi anggota proyek dengan setidaknya akses Dasar .
- Izin: Secara default, anggota proyek memiliki izin untuk mengkueri Analitik dan membuat tampilan.
- Untuk informasi selengkapnya tentang prasyarat lain mengenai pengaktifan layanan dan fitur serta aktivitas pelacakan data umum, lihat Izin dan prasyarat untuk mengakses Analitik.
- Jika Anda adalah pengembang ekstensi, pastikan untuk meninjau panduan kueri OData Analytics.
Membiasakan diri dengan metadata Analytics
Kueri metadata Analytics untuk mendapatkan keakraban dengan jenis entitas, set entitas, properti, dan daftar enumerasi. Untuk informasi selengkapnya, lihat Mengkueri layanan Analitik, metadata Analitik OData, dan Entitas dan referensi properti untuk Azure Boards.
Menyusun kueri Anda untuk mengembalikan data yang Anda butuhkan
Untuk mengkueri himpunan data minimum yang Anda perlukan untuk membuat laporan, ikuti praktik berikut:
- Pilih kumpulan entitas yang mendukung laporan yang ingin Anda buat
- Tentukan bagian kueri dalam urutan dijalankan
- Membatasi kolom yang Anda minta dalam kueri Anda
- Membuat kueri pratinjau
- Membatasi kueri ke proyek yang dapat Anda akses
Pilih entitas yang ditetapkan untuk mendukung laporan Anda
Meskipun ada beberapa EntitySets
yang didukung dalam model data Analytics, hanya beberapa yang digunakan untuk menghasilkan laporan.EntitySets
digunakan untuk membuat laporan termasuk dalam tiga kategori:
- Saat ini: Berisi informasi tentang konfigurasi saat ini dari yang
EntityTypes
terkandung dalamEntitySet
. - Rekam jepret: Entitas komposit yang menggabungkan data historis dan terkait tanggal. Entitas rekam jepret dimaksudkan untuk digunakan untuk mendukung laporan agregasi.
- Revisi: Berisi informasi historis. Misalnya,
WorkItemRevision
menyimpan data tentang riwayat item kerja.
Berikut adalah referensi cepat untuk EntityTypes yang akan ditentukan untuk mendukung laporan. Untuk deskripsi masing-masing EntityTypes ini, lihat Model data untuk Analitik.
Data Azure DevOps | Saat ini | Snapshot | Revisi |
---|---|---|---|
Azure Boards | WorkItems |
WorkItemSnapshot WorkItemBoardSnapshot |
WorkItemRevisions |
Azure Pipelines | Pipelines PipelineTasks |
ParallelPipelineJobsSnapshot PipelineRuns , PipelineRunActivityResults |
|
Alur dan Pengujian Azure | TestResultsDaily |
TestRuns |
|
Azure Test Plans | Tests TestConfiguration TestPoints WorkItems |
TestResultsDaily TestPointHistorySnapshot |
Tentukan bagian kueri dalam urutan dijalankan
Urutan yang direkomendasikan untuk berbagai bagian kueri adalah menentukannya dalam urutan berikut, yang merupakan urutan evaluasinya. Untuk deskripsi setiap bagian kueri, lihat Mengkueri layanan Analitik, Opsi kueri.
$apply
$filter
$orderby
$expand
$select
$skip
$top
Semua kueri harus berisi klausa $apply
atau $select
, jika tidak, Anda mungkin menerima pesan peringatan.
Membatasi kolom yang Anda minta dalam kueri Anda
Anda menentukan kolom data untuk dikembalikan menggunakan $select
klausa. Dengan kustomisasi, item kerja dapat memiliki banyak bidang yang terkait dengannya. Semakin banyak properti atau bidang yang dirujuk kueri, semakin mahal untuk diproses. Pertimbangkan laporan yang ingin Anda buat dan pastikan Anda hanya meminta bidang yang Anda butuhkan.
Misalnya, untuk mengembalikan bidang ID, Tipe Item Kerja, Judul, dan Status untuk sekumpulan item kerja yang difilter, tentukan klausa berikut $select
: $select=WorkItemId, WorkItemType, Title, State
.
Untuk mencari daftar properti dan nama bidang terkait, lihat Entitas dan referensi properti untuk Azure Boards.
Membuat kueri pratinjau
Kueri pratinjau adalah kueri yang mengembalikan satu rekaman atau subset kecil rekaman. Dengan membuat kueri pratinjau, Anda bisa menyempurnakan kueri untuk memastikan bahwa Anda meminta data yang Anda butuhkan. Dengan memulai kueri minimal, Anda bisa menyusun kueri untuk memastikan bahwa Anda menentukan rekaman yang Anda inginkan dan data kolom yang Anda butuhkan.
Dengan menggunakan apply=aggregate($count as Count)
, Anda dapat mengidentifikasi jumlah rekaman yang Anda minta. Misalnya, sintaks berikut mengkueri jumlah item kerja untuk proyek Fabrikam Fiber .
https://analytics.dev.azure.com/content-learn/Content/_odata/v4.0-preview/WorkItems? $apply=aggregate($count as Count)
Respons mengembalikan total 1415 item kerja.
{
"@odata.context": "https://analytics.dev.azure.com/fabrikam/Fabrikam Fbier/_odata/v4.0-preview/$metadata#WorkItems(Count)",
"value": [
{
"@odata.id": null,
"Count": 1415
}
]
}
Membatasi kueri ke proyek yang dapat Anda akses
Kueri cakupan proyek mengembalikan informasi tentang satu proyek, sedangkan kueri cakupan organisasi dirancang untuk mengembalikan informasi yang melintasi batas proyek. Kueri tercakup organisasi memerlukan izin pengguna yang lebih luas atau pembatasan cakupan yang cermat untuk memastikan bahwa kueri Anda tidak diblokir karena kurangnya izin proyek.
Jika Anda memiliki akses ke satu atau beberapa proyek, tetapi tidak semua proyek, dan Anda mengirimkan kueri yang dilingkup organisasi, Anda menerima pesan kesalahan.
"VS403496: The query results include data in one or more projects for which you do not have access. Add one or more projects filters to specify the project(s) you have access to in 'WorkItems' entity. If you're using $expand or navigation properties, project filter is required for those entities. More information can be found here: https://go.microsoft.com/fwlink/?LinkId=786441."
Untuk informasi selengkapnya, lihat Kueri proyek dan cakupan organisasi.
Meninjau pesan peringatan dan kesalahan
Analitik meninjau setiap kueri yang diterimanya karena pelanggaran terhadap aturannya. Ini mengembalikan pesan peringatan saat mendeteksi pelanggaran. Kami menyarankan agar Anda meninjau pesan ini untuk memperbaiki atau meningkatkan struktur kueri.
Batas laju dan pembatasan
Kueri yang dibuat untuk Analytics untuk Azure DevOps Services tunduk pada batas tarif. Jika terlalu banyak kueri dikirim yang meminta pengembalian data dalam jumlah besar dalam jangka waktu singkat, layanan mungkin tunduk pada pembatasan. Untuk informasi selengkapnya, lihat Tarif dan batas penggunaan.
Anda dapat meninjau penggunaan untuk layanan dan untuk individu dengan masuk ke Penggunaan Pengaturan>Organisasi dan menjalankan filter. Misalnya, gambar berikut menunjukkan penggunaan oleh Jamal Hartnett ke layanan Analytics.