Membuat dan mengelola laporan kustom

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Laporan kustom memungkinkan Anda melihat perincian metrik API tertentu dan melihat data persis yang ingin Anda lihat. Anda dapat membuat laporan kustom menggunakan salah satu metrics dan dimensi yang terdapat di Edge. Selain itu, Anda dapat melampirkan kebijakan Statscollector ke proxy API untuk mengumpulkan metrik kustom, seperti ID pengguna atau produk, harga, tindakan REST, versi target, URL target, dan panjang pesan.

Video

Tonton video berikut untuk mempelajari lebih lanjut laporan kustom.

Video	Deskripsi
Membuat laporan kustom menggunakan UI	Pelajari cara membuat laporan kustom menggunakan UI Edge.
Ringkasan laporan kustom	Lihat ringkasan penggunaan laporan kustom.
Melacak latensi API	Lihat cara melacak latensi API menggunakan laporan kustom.
Melacak respons error API	Melacak respons error API menggunakan laporan kustom.

Tentang laporan khusus

Saat membuat laporan kustom, Anda perlu memilih data yang ingin dilihat (metrik), mengelompokkan data melalui cara-cara yang bermakna (dimensi), dan secara opsional membatasi data yang ditampilkan berdasarkan karakteristik tertentu (filter) data.

Anda juga dapat menetapkan jenis diagram yang ditampilkan dalam laporan kustom sebagai diagram kolom atau garis. Gambar berikut menampilkan contoh diagram untuk metrik transaksi per detik yang dikelompokkan oleh dimensi proxy API:

• Kolom - setiap proxy API diwakili oleh kolom yang berbeda:

  

• Baris - setiap API direpresentasikan dalam baris yang berbeda:

  

Menetapkan metrik dan dimensi

metrics yang Anda pilih untuk laporan kustom menentukan data yang ingin Anda ukur. Metrik umum mencakup:

• Transaksi per detik
• Waktu respons
• Error kebijakan

Beberapa metrik memungkinkan Anda menetapkan fungsi agregasi untuk dijalankan berdasarkan metrik. Misalnya, Anda dapat menggunakan fungsi agregasi berikut dengan metrik waktu respons:

• avg: Menampilkan waktu respons rata-rata.
• min: Menampilkan waktu respons minimum.
• max: Menampilkan waktu respons maksimum.
• sum: Menampilkan jumlah semua waktu respons.

Tidak semua metrik mendukung semua fungsi agregasi. Dokumentasi tentang metrics berisi tabel yang menentukan nama metrik dan fungsi (sum, avg, min, max) yang didukung oleh metrik.

Dimensi menentukan cara mengelompokkan data metrik. Misalnya, Anda ingin membuat laporan kustom yang menampilkan metrik waktu respons. Anda dapat menggunakan dimensi untuk mengelompokkan data metrik menurut produk API, proxy API, atau email developer untuk mendapatkan:

• Waktu respons per produk API
• Waktu respons per proxy API
• Waktu respons per email developer

Cara dimensi ditampilkan dalam diagram laporan kustom bergantung pada jenis diagram:

• Kolom: Setiap kolom sesuai dengan nilai dimensi yang berbeda.
• Garis: Setiap garis dalam diagram sesuai dengan nilai dimensi yang berbeda, dan sumbu x mewakili waktu.

Membuat metrik dan dimensi kustom

Tambahkan kebijakan Statistics Collector ke proxy API Anda untuk mengumpulkan data analisis kustom, seperti ID pengguna atau produk, harga, tindakan REST, versi target, URL target, dan panjang pesan. Data dapat berasal dari variabel alur yang telah ditentukan oleh Apigee, header permintaan, parameter kueri, atau variabel kustom yang Anda tentukan. Setelah data dikumpulkan, Anda dapat membuat laporan kustom untuk melihat data tersebut.

Cara Anda menampilkan data analisis kustom dalam laporan kustom bergantung pada jenis datanya:

• Untuk data string jenis, referensikan data statistik sebagai dimensi dalam laporan kustom.
• Untuk jenis data numerik (bilangan bulat/float/panjang/ganda), referensikan data statistik dalam laporan kustom sebagai dimensi atau metrik.

Lihat kebijakan Statistics Collector untuk contoh pengumpulan data analisis kustom.

Menyetel filter

Filter memungkinkan Anda membatasi data metrik yang ditampilkan dalam laporan kustom dengan menetapkan karakteristik tertentu pada data metrik yang akan ditampilkan. Misalnya, Anda dapat membuat filter sehingga Anda dapat melihat data metrik hanya untuk waktu respons yang lebih besar dari nilai tertentu atau hanya untuk proxy API dengan nama tertentu.

Filter menggunakan sintaksis kondisi yang memungkinkan Anda membuat filter kompleks menggunakan operator seperti eq, ne, gt, lt, dan lainnya.

Contoh laporan kustom

Pada jenis laporan kustom yang paling sederhana, Anda menetapkan satu dimensi dan satu dimensi. Misalnya, Anda menetapkan laporan kustom dengan setelan berikut:

• type = Kolom
• metrik = Rata-rata transaksi per detik
• dimensi = Proxy API

Laporan kustom berisi diagram kolom dengan data metrik "Transaksi rata-rata per detik" yang dikelompokkan oleh dimensi proxy API:

Metrik yang menampilkan rata-rata juga menampilkan link Tampilkan dispersi di sisi kanan diagram, seperti yang dapat Anda lihat pada diagram di atas. Arahkan kursor ke link untuk membuka kotak dispersi. Kotak dispersi menampilkan kecenderungan utama dari data Anda.

Anda dapat menambahkan beberapa metrik ke laporan kustom. Misalnya, Anda menentukan laporan kustom dengan dua metrik:

• type = Kolom
• metrik = Rata-rata transaksi per detik
• metrik = Error Kebijakan
• dimensi = Proxy API

Laporan kustom berisi diagram terpisah untuk setiap metrik:

Anda dapat menambahkan beberapa dimensi ke laporan kustom. Misalnya, Anda menentukan laporan kustom dengan setelan berikut yang mencakup dua metrik dan dua dimensi:

• type = Kolom
• metrik = Rata-rata transaksi per detik
• metrik = Error kebijakan
• dimensi = Proxy API
• dimensi = Kata kerja permintaan

Diagram awalnya menunjukkan metrik yang dikelompokkan oleh Proxy, dimensi pertama yang ditentukan saat Anda membuat laporan kustom:

Selanjutnya, Anda dapat menggunakan dropdown Proxy, yang sesuai dengan dimensi pertama, untuk memilih proxy satu per satu. Diagram yang diperbarui kini menampilkan metrik untuk proxy yang dipilih berdasarkan kata kerja permintaan:

Seiring Anda menambahkan lebih banyak dimensi ke laporan kustom, UI akan disesuaikan sehingga Anda dapat melihat perincian laporan menurut setiap dimensi.

Melihat semua laporan kustom

Akses halaman laporan kustom, seperti yang dijelaskan di bawah.

Halaman laporan kustom menampilkan semua laporan kustom yang telah dibuat untuk organisasi Anda, seperti yang ditunjukkan pada gambar berikut:

Seperti yang disorot dalam gambar, halaman laporan kustom memungkinkan Anda untuk:

• Lihat daftar semua laporan kustom.
• Tambahkan laporan kustom.
• Jalankan laporan kustom dengan mengklik namanya di daftar. Laporan ini dijalankan menggunakan data yang dikumpulkan selama satu jam terakhir secara default dan data ditampilkan di dasbor laporan kustom. Lihat Menjelajahi dasbor laporan kustom.
• Telusuri daftar laporan kustom dengan memasukkan semua atau sebagian string yang relevan di kotak penelusuran; semua kolom yang ditampilkan akan ditelusuri untuk string tersebut.
• Menghapus laporan kustom.

Mempelajari dasbor laporan kustom

Dasbor laporan kustom menampilkan hasil laporan kustom untuk rentang waktu tertentu, termasuk diagram kolom atau garis pada metrik yang ditentukan:

Dasbor laporan kustom memungkinkan Anda untuk:

• Melihat data laporan kustom untuk rentang waktu yang dipilih.
• Pilih Lingkungan yang ingin Anda lihat data laporan kustomnya.
• Pilih dimensi tertentu untuk memfilter data laporan kustom. Area ini hanya diaktifkan jika Anda menentukan beberapa dimensi pada laporan.

• Pilih tampilan Diagram atau Tabel.

• Analisis metrik dengan memilih ikon di baris tabel metrik yang terkait. Lihat anomali dan bandingkan dengan periode sebelumnya atau dengan metrik lain.
• Jalankan laporan kustom dengan mengklik dan menetapkan rentang waktu.
• Download laporan kustom sebagai file CSV. Nama filenya adalah sebagai berikut: metric.csv. Contoh: Average_of_total_response_time.csv.
• Edit laporan kustom.

Jelajahi dasbor analisis metrik

Jika Anda memilih ikon di baris tabel ringkasan, diagram berikut akan muncul (diagram teratas hanya muncul jika Anda mengonfigurasi laporan untuk menggunakan beberapa metrik):

Diagram ini menampilkan informasi berikut:

• Bandingkan dengan: Jika Anda mengonfigurasi laporan untuk menggunakan beberapa metrik, bandingkan metrik satu sama lain.
• Bandingkan dengan periode sebelumnya: Melihat metrik untuk jangka waktu sebelumnya. Misalnya, jika Anda memilih untuk melihat laporan kustom selama 24 jam terakhir, diagram ini akan menampilkan data untuk periode 24 jam sebelumnya.

• Analisis anomali: Menampilkan titik data luar dalam data laporan. Diagram ini menampilkan dua nilai:

  • Rata-rata pergerakan metrik yang ditampilkan sebagai garis. Untuk titik tertentu pada garis, nilai rata-rata bergerak dihitung sebagai rata-rata nilai metrik pada titik waktu tersebut dan nilai metrik untuk dua titik data sebelumnya.
  • Area berwarna biru pada diagram menentukan rata-rata nilai maks dan rata-rata min dari metrik. Maksimum rata-rata adalah 1,2 * (rata-rata bergerak), dan min rata-rata adalah 0,8 * (rata-rata bergerak).

  Jika rata-rata bergerak berada di luar rentang rata-rata min maksimum atau rata-rata, hal ini dianggap sebagai kemungkinan anomali dan digambar sebagai titik merah pada diagram.

Menambahkan laporan kustom

Dengan menambahkan laporan kustom, Anda dapat membuat sekumpulan diagram yang memberikan insight tentang setiap aspek program API Anda.

Setelah menambahkan laporan kustom, Anda harus run secara sinkron atau asinkron.

Untuk menambahkan laporan kustom:

1. Akses halaman Laporan Kustom.
2. Klik + Laporan Kustom.
3. Di bagian Dasar, masukkan informasi berikut:

   Kolom	Deskripsi
   Nama laporan	Nama laporan.
   Laporkan deskripsi	Deskripsi laporan.
   Jenis diagram	Pilih gaya diagram yang akan digunakan untuk menyajikan data analisis kustom Anda. Kolom: Sumbu X mewakili grup yang ditentukan berdasarkan dimensi. Garis: Sumbu X mewakili waktu.

4. Di bagian Metrik:
   1. Klik ikon untuk Metrics.
   2. Pilih metrik yang ingin Anda analisis.
   3. Pilih Aggregate function untuk menampilkan nilai Sum, Average, Min, atau Max.
   4. Klik Simpan.
   5. Klik ikon untuk menambahkan metrik tambahan.
5. Di bagian Dimensions, klik , lalu pilih dimensi, seperti "Proxy", untuk membatasi set data yang digunakan untuk membuat laporan. Anda dapat menambahkan dimensi tambahan untuk lebih membatasi data.

6. Di bagian Filter, persempit data yang ditampilkan lebih lanjut dengan menambahkan filter ke definisi laporan Anda. Misalnya, Anda dapat menambahkan filter yang mengecualikan data untuk proxy weather API atau developer jane@example.com.

   1. Klik lalu pilih Nama entity yang ingin Anda filter, Operator seperti = atau !=, dan Value.
   2. Klik Tambahkan untuk menyimpan filter.
   3. Klik untuk menambahkan filter lain, dan pilih konektor DAN atau ATAU.

7. Untuk membatasi siapa saja yang dapat mengakses laporan kustom, edit Peran kustom yang ditentukan untuk laporan tersebut.

   1. Klik untuk mengedit setelan peran khusus.
   2. Pilih peran khusus yang diperlukan untuk mengakses laporan dan tingkat akses (lihat, edit, hapus).
   3. Klik Tambahkan.
   4. Klik untuk mengedit peran tambahan.
8. Klik Simpan untuk menyimpan laporan.

Menjalankan laporan kustom

Analisis Edge memungkinkan Anda menjalankan laporan secara sinkron atau asinkron.

• Untuk laporan sinkron, Anda menjalankan permintaan laporan dan permintaan tersebut akan diblokir sampai server analisis memberikan respons. Namun, karena laporan mungkin perlu memproses data dalam jumlah besar (misalnya, 100 GB), laporan sinkron mungkin gagal karena waktu habis.

  Laporan sinkron dapat memiliki rentang waktu maksimum 14 hari. Jika Anda memilih rentang waktu 15 hari atau lebih, laporan akan selalu dijalankan secara asinkron.

• Untuk laporan asinkron, Anda dapat menjalankan permintaan laporan dan mengambil hasilnya di lain waktu. Beberapa situasi ketika pemrosesan kueri asinkron mungkin menjadi alternatif yang baik meliputi:

  • Menganalisis dan membuat laporan yang mencakup interval waktu yang besar.
  • Menganalisis data dengan berbagai pengelompokan dimensi dan batasan lain yang menambah kompleksitas pada kueri
  • Mengelola kueri saat Anda menemukan bahwa volume data telah meningkat secara signifikan untuk beberapa pengguna atau organisasi.

  Dokumen ini menjelaskan cara memulai laporan asinkron dengan menggunakan UI. Anda juga dapat menggunakan API, seperti yang dijelaskan dalam Menggunakan API laporan kustom asinkron.

Untuk menjalankan laporan kustom untuk rentang waktu tertentu:

1. Akses halaman Laporan Kustom.
2. Pilih laporan yang akan dijalankan. Secara default, laporan menampilkan data untuk jam sebelumnya.

3. Untuk menjalankan laporan untuk rentang waktu yang berbeda:

   1. Klik area rentang waktu di bagian atas laporan untuk membuka pop-up Pilihan Waktu Laporan Kustom.
   2. Pilih salah satu:
      • Rentang waktu yang telah ditentukan, seperti Jam Terakhir, Kemarin, atau 7 Hari Terakhir.

      • Rentang Kustom dengan memilih tanggal dan waktu Dari/Hingga, atau gunakan kalender untuk memilih tanggal mulai dan akhir. Klik UTC untuk menggunakan Universal Time Coordinated (UTC).

   3. Untuk menjalankan laporan, pilih salah satu opsi berikut:

      • Terapkan untuk menjalankan laporan secara sinkron. Hasilnya akan ditampilkan di dasbor laporan kustom setelah laporan selesai. Jika laporan membutuhkan waktu lebih dari 60 detik untuk dijalankan, laporan akan otomatis dikonversi menjadi laporan asinkron.

      • Kirim Tugas untuk menjalankan laporan secara asinkron sebagai tugas latar belakang. Dialog berikut akan muncul:

        

        Klik Lihat Status di dialog untuk melihat status tugas laporan kustom.

Melihat tugas laporan kustom asinkron

Untuk melihat tugas laporan kustom asinkron, pilih salah satu opsi berikut:

• Klik View Status pada dialog Report Sender as Background Job.
• Pilih Analisis > Laporan Kustom > Laporkan Tugas dari menu navigasi sebelah kiri.

Halaman Laporkan Pekerjaan akan ditampilkan, seperti yang ditunjukkan pada gambar berikut:

Halaman Laporkan Pekerjaan memungkinkan Anda untuk:

• Lihat semua hasil tugas laporan kustom asinkron yang telah dikirimkan dalam 7 hari terakhir.

• Pilih lingkungan tempat Anda ingin menampilkan tugas laporan kustom.

• Untuk melihat laporan kustom, pastikan Statusnya selesai. Kemudian, arahkan kursor ke baris yang sesuai dengan laporan. Ikon dan akan muncul. Pilih untuk melihat laporan.

• Download laporan kustom dengan mengklik .

  Laporan lengkap didownload sebagai file ZIP bernama OfflineQueryResult-xxx.zip yang berisi file CSV.

• Telusuri daftar laporan kustom dengan memasukkan semua atau sebagian string yang relevan di kotak penelusuran; semua kolom yang ditampilkan akan ditelusuri untuk string tersebut.

Mengedit laporan kustom

Untuk mengedit laporan kustom:

1. Akses halaman Laporan Kustom.
2. Arahkan kursor ke nama laporan yang ingin Anda edit. Ikon edit dan hapus akan muncul di sisi kanan halaman.
3. Klik ikon edit.
4. Edit detail laporan kustom.
5. Klik Simpan.

Anda kembali ke hasil laporan kustom.

Menghapus laporan kustom

Untuk menghapus laporan kustom:

1. Akses halaman Laporan Kustom.
2. Arahkan kursor ke nama laporan yang ingin Anda edit. Ikon edit dan hapus akan muncul di sisi kanan halaman.
3. Klik ikon hapus untuk menghapus laporan.