Membuat dan mengelola laporan kustom

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

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 terintegrasi dalam Apigee.

Ada dua jenis laporan kustom:

• Laporan real-time (disebut juga laporan sinkron): Saat Anda menentukan parameter laporan di UI Apigee, laporan real-time akan ditampilkan di UI Apigee dalam beberapa menit.
• Report job (disebut juga laporan asinkron): Untuk tugas laporan kustom, Anda meminta laporan dan mengambil hasilnya di lain waktu.

Lihat Laporan real-time versus tugas laporan.

Ketersediaan laporan kustom

Jika Anda adalah pelanggan Langganan Apigee, akses ke Analisis API Apigee dan fungsi laporan kustom disertakan dalam hak langganan dan otomatis diaktifkan untuk setiap lingkungan Apigee Anda.

Jika Anda adalah pelanggan Pay-as-you-go, Anda harus mengaktifkan Analisis API Apigee sebagai add-on berbayar untuk mengakses analisis dan membuat laporan kustom. Untuk informasi lebih lanjut tentang cara mengaktifkan add-on Analisis API Apigee untuk lingkungan Apigee Menengah atau Komprehensif, lihat Mengelola add-on Analisis API Apigee.

Jika tidak yakin apakah Anda menggunakan organisasi Apigee Langganan atau Bayar sesuai penggunaan, hubungi administrator organisasi Apigee Anda.

Tentang laporan kustom

Saat membuat laporan kustom, Anda perlu memilih data yang ingin dilihat (metrics), mengelompokkan data dengan 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 menurut dimensi proxy API:

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

  

• Baris - setiap API diwakili oleh 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

Selain metrik dan dimensi standar, Anda juga dapat membuat laporan kustom untuk data kustom yang dikumpulkan menggunakan kebijakan DataCapture. Lihat Mengumpulkan data kustom dengan kebijakan DataCapture.

Beberapa metrik memungkinkan Anda menetapkan fungsi agregasi yang akan 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 pada 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 (yang juga dapat berupa ID AppGroup) 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.

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 data metrik hanya ditampilkan untuk waktu respons yang lebih besar dari nilai tertentu, atau hanya untuk proxy API dengan nama tertentu.

Anda dapat membuat filter kompleks menggunakan operator dan sintaksis bersyarat seperti eq, ne, gt, lt, dan lainnya.

Contoh laporan kustom

Di jenis laporan kustom paling sederhana, Anda menentukan satu metrik dan satu dimensi. Misalnya, Anda menentukan laporan kustom dengan setelan berikut:

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

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

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

• type = Kolom
• metrik = Transaksi rata-rata 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 = Transaksi rata-rata per detik
• metrik = Error kebijakan
• dimensi = Proxy API
• dimensi = Kata kerja permintaan

Laporan real-time versus tugas laporan

Apigee Analytics memungkinkan Anda menjalankan laporan real-time atau tugas laporan.

• Untuk laporan real-time, Anda meminta laporan dan laporan tersebut akan ditampilkan segera setelah server analisis memberikan respons. Namun, karena laporan mungkin perlu memproses data dalam jumlah besar (misalnya, 100 GB), laporan real-time mungkin akan gagal karena waktu tunggu habis.

  Laporan real-time dapat memiliki rentang waktu maksimum 92 hari. Jika Anda memilih rentang waktu yang lebih lama dari rentang waktu ini, laporan akan dijalankan sebagai tugas laporan.

  Lihat Menjalankan laporan kustom.

• Untuk tugas laporan, Anda meminta laporan dan mengambil hasilnya di lain waktu. Beberapa situasi yang memungkinkan tugas laporan sebagai alternatif yang baik antara lain:

  • 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.
  Catatan: Tugas laporan memiliki batasan berikut:

  • Rentang waktu maksimum adalah 365 hari.
  • Batas ukuran 32 MB untuk hasil kueri.

  Anda juga dapat menjalankan tugas laporan menggunakan API, seperti yang dijelaskan dalam Menggunakan API laporan kustom asinkron. Lihat Melihat tugas laporan.

Membuka halaman Laporan Kustom

Catatan: Ada versi baru UI Apigee, yang terintegrasi dengan konsol Google Cloud. UI baru ini disebut Apigee in Cloud Console. Petunjuk pada dua tab pertama di bawah menjelaskan cara menggunakan Apigee di Konsol Cloud atau Apigee klasik.

Apigee di Konsol Cloud

Untuk membuka halaman Laporan Kustom:

1. Buka UI Apigee di Konsol Cloud.
2. Pilih Analytics > Laporan kustom.

Tindakan ini akan menampilkan halaman Laporan Kustom, seperti yang ditunjukkan di bawah.

Halaman Laporan Kustom memiliki dua tab:

• Laporan: Menampilkan laporan real-time.
• Melaporkan Tugas: Menampilkan tugas laporan.

Lihat Laporan real-time versus tugas laporan.

Kedua tab menampilkan daftar laporan atau tugas laporan yang telah dibuat. Untuk melihat tugas laporan atau laporan, klik nama laporan tersebut. Lihat Menjalankan laporan untuk mengetahui contohnya.

Laporan

Tab Laporan menampilkan informasi berikut tentang setiap laporan:

• Nama Tampilan: Nama laporan.
• Dimensi: Dimensi yang disertakan dalam laporan.
• Metrik: Metrik dan fungsi agregasi (seperti sum) yang disertakan dalam laporan.
• Terakhir Diubah: Waktu dan tanggal terakhir saat laporan dijalankan.

Laporkan Tugas

Tab Laporan Tugas menampilkan informasi berikut tentang setiap tugas laporan:

• Nama Laporan: Nama laporan.
• Rentang Waktu Mulai (UTC): Waktu mulai tugas laporan.
• Rentang Waktu Akhir (UTC): Waktu berakhir tugas laporan.
• Status: Status tugas laporan, yang dapat berupa running, complete, atau expiration.
• Dikirim: Tanggal dan waktu tugas laporan dikirimkan.

Halaman Laporan Kustom memungkinkan Anda untuk:

• Lihat laporan kustom dan tugas laporan.
• Buat laporan kustom atau tugas laporan.
• Menjalankan laporan.
• Mengedit tugas laporan atau laporan kustom.
• Hapus laporan kustom atau tugas laporan.

Catatan: Interval penundaan data
Setelah panggilan API dilakukan ke proxy, mungkin diperlukan waktu hingga 10 menit agar data muncul di dasbor, laporan kustom, dan panggilan API pengelolaan.

Apigee Klasik

Untuk membuka halaman Laporan Kustom:

1. Login ke UI Apigee.
2. Pilih Analisis > Laporan Kustom > Laporan.

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

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

• Lihat daftar semua laporan kustom.
• Tambahkan laporan kustom.
• Jalankan laporan kustom dengan mengklik namanya dalam daftar. Laporan dijalankan menggunakan data yang dikumpulkan selama satu jam terakhir secara default dan data tersebut 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 menemukan string tersebut.
• Menghapus laporan kustom.

Menjelajahi dasbor laporan kustom

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

Dasbor laporan kustom memungkinkan Anda:

• Lihat 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 saat Anda menentukan beberapa dimensi pada laporan.

• Pilih tampilan Diagram atau Tabel.

  Catatan: Jika laporan kustom Anda menyertakan banyak baris dalam tabel Summary di bagian bawah laporan, klik Tabel untuk melihat informasi tabel saja. Dalam tampilan tabel, gunakan drop-down Show up to untuk mengontrol jumlah baris yang ditampilkan dalam tabel. Anda dapat menampilkan hingga 200 baris sekaligus.
• Analisis metrik dengan memilih ikon di baris tabel metrik 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. File ini diberi nama sebagai berikut: metric.csv. Misalnya: Average_of_total_response_time.csv
• Edit laporan kustom.

Catatan: Interval penundaan data
Setelah panggilan API dilakukan ke proxy, mungkin diperlukan waktu hingga 10 menit agar data muncul di dasbor, laporan kustom, dan panggilan API pengelolaan.

Membuat laporan kustom

Bagian ini menjelaskan cara membuat laporan kustom.

Catatan: Akun gratis dan uji coba tidak dapat membuat tugas laporan kustom. Untuk mengetahui informasi selengkapnya, lihat Paket harga Apigee.

Apigee di Konsol Cloud

Di halaman Laporan Kustom, Anda dapat membuat laporan real-time atau tugas laporan. Untuk melakukannya:

1. Buka halaman Laporan Kustom.
2. Klik + Buat.
3. • Untuk membuat laporan real-time, pilih Laporan Kustom.
   • Untuk membuat tugas laporan, pilih Tugas Laporan Kustom.
4. Di bagian Dasar, masukkan informasi berikut:
   • Nama Laporan: Nama laporan.
   • Khusus untuk laporan real-time, Anda juga dapat memasukkan Deskripsi laporan opsional.
5. Bagian berikut bergantung pada apakah Anda membuat laporan real-time dari tugas laporan:
   • Hanya untuk laporan real-time:

     Setelah Chart Type, pilih gaya diagram untuk menampilkan data Anda:

     • Kolom: Sumbu X mewakili grup yang ditentukan oleh dimensi.
     • Garis: Sumbu X merepresentasikan waktu.

   • Khusus tugas laporan:
     • Report Details: Di kolom Environment, pilih lingkungan tempat Anda ingin menjalankan laporan. Perhatikan bahwa untuk laporan real-time, Anda dapat memilih lingkungan di halaman laporan, setelah laporan berjalan.
     • Rentang Tanggal Laporan: Pilih Waktu mulai dan Waktu berakhir untuk laporan.

       Catatan: Rentang tanggal maksimum untuk tugas laporan adalah 365 hari. Untuk laporan yang memerlukan rentang tanggal presisi hingga detik, gunakan Custom Reports API untuk membuat tugas laporan. API menerima input rentang tanggal yang menyertakan detik.

6. Di bagian Metrik:
   1. Pilih metrik yang ingin Anda analisis.
   2. Pilih Fungsi agregat untuk menampilkan nilai Jumlah, Rata-rata, Min, atau Maks.
   3. Klik Done.

   Catatan: Selain metrik dan dimensi standar, Anda juga dapat memilih metrik atau dimensi yang sesuai dengan data kustom yang dikumpulkan dengan kebijakan DataCapture.

7. Di kolom Dimensions, pilih dimensi, seperti "Proxy", untuk membatasi set data yang digunakan untuk membuat laporan. Anda dapat menambahkan dimensi lain untuk lebih membatasi data.

8. Di bagian Filter, Anda dapat lebih mempersempit data yang ditampilkan dengan menambahkan filter ke definisi laporan. Misalnya, Anda dapat menambahkan filter yang mengecualikan data untuk proxy API cuaca atau developer [e-mail].

   Pertama, klik Tambahkan Filter untuk membuka bagian Filter Baru.

   1. Pilih nama entitas yang ingin Anda filter, yang dapat berupa metrik atau dimensi.
   2. Pilih operator seperti = atau !=, dan Nilai.
   3. Masukkan nilai untuk metrik atau dimensi.
   4. Klik Selesai untuk menambahkan filter.
9. Klik Simpan untuk menyimpan laporan.

Apigee Klasik

Untuk menambahkan laporan kustom:

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

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

4. Di bagian Metrik:
   1. Klik ikon untuk Metrics.
   2. Pilih metrik yang ingin Anda analisis.
   3. Pilih Fungsi agregat untuk menampilkan nilai Jumlah, Rata-rata, Min, atau Maks.
   4. Klik Save.
   5. Klik ikon untuk menambahkan metrik lainnya.

   Catatan: Selain metrik dan dimensi standar, Anda juga dapat memilih metrik atau dimensi yang sesuai dengan data kustom yang dikumpulkan dengan kebijakan DataCapture.

5. Di bagian Dimensions, klik , lalu pilih dimensi, seperti "Proxy", untuk membatasi set data yang digunakan untuk menghasilkan laporan. Anda dapat menambahkan dimensi lain untuk lebih membatasi data.

6. Di bagian Filter, persempit lebih lanjut data yang ditampilkan dengan menambahkan filter ke definisi laporan Anda. Misalnya, Anda dapat menambahkan filter yang mengecualikan data untuk proxy API cuaca atau developer [e-mail].

   1. Klik dan pilih Nama entitas yang ingin Anda filter, Operator seperti = atau !=, dan Nilai.
   2. Klik Tambahkan untuk menyimpan filter.
   3. Klik untuk menambahkan filter lain, lalu pilih konektor DAN atau ATAU.
7. Klik Simpan untuk menyimpan laporan.

Menjalankan laporan

Apigee di Konsol Cloud

Untuk menjalankan laporan real-time:

1. Buka halaman Laporan Kustom.
2. Di tab Laporan, pilih laporan yang akan dijalankan.

Jika sudah siap, laporan akan ditampilkan seperti yang ditunjukkan di bawah.

Laporan menampilkan diagram data dan tabel ringkasan.

Catatan: Laporan hanya menampilkan satu dimensi dalam satu waktu. Jika laporan memiliki beberapa dimensi, Anda dapat memilih dimensi yang akan ditampilkan di kolom Dimensi.

Di halaman laporan, Anda dapat memilih opsi berikut untuk laporan:

• Lingkungan: Lingkungan tempat laporan dijalankan.
• Jangka waktu untuk laporan.
  Catatan: Rentang waktu maksimum untuk laporan kustom adalah 92 hari. Untuk membuat laporan dengan rentang waktu yang lebih lama, Anda harus mengirimkannya sebagai tugas laporan.
• Dimensi: Dimensi untuk laporan. Hanya satu dimensi yang dapat ditampilkan pada satu waktu.
• Nilai: Nilai spesifik untuk dimensi, atau All untuk menampilkan semua nilai.

Anda juga dapat memilih opsi berikut di bagian atas halaman laporan:

• Edit: Edit detail laporan.
• Ekspor: Mendownload data untuk laporan dalam file CSV.
• Submit Job: Mengirim laporan sebagai tugas laporan. Saat Anda mengklik Submit Job, dialog akan terbuka yang memberi Anda opsi yang dijelaskan dalam Membuat laporan kustom. Setelah memasukkan opsi, klik Create untuk membuat tugas laporan.

Catatan: Rentang kustom tidak boleh melebihi 92 hari untuk laporan kustom real-time dan 365 hari untuk tugas laporan.

Lihat Melihat tugas laporan untuk mengetahui informasi selengkapnya tentang tugas laporan.

Apigee Klasik

Untuk menjalankan laporan kustom selama rentang waktu tertentu:

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

   Catatan: Jika membutuhkan waktu lebih dari 60 detik untuk dijalankan, laporan akan otomatis dikonversi menjadi laporan real-time.

3. Untuk menjalankan laporan untuk rentang waktu yang berbeda:

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

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

        Catatan: Rentang kustom tidak boleh melebihi 92 hari untuk laporan kustom sinkron dan 365 hari untuk tugas laporan.
   3. Untuk menjalankan laporan, pilih salah satu opsi berikut:

      • Ajukan permohonan untuk menjalankan laporan. Hasilnya akan ditampilkan di dasbor laporan kustom setelah laporan selesai.

      • Submit Job untuk menjalankan laporan sebagai tugas laporan. Dialog berikut akan muncul:

        

        Klik Lihat Status dalam dialog untuk melihat status tugas laporan.

Melihat tugas laporan

Apigee di Konsol Cloud

Untuk melihat tugas laporan, pilih tab Tugas Laporan di bagian atas halaman Laporan Kustom.

Tab Report Job ditampilkan, seperti yang ditunjukkan di bawah ini:

Halaman Laporkan Tugas memungkinkan Anda:

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

  Catatan: Hasil tugas laporan akan dihapus setelah 7 hari.

• Pilih lingkungan tempat Anda ingin menampilkan tugas laporan.

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

Untuk melihat laporan kustom, pastikan Statusnya sudah lengkap. Kemudian, klik nama laporan untuk melihat laporan.

Catatan:

Anda tidak dapat melihat tugas laporan yang:

• Masih berjalan.
• Melebihi ukuran penayangan maksimum sebesar 2 MB.

Apigee Klasik

Untuk melihat tugas laporan, pilih salah satu opsi berikut:

• Klik View Status dalam dialog Report Submit as Background Job.
• Pilih Analyze > Custom Reports > Report Jobs dari menu navigasi sebelah kiri.

Halaman Laporkan Tugas ditampilkan, seperti yang ditampilkan dalam gambar berikut:

Halaman Laporkan Tugas memungkinkan Anda:

• Melihat semua hasil tugas laporan yang telah dikirimkan dalam 7 hari terakhir.

  Catatan: Hasil tugas laporan akan dihapus setelah 7 hari.

• Pilih lingkungan tempat Anda ingin menampilkan tugas laporan.

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

  Catatan:

  Anda tidak dapat melihat tugas laporan yang:

  • Masih berjalan.
  • Melebihi ukuran penayangan maksimum sebesar 2 MB.
  • Tidak berisi data (0 MB).

• Download laporan kustom.

Mengedit laporan kustom

Apigee di Konsol Cloud

Untuk mengedit laporan kustom:

1. Buka halaman Laporan Kustom.
2. Klik menu tiga titik di bagian Tindakan.
3. Pilih Edit. Tindakan ini akan membuka dialog Edit laporan kustom, tempat Anda dapat mengedit opsi untuk laporan. Opsinya dijelaskan dalam artikel Membuat laporan kustom.
4. Klik Update untuk menyimpan perubahan.

Apigee Klasik

Untuk mengedit laporan kustom:

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

Anda akan kembali ke hasil laporan kustom.

Menghapus laporan kustom

Apigee di Konsol Cloud

1. Buka halaman Laporan Kustom.
2. Klik menu tiga titik di bagian Tindakan.
3. Klik Hapus untuk menghapus laporan.

Apigee Klasik

Untuk menghapus laporan kustom:

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