Anormallik algılama API'sini kullanma

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Anormallik uyarıları oluşturmak, yönetmek ve anormallik metriklerini 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'lerin, anormallik uyarılarını desteklemek için kullanılan ek özellikleri vardır. Örneğin:

  • Uyarı al: Sabit ve anormallik uyarıları dahil olmak üzere tüm uyarıları listeler.
  • Uyarı oluştur: Düzeltildi veya anormallik uyarısı oluşturun.
  • Bir uyarıyı güncelleme - Düzeltilmiş veya anormal bir uyarı tanımını güncelleyin.

$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 iletir. $ACCESS_TOKEN öğesini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın. Bu örneklerde kullanılan cURL seçenekleri hakkında bilgi için cURL kullanma bölümüne bakın.

Uyarıları al

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

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

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

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

Aşağıdaki çağrı, yalnızca etkin ve devre dışı olan 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

Anormallik uyarısı oluşturmak veya güncellemek için şu anda sabit bir uyarıda yaptığınız gibi API'leri kullanın. Anormallik uyarısı oluşturmak veya güncellemek için kullanılan API çağrısı gövdesi, sabit bir uyarı için kullanılanla aynıdır ancak aşağıdaki değişiklikler söz konusudur:

  • 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 hatası sayısı ile ilgili uyarı ver.
      • totalLatency - Gecikme için uyarı ver.
    • 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 özellikleri desteklenmez.
  • reportEnabled özelliği, anormallik uyarıları için desteklenmez.

Aşağıdaki örnek API çağrısı, herhangi bir bölge için üretim ortamındaki tüm API proxy'leri için orta hızda 5xx durum kodları gerçekleştiğinde tetiklenen bir anormallik uyarısı oluşturur. Uyarı tetiklendiğinde, belirtilen e-posta adresine bir bildirim 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
    }'

Anormalliklerle events API'yi kullanma

Belirli bir zaman aralığında bir kuruluştaki tüm etkinlikleri almak için /metrics/events API'yi kullanın. Etkinlik listesi, Edge tarafından algılanan anormallikleri ve tetiklenen tüm uyarıları içerir. Uyarılar hem sabit hem de anormallik uyarıları içerebilir.

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

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

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

$ACCESS_TOKEN öğesini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi için cURL kullanma bölümüne bakın.

Bir sonraki çağrı, son 24 saat içinde orta düzeyde bir eşiği olan 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 gerekir. Bu API, /metrics/events adresindeki API dokümanında açıklanan sorgu parametreleriyle birlikte 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