Anormallik algılama API'sini kullanma

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Anormallik uyarıları oluşturmak, yönetmek ve anormallik metrikleri toplamak için kullandığınız API'lerin çoğu, sabit uyarılarla kullandığınız API'lerle aynıdır. Aşağıdaki uyarı API'leri, hem sabit hem de anormallik uyarıları için aynı şekilde çalışır:

Ancak bazı API'ler, anormallik uyarılarını desteklemek için kullanılan ek özelliklere sahiptir. Örneğin:

  • Uyarıları al: Düzeltilen uyarılar ve anormallik uyarıları dahil olmak üzere tüm uyarıları listeleyin.
  • Uyarı oluştur: Düzeltilmiş veya anormallik uyarısı oluşturun.
  • Uyarı güncelleme: Düzeltilmiş veya anormallik uyarı tanımını güncelleyebilirsiniz.

$ACCESS_TOKEN ayarlanıyor

Aşağıda gösterilen tüm API çağrıları, kimlik bilgilerinizi $ACCESS_TOKEN adlı bir ortam değişkeninde geçirir. OAuth 2.0 erişim jetonunuz için $ACCESS_TOKEN öğesini şurada açıklandığı şekilde ayarlayın: OAuth 2.0 erişim jetonu alın. Bu örneklerde kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL kullanın.

Uyarılar alma

Varsayılan olarak, Uyarıları al API, tanımlı tüm uyarılarla ilgili bilgileri döndürür. Bu API artık sonuçları filtrelemenizi sağlamak için sorgu parametrelerini alır:

  • enabled - true yalnızca etkin uyarıların döndürüleceğini belirtirse. Varsayılan değer false değeridir.
  • alertType - Döndürülecek uyarının türünü belirtir. İzin verilen değerler: runtime, Varsayılan değer, cert.
  • alertSubType - Döndürülecek uyarı alt türünü belirtir. Varsayılan değer ayarlanmamıştır yani tüm uyarı alt türlerini döndürür. Anormallik uyarılarını döndürmek için anomaly değerini belirtin.

Örneğin, yalnızca şu isimli kuruluş için etkinleştirme uyarılarını döndürmek üzere aşağıdaki API çağrısını kullanın: myorg:

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

Aşağıdaki çağrı, hem etkin hem de devre dışı olan yalnızca anormallik uyarılarını döndürür:

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

Anormallik uyarısı oluşturma veya güncelleme

Oluşturmak için aynı API'leri kullanın. veya güncelleyin anormallik uyarısı alabilirsiniz. Oluşturma veya güncelleme için API çağrısının gövdesi anormallik uyarısı, sabit bir uyarı için kullanılan uyarıyla aynıdır ancak şu değişiklikler gerçekleşir:

  • Uyarının bir anormallik uyarısı olduğunu belirtmek için aşağıdaki yeni özellikleri eklemeniz gerekir:

    "alertType": "runtime"
"alertSubType": "anomaly"

    Bu özelliklerin varsayılan değerleri şunlardır:

    "alertType": "runtime"
"alertSubType": "fixed"

  • conditions dizisinde:

    • metrics özelliği yalnızca şu değerleri alır:

      • count - HTTP hata sayılarıyla ilgili uyarı verir.
      • totalLatency - Gecikme için uyarı gönderin.
    • threshold özelliği, sayı yerine bir dize alır. Desteklenen değerler şunlardır: slight, moderate ve severe.
    • durationSeconds ve comparator özellikleri desteklenmez.

  • conditions dizisinin dimensions öğesinde:

    • proxy özelliğinin değerini ALL olarak ayarlamanız gerekir.
    • statusCode özelliği yalnızca 4xx, 503, 504, and 5xx değerini destekler.
    • developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName mülkleri desteklenmiyor.
  • reportEnabled özelliği, anormallik uyarıları için desteklenmez.

Aşağıdaki örnek API çağrısı, 5xx durum kodları olduğunda tetiklenen bir anormallik uyarısı oluşturur . Bildirim uyarı tetiklendiğinde belirtilen e-posta adresine gönderilir:

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":"5xx Anomaly Alert",
     "description":"My 5xx alert",
     "environment":"prod",
     "enabled":true,
     "alertType": "runtime",
     "alertSubType": "anomaly",
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ANY",
            "statusCode":"5xx"
        },
        "metric":"count",
        "threshold": "moderate"
     }
     ],
     "notifications":[{
         "channel":"email",
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600
    }'

Etkinlik API'sini anormalliklerle kullanma

/metrics/events kullanın Belirli bir zaman aralığı boyunca bir kuruluştaki tüm etkinlikleri almak için kullanılan API. Etkinlikler listesi şunları içerir: Edge'in algıladığı anormallikler ve tetiklenen uyarılar. Uyarılar hem sabit hem de anormallik uyarılarını içerebilir.

Varsayılan olarak, API önceki saate ait tüm etkinlikleri döndürür. from ve Farklı bir süre belirtmek için to sorgu parametresi. from ve Farklı bir süre belirtmek için to sorgu parametresi.

Örneğin, aşağıdaki API çağrısı myorg kuruluşundaki tüm etkinlikleri döndürür son 12 saat için:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"

OAuth 2.0 erişim jetonunuz için $ACCESS_TOKEN öğesini şurada açıklandığı şekilde ayarlayın: OAuth 2.0 erişim jetonu alın. Daha fazla bilgi için bu örnekte kullanılan cURL seçenekleri için cURL'yi kullanma bölümüne bakın.

Sonraki çağrı, son 24 saat içinde orta düzeyde bir eşiğe sahip tüm anormallik etkinliklerini döndürür: 

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
"https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&type=anomaly&threshold=moderate&from=-24h&to=now"

Bu API için yalnızca org sorgu parametresi gereklidir. Sorgu parametreleriyle birlikte /metrics/events adresindeki API dokümanında açıklandığı bu API, anormallik algılamayı desteklemek için aşağıdaki seçenekleri destekler:

Ad Açıklama Varsayılan
threshold

Etkinlikleri belirtilen eşiğe göre filtreleyin: slight, moderate veya severe.

Yalnızca type=anomaly ayarladığınızda izin verilir.

Tüm önem dereceleri
type Etkinlikleri belirtilen türe göre filtreleyin: alert veya anomaly. Birden çok değeri virgülle ayrılmış liste olarak belirtin. Tüm türler