Trafik uyarılarını ayarlama

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

Bir ortam, proxy veya bölgenin trafiği belirli bir zaman aralığında belirtilen yüzde kadar değiştiğinde bildirim göndermek için 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ığındaki trafikle karşılaştırarak çalışır. Örneğin, bir saatlik zaman aralığı belirtirsiniz. Ardından uyarı, trafik yüzdesindeki değişimi hesaplamak için en son saatteki trafiği önceki saatteki trafikle karşılaştırır:

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

Pozitif değer, trafikte artış olduğu, negatif değer ise trafikte düşüş olduğu anlamına gelir.

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

Bu yüzdeyi ayarlamadan önce normal trafik kalıplarınızla uyumlu olduğundan emin olun. Örneğin, API trafiğiniz normalde gün içinde saatlik trafik artışlarıyla %100'e kadar dalgalanıyorsa bu artışlar normaldir ve uyarı tetiklememelidir. Ancak daha sonra saatlik trafikteki% 50'lik artış için tetiklenecek 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ı ve bildirimleri ayarlama başlıklı makaleyi inceleyin.

Trafik uyarıları ve bildirimleri ekleme

Trafik uyarıları ve bildirimleri eklemek için:
  1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
  2. +Uyarı'yı tıklayın.
  3. Uyarı hakkında aşağıdaki genel bilgileri girin:
    Alan Açıklama
    Uyarı adı Uyarının adı. Tetikleyiciyi açıklayan ve sizin için anlamlı olan 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 başlıklı makaleyi 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 tıklayın.
  4. Uyarıyı tetikleyecek koşulun eşiğini ve boyutunu tanımlayın.
    Koşul Alanı Açıklama
    Eşik

    Trafiğin önceki bir zaman aralığına kıyasla belirli bir yüzde arttığında veya azaldığında uyarı verilmesini sağlayabilirsiniz.

    Artış yüzdesini %0'a eşit veya ondan büyük bir değere ayarlayın. Azaltılan yüzdeyi %0'a eşit veya ondan büyük ve %100'e eşit veya ondan küçük bir değere ayarlayın.

    Aşağıdaki zaman aralıklarından birini seçebilirsiniz:

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

    +Boyut Ekle'yi tıklayın ve API proxy'si ile bölge de dahil olmak üzere sonuç döndürülecek boyut ayrıntılarını belirtin.

    Belirli bir boyutu şu şekilde ayarlayın:

    • Proxy: Belirli bir proxy'ye veya Tüm proxy'lere ayarlanır. Proxy, "Any" değerini desteklemiyor. 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" 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: E-posta, Slack, PagerDuty veya Webhook.
    Hedef Hedefi, seçilen kanal türüne göre belirtin:
    • E-posta: joe@company.com gibi bir e-posta adresi
    • Slack: https://hooks.slack.com/services/T00000000/B00000000/XXXXX gibi bir Slack kanalı URL'si
    • PagerDuty: abcd1234efgh56789 gibi PagerDuty kodu
    • Webhook: https://apigee.com/test-webhook gibi bir webhook URL'si

      Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Aynı kanal türü için birden fazla hedef belirtmek istiyorsanız 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ı) Uyarılar tetiklendiğinde çözüme yönelik önerilen işlemlerin kısa bir açıklamasını sağlamak için kullanılan serbest biçimli metin alanı. En iyi uygulamalara referans verdiğiniz dahili wiki'nizin veya topluluk sayfanızın bağlantısını da belirtebilirsiniz. Bu alandaki bilgiler bildirime dahil edilir. Bu alandaki içerikler 1.500 karakteri aşamaz.
    Klape Bildirimlerin gönderilme 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 Edge kullanıcı arayüzündeki Events (Etkinlikler) kontrol paneline otomatik olarak kaydeder. Etkinlikler kontrol panelinde gösterilen etkinlik listesi, hem düzeltilmiş hem de sertifika olmak üzere 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 gösterge tablosu görünür:

  2. Etkinlikler kontrol panelini şunlara göre filtreleyin:

    • Ortam
    • Bölge
    • Dönem
  3. Uyarıyı daha ayrıntılı incelemek için, süresi dolan sertifikayı içeren anahtar deposunu göstermek üzere Etkinlik kontrol panelinde bir satır seçin. Anahtar deposu sayfasından yeni bir sertifika yükleyebilir ve süresi dolan sertifikayı silebilirsiniz.

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

Trafik uyarıları 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'lerde anomali uyarılarını desteklemek için kullanılan ek özellikler vardır. Örneğin:

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

Diğer uyarı türleri için yaptığınız gibi trafik uyarısı oluşturmak veya güncellemek için aynı API'leri kullanın. Bir trafik uyarısı oluşturmak veya güncellemek için yapılan API çağrısının gövdesi, diğer uyarılar için kullanılanla aynıdır. Ancak aşağıdaki değişiklikler yapılmıştır:

  • Uyarının 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 değerlerini 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üzde artışını veya düşüşünü belirten pozitif bir değer içerir. 1.0 değeri %100'e karşılık gelir. increasedBy için değer 0,0'a (0%) eşit veya bundan büyük olmalıdır. decreasedBy için değer 0,0'dan (0%) büyük veya 0,0'a eşit ve 1,0'dan (100%) küçük veya 1,0'a eşit olmalıdır.
    • durationSeconds özelliği aşağıdaki 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 trafiği 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 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 değerini, OAuth 2.0 erişim jetonu edinme bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuz olarak ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'ü kullanma başlıklı makaleyi inceleyin.

Bu API'nin kullanımı hakkında daha fazla bilgi için Etkinlikleri görüntüleme başlıklı makaleyi inceleyin.

Trafik uyarıları alma

Get Alerts API, varsayılan olarak tanımlanan tüm uyarılarla ilgili bilgileri döndürür. Bu API artık sonuçları filtrelemenize olanak tanıyan sorgu parametrelerini kabul ediyor:

  • enabled: true yalnızca etkinleştirilmiş uyarıların döndürülmesini belirtiyorsa. Varsayılan değer false'dır.
  • alertType - Döndürülecek uyarı türünü belirtir. İzin verilen değerler runtime (varsayılan) ve cert'dir.
  • alertSubType: Döndürülecek uyarı alt türünü belirtir. Varsayılan değer ayarlanmamıştır. Bu, tüm uyarı alt türlerinin döndürüleceği anlamına gelir.

Örneğin, yalnızca myorg adlı kuruluş için etkinleştirilen uyarıları döndürmek üzere 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ışı 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'

OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi $ACCESS_TOKEN değerini OAuth 2.0 erişim jetonunuz olarak ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'ü kullanma başlıklı makaleyi inceleyin.