PreviewAnomalyDetector API - Amazon Managed Service for Prometheus
Formatage des paramètres de requêteDemande et réponse à l'API

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

PreviewAnomalyDetector API

Utilisez cette PreviewAnomalyDetector opération pour créer un point de terminaison qui montre comment vos données métriques seront analysées par l'algorithme de détection des anomalies au cours de la période spécifiée. Ce point de terminaison vous aide à évaluer et à valider les performances du détecteur avant sa mise en œuvre.

Verbes HTTP valides

GET, POST

Types de charge utile pris en charge

Paramètres codés en URL

application/x-www-form-urlencoded pour POST

Paramètres pris en charge

query=<string> Chaîne de requête d’expression Prometheus.

start=<rfc3339 | unix_timestamp> Démarrez l’horodatage si vous utilisez query_range pour effectuer des requêtes sur un intervalle de temps.

end=<rfc3339 | unix_timestamp> Arrêtez l’horodatage si vous utilisez query_range pour effectuer des requêtes sur un intervalle de temps.

step=<duration | float> Interrogez la durée de l’étape de résolution sous forme de duration ou sous forme d’un nombre float de secondes. À utiliser uniquement si vous utilisez query_range pour effectuer des requêtes sur un intervalle de temps, et nécessaire pour ce type de requêtes.

Formatage des paramètres de requête

Enveloppez votre expression ProMQL d'origine avec la pseudo-fonction RandomCutForest (RCF) dans le paramètre de requête. Pour plus d'informations, consultez le RandomCutForestConfigurationmanuel Amazon Managed Service for Prometheus API Reference.

La fonction RCF utilise le format suivant :

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]]]]])

Tous les paramètres, à l'exception de la requête, sont facultatifs et utilisent des valeurs par défaut lorsqu'ils sont omis. La syntaxe minimale est la suivante :


RCF(<query>)

Vous devez encapsuler votre requête à l'aide d'une fonction d'agrégation. Pour utiliser des paramètres facultatifs spécifiques tout en omettant d'autres, laissez des positions vides dans la fonction :


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

Cet exemple définit uniquement les paramètres de ratio qui ignorent les pics et les baisses de détection d'anomalies en fonction du rapport entre les valeurs attendues et observées.

Demande et réponse à l'API

Les appels réussis renvoient le même format que l'QueryMetrics API. Outre les séries chronologiques d'origine, l'API renvoie ces nouvelles séries chronologiques lorsque suffisamment d'échantillons sont disponibles :

  • anomaly_detector_preview:lower_band— Bande inférieure pour la valeur attendue du résultat de l'expression ProMQL

  • anomaly_detector_preview:score— Score d'anomalie compris entre 0 et 1, où 1 indique un niveau de confiance élevé quant à une anomalie à ce point de données

  • anomaly_detector_preview:upper_band— Bande supérieure pour la valeur attendue du résultat de l'expression ProMQL

Exemple de demande 

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

Exemple de réponse 

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"
  }
}