Menyiapkan laporan lalu lintas

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

Gunakan pemberitahuan lalu lintas untuk meningkatkan notifikasi saat traffic untuk lingkungan, proxy, atau region berubah sebesar persentase tertentu selama rentang waktu tertentu.

Anda menetapkan rentang waktu ke:

  • 1 jam
  • 1 hari
  • 7 hari
  • 15 hari (khusus API)
  • 30 hari (khusus API)

Notifikasi berfungsi dengan membandingkan traffic untuk rentang waktu saat ini dengan traffic pada rentang waktu sebelumnya. Misalnya, Anda menentukan rentang waktu satu jam. Notifikasi kemudian membandingkan traffic selama satu jam terakhir dengan traffic pada jam sebelumnya untuk menghitung perubahan persentase dalam traffic:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Nilai positif berarti traffic meningkat, dan nilai negatif berarti traffic menurun.

Kemudian, Anda menetapkan nilai minimum yang memicu notifikasi traffic sebagai peningkatan atau penurunan persentase traffic API selama jangka waktu yang ditentukan.

Sebelum menetapkan persentase tersebut, pastikan persentase tersebut sesuai dengan pola lalu lintas. Misalnya, jika traffic API Anda biasanya berfluktuasi sepanjang hari dengan lonjakan traffic per jam hingga 100% pada waktu puncak tertentu, lonjakan ini normal dan seharusnya tidak memicu peringatan. Namun, jika Anda kemudian mengonfigurasi pemberitahuan untuk dipicu untuk setiap peningkatan 50% dalam lalu lintas per jam, Anda akan mendapatkan peringatan yang tidak perlu untuk lalu lintas normal Anda.

Untuk mengetahui informasi selengkapnya tentang pemberitahuan, lihat Menyiapkan pemberitahuan dan notifikasi.

Menambahkan laporan dan notifikasi lalu lintas

Untuk menambahkan laporan dan notifikasi lalu lintas:
  1. Klik Analisis > Aturan Pemberitahuan di UI Edge.
  2. Klik +Alert.
  3. Masukkan informasi umum berikut tentang pemberitahuan:
    Kolom Deskripsi
    Nama notifikasi Nama notifikasi. Gunakan nama yang menjelaskan pemicu dan berarti bagi Anda. Nama tidak boleh lebih dari 128 karakter.
    Deskripsi Deskripsi notifikasi.
    Jenis Notifikasi Pilih Total traffic. Lihat Tentang jenis notifikasi untuk mengetahui informasi lebih lanjut.
    Lingkungan Pilih lingkungan dari menu drop-down.
    Status Klik tombol untuk mengaktifkan atau menonaktifkan notifikasi.
  4. Tentukan batas dan dimensi untuk kondisi yang akan memicu pemberitahuan.
    Kolom Kondisi Deskripsi
    Batas

    Tentukan untuk menaikkan pemberitahuan saat traffic telah meningkat sebesar atau berkurang sebesar persentase tertentu jika dibandingkan dengan interval waktu sebelumnya.

    Tetapkan persentase ditingkatkan ke nilai yang lebih besar atau sama dengan 0%. Setel dikurangi sebesar persentase ke nilai yang lebih besar atau sama dengan 0%, dan kurang dari atau sama dengan 100%.

    Anda dapat memilih interval waktu:

    • 1 jam
    • 1 hari
    • 1 minggu
    Dimensi

    Klik +Tambahkan Dimensi dan tentukan detail dimensi yang akan ditampilkan hasilnya proxy dan region API.

    Tetapkan dimensi tertentu ke:

    • Proxy - Menetapkan ke proxy tertentu atau ke Semua proxy. Proxy tidak mendukung nilai "Any". Sebagai gantinya Anda dapat menambahkan peringatan terpisah untuk setiap proxy yang Anda inginkan.
    • Region - Tetapkan ke wilayah tertentu atau ke All region. Region tidak mendukung nilai "Any". Sebagai gantinya Anda dapat menambahkan pemberitahuan terpisah untuk setiap wilayah yang Anda minati.
  5. Klik + Notifikasi untuk menambahkan notifikasi peringatan.
    Detail Notifikasi Deskripsi
    Saluran Pilih saluran notifikasi yang ingin digunakan dan tentukan tujuannya: Email, Slack, PagerDuty, atau Webhook.
    Destination Tentukan tujuan berdasarkan jenis saluran yang dipilih:
    • Email - Alamat email, seperti joe@company.com
    • Slack - URL channel Slack, seperti https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - Kode PagerDuty, seperti abcd1234efgh56789
    • Webhook - URL Webhook, seperti https://apigee.com/test-webhook

      Catatan: Anda hanya dapat menetapkan satu tujuan per notifikasi. Guna menentukan beberapa tujuan untuk jenis saluran yang sama, tambahkan notifikasi tambahan.
  6. Untuk menambahkan notifikasi tambahan, ulangi langkah sebelumnya.
  7. Jika Anda menambahkan notifikasi, tetapkan kolom berikut:
    Kolom Deskripsi
    Playbook (Opsional) Kolom teks bentuk bebas untuk memberikan deskripsi singkat tentang tindakan yang disarankan untuk untuk menyelesaikan peringatan ketika mereka memberi peringatan. Anda juga dapat menentukan tautan ke wiki internal Anda atau halaman komunitas tempat Anda mereferensikan praktik terbaik. Informasi di {i>field<i} ini akan yang disertakan dalam pemberitahuan. Konten di kolom ini tidak boleh melebihi 1.500 karakter.
    Gas Frekuensi pengiriman notifikasi. Pilih nilai dari menu drop-down.
  8. Klik Simpan.

Melihat pemberitahuan di dasbor Peristiwa

Saat mendeteksi kondisi pemberitahuan, Edge akan otomatis mencatat kondisi tersebut ke Dasbor Events di UI Edge. Daftar peristiwa yang ditampilkan di dasbor Peristiwa mencakup semua pemberitahuan, baik pemberitahuan tetap maupun sertifikat.

Untuk melihat notifikasi:

  1. Klik Analisis > Peristiwa di UI Edge. Dasbor Peristiwa baru akan muncul:

  2. Filter dasbor Peristiwa menurut:

    • Lingkungan
    • Wilayah
    • Jangka waktu
  3. Pilih baris di dasbor Peristiwa untuk menampilkan Keystore yang berisi sertifikat yang akan habis masa berlakunya menyelidiki pemberitahuan lebih lanjut. Dari halaman Keystore, Anda dapat mengupload sertifikat baru dan menghapus sertifikat yang akan kedaluwarsa.

Menggunakan API pemberitahuan dengan notifikasi lalu lintas

Sebagian besar API yang Anda gunakan untuk membuat dan mengelola notifikasi traffic sama dengan yang Anda gunakan dengan jenis pemberitahuan lainnya:

Namun, beberapa API memiliki properti tambahan yang digunakan untuk mendukung notifikasi anomali, termasuk:

Membuat atau memperbarui laporan lalu lintas

Gunakan API yang sama untuk membuat atau perbarui peringatan lalu lintas seperti yang saat Anda lakukan untuk jenis peringatan lainnya. Isi panggilan API untuk membuat atau memperbarui notifikasi traffic sama dengan yang digunakan untuk pemberitahuan lainnya, dengan perubahan berikut:

  • Tambahkan properti baru berikut untuk menentukan bahwa notifikasi adalah notifikasi lalu lintas:

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    Nilai default untuk properti ini adalah:

    "alertType": "runtime"
"alertSubType": "fixed"
  • Dalam elemen dimensions array conditions:
    • Anda harus menetapkan nilai org, env, proxy, dan region. Hanya properti tersebut yang didukung. Anda dapat menetapkan proxy dan region ke ALL.
    • Anda harus menetapkan nilai properti traffic ke total.

  • Dalam array conditions:

    • Properti metrics harus memiliki nilai trafficChange.
    • Properti comparator harus ditetapkan ke increasedBy atau decreasedBy.
    • Properti threshold berisi nilai positif yang menentukan persentase peningkatan atau penurunan traffic dengan nilai 1.0 sesuai dengan 100%. Untuk increasedBy nilainya harus lebih besar atau sama dengan 0,0 (0%). Untuk decreasedBy, nilainya harus berupa lebih besar dari atau sama dengan 0,0 (0%) dan kurang dari atau sama dengan 1,0 (100%).
    • Properti durationSeconds harus ditetapkan ke salah satu nilai berikut: 3600 (1 jam), 86400 (1 hari), 604800 (7 hari), 1296000 (15 hari), 2592000 (30 hari) .
  • Properti reportEnabled tidak didukung untuk notifikasi lalu lintas.
Contoh berikut menunjukkan cara menyiapkan peringatan yang dipicu saat lalu lintas untuk organisasi dan lingkungan meningkat 50% selama periode satu jam. Notifikasi dikirim ke kode PagerDuty yang ditentukan saat pemberitahuan dipicu. 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan di Dapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Lihat Melihat acara untuk mengetahui informasi selengkapnya tentang cara menggunakan API ini.

Dapatkan laporan lalu lintas

Secara default, Get Alerts API menampilkan informasi tentang semua pemberitahuan yang ditentukan. API ini sekarang menggunakan parameter kueri agar Anda dapat memfilter hasil:

  • enabled - Jika true menentukan untuk hanya menampilkan pemberitahuan yang diaktifkan. Nilai defaultnya adalah false.
  • alertType - Menentukan jenis notifikasi yang akan ditampilkan. Nilai yang diizinkan adalah runtime, default, dan cert.
  • alertSubType - Menentukan subjenis notifikasi yang akan ditampilkan. Nilai default tidak ditetapkan, yang berarti menampilkan semua subjenis pemberitahuan.

Misalnya, gunakan panggilan API berikut untuk hanya menampilkan notifikasi untuk organisasi bernama myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Panggilan berikut hanya mengembalikan notifikasi traffic, baik yang diaktifkan maupun dinonaktifkan:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.