Membuat dan mengelola laporan kustom

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca 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 terdapat dalam Apigee.

Ada dua jenis laporan kustom:

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

Lihat Laporan real-time versus pelaporan tugas.

Ketersediaan laporan kustom

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

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

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 harus 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:

    Diagram kolom kustom

  • Baris - setiap API diwakili oleh baris yang berbeda:

    Diagram garis kustom

Menetapkan metrik dan dimensi

metrics yang dipilih 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 Anda kumpulkan menggunakan kebijakan DataCapture. Lihat Mengumpulkan data kustom dengan kebijakan DataCapture.

Beberapa metrik memungkinkan Anda menetapkan fungsi agregasi untuk dijalankan terhadap 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 terkait dengan nilai dimensi yang berbeda, dan sumbu x mewakili waktu.

Setelan 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 yang ditampilkan hanya untuk waktu respons yang lebih besar daripada 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

Pada jenis laporan kustom yang paling sederhana, Anda menentukan satu metrik dan satu dimensi. Misalnya, Anda menentukan 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 menurut dimensi proxy API:

TP laporan kustom

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:

Laporan kustom dua 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

Laporan real-time versus tugas pelaporan

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

  • Untuk laporan real-time, Anda dapat meminta laporan dan laporan 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 gagal karena waktu tunggu.

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

    Lihat artikel Menjalankan laporan kustom.

  • Untuk tugas laporan, Anda dapat meminta laporan dan mengambil hasilnya di lain waktu. Beberapa situasi ketika tugas laporan 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 kerumitan pada kueri.
    • Mengelola kueri saat Anda mendapati bahwa volume data telah meningkat secara signifikan untuk beberapa pengguna atau organisasi.

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

Membuka halaman Laporan Kustom

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.

Dasbor laporan kustom

Halaman Laporan Kustom memiliki dua tab:

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

Lihat Laporan real-time versus pelaporan tugas.

Kedua tab menampilkan daftar laporan atau tugas laporan yang telah dibuat. Untuk melihat laporan atau melaporkan tugas, klik nama laporan. 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: Fungsi agregasi dan metrik (seperti sum) yang disertakan dalam laporan.
  • Terakhir Diubah: Waktu dan tanggal terakhir saat laporan dijalankan.

Laporkan Tugas

Tab Laporkan Tugas menampilkan informasi berikut tentang setiap tugas laporan:

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

Halaman Laporan Kustom memungkinkan Anda:

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:

Dasbor laporan kustom

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

  • 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 mencari string tersebut.
  • Menghapus laporan kustom.

Menjelajahi dasbor laporan kustom

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

Dasbor laporan kustom

Dasbor laporan kustom memungkinkan Anda:

  • Melihat data laporan kustom untuk rentang waktu yang dipilih.
  • Pilih Lingkungan tempat Anda ingin melihat data laporan kustom.
  • Pilih dimensi tertentu untuk memfilter data laporan kustom. Area ini hanya diaktifkan jika Anda menentukan beberapa dimensi dalam laporan.
  • Pilih tampilan Diagram atau Tabel.

  • Analisis metrik dengan memilih ikon Ikon analisis laporan kustom. 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. File tersebut diberi nama sebagai berikut: metric.csv. Misalnya: Average_of_total_response_time.csv
  • Edit laporan kustom.

Membuat laporan kustom

Bagian ini menjelaskan cara membuat laporan kustom.

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.
    • Untuk membuat laporan real-time, pilih Laporan Kustom.
    • Untuk membuat tugas laporan, pilih Laporan Kustom Tugas.
  3. Di bagian Dasar, masukkan informasi berikut:
    • Nama Laporan: Nama laporan.
    • Untuk laporan real-time saja, Anda juga dapat memasukkan Description laporan secara opsional.
  4. 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 menyajikan data Anda:

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

    • Khusus untuk 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.

  5. Di bagian Metrik:
    1. Pilih metric 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.

  6. Di kolom Dimensi, pilih dimensi, seperti "Proxy", untuk membatasi set data yang digunakan untuk membuat laporan. Anda dapat menambahkan dimensi lain untuk lebih membatasi data.
  7. Di bagian Filter, Anda dapat lebih mempersempit data yang ditampilkan dengan menambahkan filter ke definisi laporan Anda. Misalnya, Anda dapat menambahkan filter yang mengecualikan data untuk proxy weather API atau developer jane@example.com.

    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 Value.
    3. Masukkan nilai untuk metrik atau dimensi.
    4. Klik Selesai untuk menambahkan filter.
  8. 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 kelompok yang ditentukan oleh dimensi.
    • Garis: Sumbu X mewakili waktu.
  4. Di bagian Metrik:
    1. Klik ikon Ikon plus. untuk Metrics.
    2. Pilih metric yang ingin Anda analisis.
    3. Pilih Fungsi agregat untuk menampilkan nilai Jumlah, Rata-rata, Min, atau Maks.
    4. Klik Save.
    5. Klik ikon Ikon plus 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 Dimensi, klik Ikon plus, lalu pilih dimensi, seperti "Proxy", untuk membatasi set data yang digunakan untuk membuat 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 weather API atau developer jane@example.com.

    1. Klik Ikon plus dan pilih Nama entity yang ingin Anda filter, Operator seperti = atau !=, dan Value.
    2. Klik Tambahkan untuk menyimpan filter.
    3. Klik Ikon plus untuk menambahkan filter tambahan, lalu pilih konektor AND atau OR.
  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.

Setelah siap, laporan akan ditampilkan seperti yang ditunjukkan di bawah ini.

Laporan kustom ditampilkan.

Laporan ini menampilkan diagram data dan tabel ringkasan.

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

  • Lingkungan: Lingkungan tempat laporan akan dijalankan.
  • Jangka waktu untuk laporan.
  • Dimensi: Dimensi untuk laporan. Hanya satu dimensi yang dapat ditampilkan dalam satu waktu.
  • Value: Nilai spesifik untuk dimensi, atau All untuk menampilkan semua nilai.

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

  • Edit: Mengedit detail laporan.
  • Ekspor: Mendownload data untuk laporan dalam file CSV.
  • Kirim Tugas: Mengirim laporan sebagai tugas laporan. Saat Anda mengklik Kirim Tugas, sebuah dialog akan terbuka dan memberi Anda opsi yang dijelaskan dalam Membuat laporan kustom. Setelah memasukkan opsi tersebut, klik Buat untuk membuat tugas laporan.

Baca bagian Melihat tugas laporan untuk mengetahui informasi selengkapnya tentang tugas laporan.

Apigee Klasik

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.

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

  3. Untuk menjalankan laporan pada rentang waktu yang berbeda:

    1. Klik di 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/Ke, 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. Hasilnya akan ditampilkan di dasbor laporan kustom setelah laporan selesai.

      • Kirim Tugas untuk menjalankan laporan sebagai tugas laporan. Dialog berikut akan muncul:

        Pengiriman asinkron

        Klik Lihat Status dalam dialog untuk melihat status tugas laporan.

Melihat tugas laporan

Apigee di Konsol Cloud

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

Tab Laporkan Pekerjaan ditampilkan, seperti yang ditunjukkan di bawah ini:

Laporkan tugas

Halaman Laporkan Pekerjaan memungkinkan Anda:

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

  • 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 mencari string tersebut.

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

Apigee Klasik

Untuk melihat tugas laporan, pilih salah satu opsi berikut:

  • Klik View Status pada dialog Report Dikirim sebagai Pekerjaan Latar Belakang.
  • Pilih Analisis > Laporan Kustom > Laporkan Tugas dari menu navigasi sebelah kiri.

Halaman Laporkan Pekerjaan ditampilkan, seperti yang ditunjukkan dalam gambar berikut:

Laporkan tugas

Halaman Laporkan Pekerjaan memungkinkan Anda:

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

  • Pilih lingkungan tempat Anda ingin menampilkan tugas laporan.

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

  • Download laporan kustom.

Mengedit laporan kustom

Apigee di Konsol Cloud

Untuk mengedit laporan kustom:

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

Apigee Klasik

Untuk mengedit laporan kustom:

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

Anda kembali ke hasil laporan kustom.

Menghapus laporan kustom

Apigee di Konsol Cloud

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

Apigee Klasik

Untuk menghapus laporan kustom:

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