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 metrik dan dimensi apa pun yang disertakan 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 tugas pelaporan.

Ketersediaan laporan kustom

Jika Anda adalah pelanggan Langganan Apigee, akses ke Analytics Apigee API dan fungsi laporan kustom disertakan dalam hak langganan Anda dan diaktifkan secara otomatis 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 membuat laporan kustom. Untuk informasi selengkapnya tentang cara mengaktifkan add-on Analisis API Apigee untuk lingkungan Apigee Intermediet atau Komprehensif, lihat Mengelola add-on Analisis API Apigee.

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

Tentang laporan kustom

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

Anda juga dapat menetapkan jenis diagram yang ditampilkan dalam laporan kustom sebagai diagram kolom atau garis. Gambar berikut menunjukkan 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

  • Garis - setiap API diwakili oleh garis yang berbeda:

    Diagram garis kustom

Menetapkan metrik dan dimensi

Metrik yang Anda pilih untuk laporan kustom menentukan data yang ingin Anda ukur. Metrik umum meliputi:
  • 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 untuk dijalankan pada 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 metrik 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.

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

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

Contoh laporan kustom

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

  • type = Column
  • 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:

tps laporan kustom

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

  • type = Column
  • metrik = Transaksi rata-rata 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 menyertakan dua metrik dan dua dimensi:

  • type = Column
  • 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 pelaporan.

  • 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, ratusan GB), laporan real-time mungkin gagal karena waktu tunggu habis.

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

    Lihat Menjalankan laporan kustom.

  • Untuk tugas laporan, Anda meminta laporan dan mengambil hasilnya nanti. Beberapa situasi saat tugas laporan mungkin merupakan alternatif yang baik mencakup:

    • Menganalisis dan membuat laporan yang mencakup interval waktu yang besar.
    • Menganalisis data dengan berbagai dimensi pengelompokan dan batasan lainnya yang menambah kompleksitas 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. Lihat Melihat tugas laporan.

Buka halaman Laporan Kustom

Apigee di konsol Cloud

Untuk membuka halaman Laporan Kustom:

  1. Buka UI Apigee di Cloud Console.
  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 tugas pelaporan.

Kedua tab tersebut menampilkan daftar laporan atau tugas laporan yang telah dibuat. Untuk melihat laporan atau tugas laporan, 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: Metrik dan fungsi agregasi (seperti jumlah) yang disertakan dalam laporan.
  • Terakhir Diubah: Waktu dan tanggal terakhir laporan dijalankan.

Laporkan Pekerjaan

Tab Tugas Laporan menampilkan informasi berikut tentang setiap tugas laporan:

  • Nama Laporan: Nama laporan.
  • Rentang Waktu Mulai (UTC): Waktu mulai tugas laporan.
  • Rentang Waktu Akhir (UTC): Waktu akhir tugas laporan.
  • Status: Status tugas laporan, yang dapat berupa berjalan, selesai, atau habis masa berlakunya.
  • Dikirim: Tanggal dan waktu saat tugas laporan dikirim.

Halaman Laporan Kustom memungkinkan Anda:

Apigee Klasik

Untuk membuka halaman Laporan Kustom:

  1. Login ke UI Apigee.
  2. Pilih Analyze > Custom Reports > Reports.

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

Dasbor laporan kustom

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

  • Melihat daftar semua laporan kustom.
  • Menambahkan laporan kustom.
  • Jalankan laporan kustom dengan mengklik namanya dalam daftar. Laporan 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 menemukan string.
  • Menghapus laporan kustom.

Menjelajahi dasbor laporan kustom

Dasbor laporan kustom menampilkan hasil laporan kustom Anda 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 yang data laporan kustomnya ingin Anda lihat.
  • Pilih dimensi tertentu untuk memfilter data laporan kustom. Area ini hanya diaktifkan saat Anda menentukan beberapa dimensi ke laporan.
  • Pilih tampilan Diagram atau Tabel.

  • Analisis metrik dengan memilih ikon Ikon analisis laporan kustom. 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. Nama filenya adalah 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 Tugas Laporan Kustom.
  3. Di bagian Basic, masukkan informasi berikut:
    • Nama Laporan: Nama laporan.
    • Khusus untuk laporan real-time, Anda juga dapat memasukkan Deskripsi opsional laporan.
  4. Bagian berikut bergantung pada apakah Anda membuat laporan real-time dari tugas laporan:
    • Khusus untuk laporan real-time:

      Setelah Jenis Diagram, pilih gaya diagram untuk menampilkan data Anda:

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

    • Khusus tugas laporan:
      • Detail Laporan: 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 dijalankan.
      • Rentang Tanggal Laporan: Pilih Waktu mulai dan Waktu akhir untuk laporan.

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

  5. Di bagian Metrik:
    1. Pilih metrik yang ingin Anda analisis.
    2. Pilih Aggregate function untuk menampilkan nilai Sum, Average, Min, atau Max.
    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 tambahan untuk lebih membatasi data.
  7. 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 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 Nilai.
    3. Masukkan nilai untuk metrik atau dimensi.
    4. Klik Done 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.
    Laporkan deskripsi Deskripsi laporan.
    Jenis diagram Pilih gaya diagram yang akan digunakan untuk menyajikan data analisis kustom Anda.
    • Kolom: Sumbu X mewakili grup yang ditetapkan oleh dimensi.
    • Garis: Sumbu X mewakili waktu.
  4. Di bagian Metrik:
    1. Klik ikon Ikon plus. untuk Metrik.
    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 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 Dimensions, klik Ikon plus dan 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 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 jane@example.com.

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

Laporan ini menampilkan diagram data dan tabel ringkasan.

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

  • Lingkungan: Lingkungan tempat menjalankan laporan.
  • Jangka waktu untuk laporan.
  • Dimensi: Dimensi untuk laporan. Hanya satu dimensi yang dapat ditampilkan dalam satu waktu.
  • Nilai: Nilai tertentu untuk dimensi, atau Semua 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: Kirim laporan sebagai tugas laporan. Saat Anda mengklik Kirim Tugas, dialog akan terbuka dan memberi Anda opsi yang dijelaskan dalam Membuat laporan kustom. Setelah memasukkan opsi, klik Buat untuk membuat tugas laporan.

Lihat 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 satu jam sebelumnya.

    Catatan: Jika laporan memerlukan 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 Custom Report Time Selection.
    2. Pilih salah satu:
      • Rentang waktu standar, seperti Satu Jam Terakhir, Kemarin, atau 7 Hari Terakhir.
      • Rentang Kustom dengan memilih tanggal dan waktu Dari/Sampai, atau gunakan kalender untuk memilih tanggal mulai dan akhir. Klik UTC untuk menggunakan Waktu Universal Terkoordinasi (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:

        Kirim asinkron

        Klik Lihat Status di dialog untuk melihat status tugas laporan.

Melihat tugas laporan

Apigee di konsol Cloud

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

Tab Laporkan Tugas akan ditampilkan, seperti yang ditunjukkan di bawah ini:

Melaporkan tugas

Halaman Tugas Pelaporan memungkinkan Anda:

  • Melihat semua tugas laporan yang telah dikirim 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 menemukan string tersebut.

Untuk melihat laporan kustom, pastikan Status-nya sudah selesai. Kemudian, klik nama laporan untuk melihat laporan.

Apigee Klasik

Untuk melihat tugas laporan, pilih salah satu opsi berikut:

  • Klik Lihat Status di dialog Laporan Dikirim sebagai Tugas Latar Belakang.
  • Pilih Analyze > Custom Reports > Report Jobs dari menu navigasi sebelah kiri.

Halaman Tugas Pelaporan akan ditampilkan, seperti yang ditunjukkan pada gambar berikut:

Melaporkan tugas

Halaman Tugas Pelaporan memungkinkan Anda:

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

  • Pilih lingkungan tempat Anda ingin menampilkan tugas laporan.

  • Untuk melihat laporan kustom, pastikan Status-nya sudah 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 di bagian Tindakan.
  3. Pilih Edit. Tindakan ini akan membuka dialog Edit laporan kustom, tempat Anda dapat mengedit opsi untuk laporan. Opsi ini 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 Ikon edit dan hapus Ikon hapus akan muncul di sisi kanan halaman.
  3. Klik ikon edit.
  4. Edit detail laporan kustom.
  5. Klik Simpan.

Anda akan diarahkan 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 Ikon edit dan hapus Ikon hapus akan muncul di sisi kanan halaman.
  3. Klik ikon hapus untuk menghapus laporan.