PreviewAnomalyDetector API

Gunakan PreviewAnomalyDetector operasi untuk membuat titik akhir yang menunjukkan bagaimana data metrik Anda akan dianalisis oleh algoritme deteksi anomali selama periode waktu yang ditentukan. Titik akhir ini membantu Anda mengevaluasi dan memvalidasi kinerja detektor sebelum implementasi.

Kata kerja HTTP yang valid

GET, POST

Jenis payload yang didukung

Parameter yang dikodekan URL

application/x-www-form-urlencodeduntuk POST

Parameter yang didukung

query=<string>Sebuah string kueri ekspresi Prometheus.

start=<rfc3339 | unix_timestamp>Mulai stempel waktu jika Anda menggunakan kueri query_range untuk rentang waktu tertentu.

end=<rfc3339 | unix_timestamp>Akhiri stempel waktu jika Anda menggunakan kueri query_range untuk rentang waktu tertentu.

step=<duration | float>Lebar langkah resolusi kueri dalam duration format atau sebagai float beberapa detik. Gunakan hanya jika Anda menggunakan kueri query_range untuk rentang waktu tertentu, dan diperlukan untuk kueri tersebut.

Pemformatan parameter kueri

Bungkus ekspresi promQL asli Anda dengan fungsi semu RandomCutForest (RCF) dalam parameter kueri. Untuk informasi selengkapnya, lihat RandomCutForestConfigurationdi Layanan Terkelola Amazon untuk Referensi API Prometheus.

Fungsi RCF menggunakan format ini:

RCF(<query>
[,shingle size
[,sample size
[,ignore near expected from above
[,ignore near expected from below
[,ignore near expected from above ratio
[,ignore near expected from below ratio]]]]])

Semua parameter kecuali kueri bersifat opsional dan menggunakan nilai default saat dihilangkan. Sintaks minimal adalah:

RCF(<query>)

Anda harus membungkus kueri Anda dengan fungsi agregasi. Untuk menggunakan parameter opsional tertentu sambil menghilangkan yang lain, biarkan posisi kosong dalam fungsi:

RCF(<query>,,,,,1.0,1.0)

Contoh ini hanya menetapkan parameter rasio yang mengabaikan lonjakan dan penurunan deteksi anomali berdasarkan rasio antara nilai yang diharapkan dan yang diamati.

Permintaan dan respons API

Panggilan yang berhasil mengembalikan format yang sama dengan QueryMetrics API. Selain deret waktu asli, API mengembalikan deret waktu baru ini ketika sampel yang cukup tersedia:

• anomaly_detector_preview:lower_band— Pita bawah untuk nilai yang diharapkan dari hasil ekspresi promQL

• anomaly_detector_preview:score— Skor anomali antara 0 dan 1, di mana 1 menunjukkan kepercayaan tinggi dari anomali pada titik data tersebut

• anomaly_detector_preview:upper_band— Pita atas untuk nilai yang diharapkan dari hasil ekspresi promQL

Permintaan sampel

POST /workspaces/workspace-id/anomalydetectors/preview
Content-Type: application/x-www-form-urlencoded

query=RCF%28avg%28vector%28time%28%29%29%29%2C%208%2C%20256%29&start=1735689600&end=1735695000&step=1m

Sampel respon

200 OK
...

{
  "status": "success",
  "data": {
    "result": [
      {
        "metric": {},
        "values": [
          [
            1735689600,
            "1735689600"
          ],
          [
            1735689660,
            "1735689660"
          ],
          .........
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "upper_band"
        },
        "values": [
          [
            1735693500,
            "1.7356943E9"
          ],
          [
            1735693560,
            "1.7356945E9"
          ]
          ],
          .........
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "lower_band"
        },
        "values": [
          [
            1735693500,
            "1.7356928E9"
          ],
          [
            1735693560,
            "1.7356929E9"
          ],
          ......... 
        ]
      },
      {
        "metric": {
          "anomaly_detector_preview": "score"
        },
        "values": [
          [
            1735693500,
            "0.0"
          ],
          [
            1735695000,
            "0.0"
          ],
          .........
        ]
      }
    ],
    "resultType": "matrix"
  }
}