Trafik uyarılarını ayarlama

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

Bir ortam, proxy veya bölgenin trafiği bir zaman aralığında belirli bir yüzde oranında değiştiğinde bildirim almak için bir trafik uyarısı kullanın.

Zaman aralığını şu şekilde ayarlarsınız:

  • 1 saat
  • 1 gün
  • 7 gün
  • 15 gün (yalnızca API)
  • 30 gün (yalnızca API)

Uyarı, geçerli zaman aralığındaki trafiği önceki zaman aralığının trafiğiyle karşılaştırarak çalışır. Örneğin, bir saatlik bir zaman aralığı belirtirsiniz. Uyarı, trafikteki yüzde değişimini hesaplamak için daha sonra en son saatteki trafiği önceki saatteki trafikle karşılaştırır:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Pozitif değer trafiğin arttığı, negatif değer ise trafiğin azaldığı anlamına gelir.

Ardından, trafik uyarısını tetikleyen eşiği, belirtilen süre boyunca API trafiğinde yüzdelik artış veya düşüş olarak ayarlarsınız.

Bu yüzdeyi ayarlamadan önce, normal trafik modellerinizle uyumlu olduğundan emin olun. Örneğin, API trafiğiniz yoğun saatlerde gün içinde normalde %100'e varan trafik artışlarıyla dalgalanıyorsa bu ani yükselmeler normaldir ve uyarı tetiklemez. Ancak daha sonra saatlik trafikteki% 50'lik bir artışı tetikleyecek bir uyarı yapılandırırsanız normal trafiğiniz için gereksiz uyarılar alırsınız.

Uyarılar hakkında daha fazla bilgi için Uyarıları ve bildirimleri ayarlama başlıklı makaleyi inceleyin.

Trafik uyarıları ve bildirimleri ekleyin

Trafik uyarıları ve bildirimleri eklemek için:
  1. Edge kullanıcı arayüzünde Analiz > Uyarı Kuralları'nı tıklayın.
  2. +Uyarı'yı tıklayın.
  3. Uyarıyla ilgili aşağıdaki genel bilgileri girin:
    Alan Açıklama
    Uyarı Adı Uyarının adı. Tetikleyiciyi açıklayan ve sizin için anlamlı olacak bir ad kullanın. Ad 128 karakterden uzun olamaz.
    Açıklama Uyarının açıklaması.
    Uyarı Türü Toplam trafik'i seçin. Daha fazla bilgi için Uyarı türleri hakkında bölümünü inceleyin.
    Ortam Açılır listeden ortamı seçin.
    Durum Uyarıyı etkinleştirmek veya devre dışı bırakmak için açma/kapatma düğmesini kullanın.
  4. Uyarıyı tetikleyecek koşul için eşiği ve boyutu tanımlayın.
    Koşul Alanı Açıklama
    Eşik

    Trafik önceki bir zaman aralığına kıyasla belirli bir yüzde arttığında veya azaldığında uyarının verilmesini sağlayın.

    Artır oranı yüzdesini %0 veya %0'a eşit bir değere ayarlayın. Yüzde azaltma oranı'nı en az %0 ve en fazla %100 olacak şekilde bir değere ayarlayın.

    Şu şekilde bir zaman aralığı seçebilirsiniz:

    • 1 saat
    • 1 gün
    • 1 hafta
    Boyut

    +Boyut Ekle'yi tıklayıp API proxy'si ve bölge dahil, sonuçların döndürüleceği boyut ayrıntılarını belirtin.

    Belirli bir boyutu şu şekilde ayarlayın:

    • Proxy: Belirli bir proxy'ye veya Tüm proxy'lere ayarlayın. Proxy, "Herhangi biri" değerini desteklemez. Bunun yerine, ilgilendiğiniz her proxy için ayrı bir uyarı ekleyebilirsiniz.
    • Bölge: Belirli bir bölgeye veya Tüm bölgelere ayarlayın. Bölge, "Herhangi biri" değerini desteklemez. Bunun yerine, ilgilendiğiniz her bölge için ayrı bir uyarı ekleyebilirsiniz.
  5. Uyarı bildirimi eklemek için + Bildirim'i tıklayın.
    Bildirim Ayrıntıları Açıklama
    Kanal Kullanmak istediğiniz bildirim kanalını seçin ve hedefi belirtin: Email, Slack, PagerDuty veya Webhook.
    Hedef Seçilen kanal türüne göre hedefi belirtin:
    • E-posta - E-posta adresi (ör. joe@company.com)
    • Slack - https://hooks.slack.com/services/T00000000/B00000000/XXXXX gibi Slack kanalı URL'si
    • PagerDuty - PagerDuty kodu (ör. abcd1234efgh56789)
    • Webhook - Webhook URL'si (ör. https://apigee.com/test-webhook)

      Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Aynı kanal türü için birden fazla hedef belirtmek üzere ek bildirimler ekleyin.

  6. Başka bildirimler eklemek için önceki adımı tekrarlayın.
  7. Bildirim eklediyseniz aşağıdaki alanları ayarlayın:
    Alan Açıklama
    Başucu Kitabı (İsteğe bağlı) Tetiklenen uyarıların çözümü için önerilen işlemlerin kısa bir açıklamasını sağlayan serbest biçimli metin alanı. En iyi uygulamalara başvurduğunuz dahili wiki veya topluluk sayfanızın bağlantısını da belirtebilirsiniz. Bu alandaki bilgiler bildirime dahil edilir. Bu alandaki içerik 1.500 karakteri aşamaz.
    Klape Bildirim gönderme sıklığı. Açılır listeden bir değer seçin.
  8. Kaydet'i tıklayın.

Uyarıları Etkinlikler kontrol panelinde görüntüleme

Edge bir uyarı koşulu algıladığında bu koşulu otomatik olarak Edge kullanıcı arayüzündeki Etkinlikler kontrol paneline kaydeder. Etkinlikler kontrol panelinde görüntülenen etkinliklerin listesi hem sabit hem de sertifikalı tüm uyarıları içerir.

Bir uyarıyı görüntülemek için:

  1. Edge kullanıcı arayüzünde Analiz > Etkinlikler'i tıklayın. Yeni Etkinlikler kontrol paneli görünür:

  2. Etkinlikler kontrol panelini şu ölçütlere göre filtreleyin:

    • Ortam
    • Bölge
    • Dönem
  3. Uyarıyı daha ayrıntılı bir şekilde incelemek için Etkinlik kontrol panelinde, süresi dolan sertifikayı içeren Anahtar Deposu'nu gösteren bir satır seçin. Anahtar Deposu sayfasından yeni bir sertifika yükleyebilir ve süresi dolmak üzere olan sertifikayı silebilirsiniz.

Trafik uyarılarıyla uyarı API'lerini kullanma

Trafik uyarılarını oluşturmak ve yönetmek için kullandığınız API'lerin çoğu, diğer uyarı türleriyle kullandığınız API'lerle aynıdı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.

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

Trafik uyarısı oluşturmak veya güncellemek için diğer uyarı türlerinde şu anda kullandığınız API'lerin aynısını kullanın. Trafik uyarısı oluşturmak veya güncellemek için kullanılan API çağrısı gövdesi, aşağıdaki değişiklikler dışında diğer uyarılar için kullanılanlarla aynıdır:

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

    "alertType": "runtime"
    "alertSubType": "trafficfixed"

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

    "alertType": "runtime"
    "alertSubType": "fixed"
  • conditions dizisinin dimensions öğesinde:
    • org, env, proxy ve region özelliklerinin değerlerini ayarlamanız gerekir. Yalnızca bu özellikler desteklenir. proxy ve region öğelerini ALL olarak ayarlayabilirsiniz.
    • traffic özelliğinin değerini total olarak ayarlamanız gerekir.
  • conditions dizisinde:

    • metrics özelliği trafficChange değerine sahip olmalıdır.
    • comparator özelliği, increasedBy veya decreasedBy olarak ayarlanmalıdır.
    • threshold özelliği, trafikteki yüzdelik artışı veya düşüşü belirten pozitif bir değer içerir. Buradaki 1.0 değeri %100'e karşılık gelir. increasedBy için değer, 0,0'dan (%0) büyük veya 0,0'a eşit olmalıdır. decreasedBy için değer, 0,0'dan (%0) büyük veya bu değere eşit ya da 1,0'dan (%100) küçük veya 0,0'a eşit olmalıdır.
    • durationSeconds özelliği şu değerlerden birine ayarlanmalıdır: 3600 (1 saat), 86400 (1 gün), 604800 (7 gün), 1296000 (15 gün), 2592000 (30 gün) .
  • reportEnabled özelliği, trafik uyarıları için desteklenmez.
Aşağıdaki örnekte, bir kuruluş ve ortam için trafik bir saatlik süre içinde% 50 arttığında tetiklenen bir uyarının nasıl ayarlanacağı gösterilmektedir. Uyarı tetiklendiğinde, belirtilen PagerDuty koduna 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":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

$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 konusuna bakın.

Bu API'yi kullanma hakkında daha fazla bilgi için Etkinlikleri görüntüleme bölümüne bakın.

Trafik uyarıları alın

Varsayılan olarak Get Alerts API, tanımlanan 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. runtime, varsayılan ve cert değerlerine izin verilir.
  • 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.

Ö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 hem etkin hem de devre dışı olan trafik uyarılarını döndürür:

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

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