Ringkasan anomali operasi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Anomali operasi mengidentifikasi pola data yang tidak biasa atau tidak terduga dengan API Anda. Anomali operasi terus memantau dan melakukan analisis statistik untuk menemukan anomali.

Anomali operasi otomatis mendeteksi jenis anomali berikut:

• Peningkatan semua error HTTP 4xx atau 5xx di tingkat organisasi, lingkungan, dan region
• Peningkatan total latensi respons untuk persentil ke-90 (p90) di tingkat organisasi, lingkungan, dan wilayah

Misalnya, dalam grafik tingkat error API ini, tingkat error tiba-tiba melonjak sekitar pukul 07.00. Dibandingkan dengan data sebelum waktu tersebut, peningkatan ini cukup tidak biasa untuk diklasifikasikan sebagai anomali.

Anomali operasi juga dapat membedakan variasi yang cenderung tidak menunjukkan anomali. Misalnya, Anda dapat melihat beberapa variasi kecil dalam tingkat error menjelang anomali, tetapi variasi ini tidak cukup signifikan untuk dikategorikan sebagai anomali.

Anomali operasi memungkinkan Anda:

• Melihat dan menyelidiki anomali: Laporan anomali operasi menampilkan peristiwa API yang tidak biasa (anomali). Anda dapat melihat perincian untuk mengetahui di mana dan kapan insiden terjadi, serta apa yang memicunya, sehingga Anda dapat dengan cepat mengatasi situasi tersebut.
• Buat pemberitahuan anomali dan siapkan notifikasi agar Apigee mengirimkan pesan kepada Anda saat terjadi insiden.

Prasyarat untuk menggunakan anomali operasi

Untuk menggunakan anomali operasi:

• Add-on AAPI Ops harus diaktifkan untuk organisasi Anda. Lihat Mengaktifkan Operasi AAPI di organisasi.
• Pengguna anomali operasi harus memiliki peran berikut:
  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer
• Pengguna yang menyelidiki anomali di dasbor juga memerlukan peran roles/logging.viewer.

Mengaktifkan Operasi AAPI di organisasi

Untuk menggunakan Operasi AAPI, Anda harus mengaktifkannya di organisasi Anda. Sebelum melakukannya, dapatkan token akses OAuth 2.0 terlebih dahulu. Kemudian, Anda dapat mengaktifkan Operasi AAPI menggunakan panggilan API yang meneruskan token akses.

Melihat konfigurasi add-on saat ini

Sebelum mengaktifkan Operasi AAPI, periksa apakah sudah diaktifkan dengan melakukan panggilan API berikut:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

dengan YOUR_ORG adalah nama organisasi Anda dan $TOKEN adalah variabel lingkungan untuk token akses OAuth. Perintah ini menampilkan informasi dasar tentang organisasi Anda, yang mencakup bagian untuk add-on Apigee yang dimulai dengan baris:

"addonsConfig": {

Periksa apakah bagian ini berisi entri yang dimulai dengan "advancedApiOpsConfig", seperti contoh berikut:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Jika entri ini ada, AAPI Ops sudah diaktifkan di organisasi. Jika tidak, Anda harus mengaktifkannya seperti yang dijelaskan selanjutnya.

Mengaktifkan Operasi AAPI

Untuk mengaktifkan Operasi AAPI di organisasi dengan konfigurasi default, kirim permintaan POST seperti yang ditunjukkan di bawah.

Perhatian: Panggilan API ini akan menggantikan konfigurasi add-on saat ini. Anda harus menyertakan konfigurasi saat ini untuk semua add-on dalam permintaan di atas agar tidak ditimpa.

Catatan: Panggilan API di bawah memulai operasi yang berjalan lama yang mungkin memerlukan waktu beberapa saat untuk diselesaikan.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

dengan <Current add-ons configuration> adalah konfigurasi add-on saat ini. Anda dapat menemukan konfigurasi add-on saat ini dalam respons terhadap panggilan untuk melihat konfigurasi add-on saat ini. Misalnya, jika konfigurasi add-on saat ini adalah

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

perintah untuk mengaktifkan Operasi AAPI adalah

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Setelah mengirim permintaan, Anda akan melihat respons seperti berikut:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Menonaktifkan Operasi AAPI di organisasi Anda

Jika karena alasan tertentu Anda perlu menonaktifkan Operasi AAPI di organisasi Anda, Anda dapat melakukannya dengan mengirimkan permintaan POST, meneruskan konfigurasi add-on di isi permintaan Anda, seperti yang ditunjukkan di bawah ini.

Perhatian: Konfigurasi add-on yang Anda teruskan dalam isi permintaan akan menimpa konfigurasi add-on saat ini. Lihat konfigurasi add-on saat ini di profil organisasi Apigee dan pastikan untuk menyertakannya dalam payload permintaan.

Catatan: Panggilan API di bawah memulai operasi yang berjalan lama yang mungkin memerlukan waktu beberapa saat untuk selesai.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

Berikut adalah contoh respons yang menunjukkan bahwa operasi sedang berlangsung:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Untuk mengetahui informasi selengkapnya, lihat Configure organization add-ons API.

Cara kerja deteksi anomali

Deteksi anomali melibatkan tahap-tahap berikut:

• Melatih model
• Mencatat peristiwa anomali

Melatih model

Anomali operasi berfungsi dengan melatih model perilaku proxy API Anda dari data deret waktu historis. Anda tidak perlu melakukan tindakan apa pun untuk melatih model. Apigee secara otomatis membuat dan melatih model untuk Anda dari data API enam jam sebelumnya. Oleh karena itu, Apigee memerlukan data minimal enam jam pada proxy API untuk melatih model sebelum dapat mencatat anomali.

Tujuan pelatihan adalah untuk meningkatkan akurasi model, yang kemudian dapat diuji pada data historis. Cara paling sederhana untuk menguji akurasi model adalah dengan menghitung tingkat error-nya— jumlah positif palsu dan negatif palsu, dibagi dengan jumlah total peristiwa yang diprediksi.

Peristiwa anomali log

Saat runtime, anomali operasi membandingkan perilaku Proxy API saat ini dengan perilaku yang diprediksi oleh model. Anomali operasi kemudian dapat menentukan, dengan tingkat keyakinan tertentu, kapan metrik operasional melebihi nilai yang diprediksi. Misalnya, saat tingkat error 5xx melebihi tingkat yang diprediksi oleh model.

Saat mendeteksi anomali, Apigee akan otomatis mencatat peristiwa tersebut di dasbor anomali operasi. Daftar peristiwa yang ditampilkan di dasbor mencakup semua anomali yang terdeteksi, serta pemberitahuan yang dipicu.