Uyarıları ve bildirimleri ayarlama

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

Uyarı koşulları, belirli durum kodunu (ör. 404/502/2xx/4xx/5xx), gecikmeyi ve hata kodu eşiklerini tanımlar. Bu eşikler aşıldığında kullanıcı arayüzünde görsel uyarılar tetiklenir ve e-posta, Slack, PagerDuty veya webhook'lar gibi çeşitli kanallar üzerinden bildirimler gönderilir. Uyarıları ortam, API proxy'si veya hedef hizmet ya da bölge düzeyinde ayarlayabilirsiniz. Bir uyarı tetiklendiğinde, uyarı ve bildirim eklerken tanımladığınız yöntemle bildirim alırsınız.

Örneğin, üretim ortamınıza dağıtılan orders-prod API proxy'sinde 5xx hata oranı 5 dakika boyunca% 23'ü aştığında bir uyarı tetiklemek ve operasyon ekibine bildirim göndermek isteyebilirsiniz.

Aşağıdaki şekilde, uyarıların kullanıcı arayüzünde nasıl göründüğü gösterilmektedir:

Aşağıda, bir uyarı tetiklendiğinde alabileceğiniz e-posta bildirimi örneği verilmiştir.

Uyarı bildiriminin gövdesinde daha fazla bilgi için aşağıdaki bağlantıları tıklayın:

• Son bir saat içinde her koşulla ilgili uyarı ayarları ve etkinlikler de dahil olmak üzere daha fazla ayrıntı görüntülemek için Ayrıntıları göster'i tıklayın.
• Uyarının tanımını görüntülemek için Uyarı tanımı'nı tıklayın.
• Belirli bir uyarı hakkında daha fazla bilgi görüntülemek için Uyarı geçmişi'ni tıklayın.
• Önerilen işlemler varsa bunları görmek için Playbook'u görüntüle'yi tıklayın.
• Uyarı koşuluyla ilgili özel bir raporu görüntülemek için View API Analytics Report'u (API Analytics Raporunu Görüntüle) tıklayın.

Aşağıdaki bölümlerde uyarıların ve bildirimlerin nasıl ayarlanacağı ve yönetileceği açıklanmaktadır.

Uyarı türleri hakkında

API İzleme'nin ilk sürümünde, önceden tanımlanmış bir koşul grubuna göre ne zaman uyarı verileceğini belirten, kalıba dayalı kurallar oluşturabiliyordunuz. Bu tür uyarılara sabit uyarılar denir ve API İzleme'nin ilk sürümünde desteklenen tek uyarı türüydü.

Örneğin, aşağıdaki durumlarda sabit bir uyarı oluşturabilirsiniz:

• [Hedefim mytarget1] için [10 dakika] boyunca [5xx hatalarının oranı] [%10]['dan büyük]
• [count of 2xx errors] [is less than] [50] for [5 minutes] in [region us-east-1]
• [p90 gecikmesi], [proxy myproxy1] üzerinde [10 dakika] boyunca [750 ms'den] [büyük]

19.11.13 tarihli Güvenlik Raporlama Beta sürümü yeni uyarı türleri ekler:

• Anormallik (Beta) uyarıları. Edge'in, trafik ve performans sorunlarını sizin önceden belirlemeniz gerekmeden tespit ettiği bir uyarı türüdür. Daha sonra bu anormallikler için uyarı oluşturabilirsiniz.
• TLS Geçerlilik Bitişi (Beta) uyarıları. TLS sertifikasının geçerlilik süresi dolmak üzereyken bildirim göndermenize olanak tanıyan bir uyarı türü.

API İzleme artık birden fazla uyarı türünü desteklediğinden Uyarı Oluştur iletişim kutusunda uyarı türünü seçme seçeneği gösterilmektedir:

Uyarı ayarlarını görüntüleme

Şu anda tanımlanmış olan uyarı ayarlarını görüntülemek için Edge kullanıcı arayüzünde Analiz > Uyarı Kuralları'nı tıklayın.

Uyarı sayfası, aşağıdaki şekilde gösterildiği gibi görüntülenir:

Şekilde vurgulandığı gibi, Uyarı sayfası şunları yapmanıza olanak tanır:

• Şu anda tanımlanmış olan uyarı ayarlarının özetini görüntüleme
• Tetiklenen uyarıların geçmişini görüntüleme
• Uyarı ve bildirim ekleme
• Uyarıdan özel rapor oluşturma
• Uyarıları etkinleştirme veya devre dışı bırakma
• Uyarıyı düzenleme
• Uyarı silme
• Uyarı listesinde belirli bir dizeyi arama

Kuruluşunuz için tetiklenen uyarıların geçmişini görüntüleme

Son 24 saat içinde kuruluşunuz için tetiklenen uyarıların geçmişini görüntülemek üzere Edge kullanıcı arayüzünde Analiz et > Uyarı Kuralları'nı ve Geçmiş sekmesini tıklayın.

Uyarı Geçmişi sayfası görüntülenir.

Uyarının ayrıntılarını İnceleme kontrol panelinde görüntülemek için uyarının adını tıklayın. Listenin tamamında veya bir kısmında uyarı adını arayarak listeyi filtreleyebilirsiniz.

Uyarı ve bildirim ekleme

Uyarı ve bildirim 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ı olacak bir ad kullanın. Ad 128 karakteri aşamaz.
   Uyarı Türü	Düzeltildi'yi seçin. Uyarı türleri hakkında daha fazla bilgi için Uyarı türleri hakkında başlıklı makaleyi inceleyin.
   Açıklama	Uyarının açıklaması.
   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 ilk koşul için metriği, eşiği ve boyutu tanımlayın.

   Koşul Alanı	Açıklama
   Metrik	Aşağıdaki metriklerden birini seçin: Durum Kodu: Listeden bir durum kodu seçin (ör. 401, 404, 2xx, 4xx veya 5xx HTTP). Not: API, daha geniş bir durum kodu aralığı ayarlamanıza olanak tanır. 200-299, 400-599 arasındaki herhangi bir durum kodunu ve 2xx, 4xx veya 5xx joker karakter değerlerini belirtmek için API'yi kullanın. Uyarı oluşturma başlıklı makaleyi inceleyin. Sıklık sınırlaması uyarıları (HTTP durum kodu 429) için metriği Spike Arrest hata kodu olarak ayarlayın. Proxy hatasından veya hedef hatasından gelen HTTP yanıt kodunu yeniden yazmak için AssignMessage politikasını kullanabilirsiniz. API İzleme, yeniden yazılan kodları yok sayar ve gerçek HTTP yanıt kodlarını günlüğe kaydeder. Gecikme: Açılır listeden bir gecikme değeri seçin. Özellikle: p50 (50. yüzdelik dilim), p90 (90. yüzdelik dilim), p95 (95. yüzdelik dilim) veya p99 (99. yüzdelik dilim). Örneğin, 95. yüzdelik dilim için yanıt gecikmesi, aşağıda belirlediğiniz eşikten büyük olduğunda tetiklenen bir uyarı ayarlamak üzere p95'i seçin. Hata kodu: Listeden bir kategori, alt kategori ve hata kodu seçin. İsterseniz bir kategori veya alt kategoride aşağıdakilerden birini seçin: Tümü: Bu kategori/alt kategorideki tüm hata kodlarının toplamı, metrik ölçütlerini karşılamalıdır. Herhangi biri: Bu kategori/alt kategorideki tek bir hata kodu, metrik ölçütlerini karşılamalıdır. Daha fazla bilgi için Hata kodu referansı başlıklı makaleyi inceleyin.
   Eşik	Seçili metrik için eşiği yapılandırın: Durum kodu: Eşiği zaman içinde yüzde oranı, sayı veya saniyede işlem sayısı (TPS) olarak ayarlayın. Gecikme: Eşiği, zaman içindeki toplam veya hedef gecikme süresi (ms) olarak seçin. Bu durumda, trafik varsa her dakika güncellenen belirtilen yüzdelik dilimdeki gözlemlenen gecikme, belirtilen süre aralığını kapsayan zaman aralığı için eşik koşulunu aşarsa uyarı tetiklenir. Yani eşik koşulu, tam süre boyunca toplanmaz. Hata kodu: Eşiği zaman içinde yüzde oranı, sayı veya saniyede işlem sayısı (TPS) olarak ayarlayın.
   Boyut	+Boyut Ekle'yi tıklayın ve API proxy'si, hedef hizmet veya geliştirici uygulaması ve bölge dahil olmak üzere sonuç döndürülecek boyut ayrıntılarını belirtin. Belirli bir boyutu şu şekilde ayarlarsanız: Tümü: Boyuttaki tüm varlıklar metrik ölçütlerini karşılamalıdır. Gecikme türündeki bir metrik için Tümü'nü seçemezsiniz. Herhangi bir: Yalnızca bölge için geçerlidir. Boyuttaki bir varlık, herhangi bir bölge için metrik ölçütlerini karşılamalıdır. Not: API proxy'leri veya hedef hizmetler için Herhangi bir işlevi destekleyecek bir Koleksiyon seçin. Koleksiyonlar: API proxy'leri veya hedef hizmetler kümesini belirtmek için listeden bir koleksiyon seçin. Bu durumda, koleksiyondaki tüm öğeler ölçütleri karşılamalıdır. Boyutu Hedef olarak ayarlarsanız bir hedef hizmet veya ServiceCallout politikası tarafından belirtilen hizmeti seçebilirsiniz. ServiceCallout politikası hedefi, `sc://` ile başlayan bir değer olarak gösterilir. Örneğin, `sc://my.endpoint.net`.

5. Son bir saat içindeki koşula ait son verileri göstermek için Koşul verilerini göster'i tıklayın.
   Grafikteki hata oranı, uyarı koşulu eşiğini aştığında kırmızı renkte gösterilir.
   

   Verileri gizlemek için Durum verilerini gizle'yi tıklayın.

6. Başka koşullar eklemek için + Koşul Ekle'yi tıklayın ve 4. ve 5. adımları tekrarlayın.

   Not: Birden fazla koşul belirtirseniz uyarı, tüm koşullar karşılandığında tetiklenir.

7. Yapılandırdığınız uyarı koşullarına göre özel bir rapor oluşturmak istiyorsanız Uyarı koşullarına göre API analiz raporları oluşturun'u tıklayın. Kuruluş yöneticisi değilseniz bu seçenek devre dışı görünür.

   Daha fazla bilgi için Uyarıdan özel rapor oluşturma başlıklı makaleyi inceleyin.

   Not: Uyarıyı kaydettikten sonra özel raporu Özel raporları yönetme bölümünde açıklandığı şekilde değiştirebilirsiniz.

8. 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	Seçilen kanal türüne göre hedefi 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. URL'ye gönderilen nesnenin açıklaması için Webhook nesne biçimi başlıklı makaleyi inceleyin. Webhook'un URL'sinde herhangi bir kimlik bilgisi iletmeyin. Örneğin: https://apigee.com/test-webhook?auth_token=1234_abcd. Webhook nesnesini ayrıştırarak değiştirebilen veya işleyebilen bir uç noktanın URL'sini belirtebilirsiniz. Örneğin, bir API'nin (ör. Edge API) veya nesneyi işleyebilen başka bir uç noktanın URL'sini belirtebilirsiniz. Not: Bildirim başına yalnızca bir hedef belirtebilirsiniz. Aynı kanal türü için birden fazla hedef belirtmek istiyorsanız ek bildirimler ekleyin.

9. Başka bildirimler eklemek için 8. adımı tekrarlayın.
10. 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 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 eklenir. Bu alandaki içerikler 1.500 karakteri aşamaz.
    Klape	Bildirimlerin gönderilme sıklığı. Açılır listeden bir değer seçin. Geçerli değerler şunlardır: 15 dakika, 30 dakika ve 1 saat.

11. Kaydet'i tıklayın.

Webhook nesne biçimi

{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

thresholdViolations ve thresholdViolationsFormatted özellikleri, uyarıyla ilgili ayrıntıları içerir. thresholdViolations özelliği, ayrıntıları içeren tek bir dizeyi, thresholdViolationsFormatted ise uyarıyı açıklayan bir nesneyi içerir. Genellikle thresholdViolationsFormatted özelliğini kullanırsınız çünkü kod çözme işlemi daha basittir.

Yukarıdaki örnekte, uyarı metriğini statusCode özelliğiyle belirtildiği gibi HTTP 2xx durum koduna göre tetiklenecek şekilde yapılandırdığınızda bu özelliklerin içerikleri sabit bir uyarı için gösterilmektedir.

Bu özelliklerin içeriği, uyarı türüne (ör. sabit veya anomali) ve uyarının belirli yapılandırmasına bağlıdır. Örneğin, bir hata koduna dayalı sabit bir uyarı oluşturursanız thresholdViolationsFormatted özelliği, statusCode özelliği yerine faultCode özelliği içerir.

Aşağıdaki tabloda, farklı uyarı türleri için thresholdViolationsFormatted özelliğinin olası tüm özellikleri gösterilmektedir:

metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation

metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation

metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation

envName, certificateName, thresholdValue, violation

Uyarıdan özel rapor oluşturma

Uyarılardan özel rapor oluşturmak için:

1. Uyarı oluştururken Uyarı ve bildirim ekleme bölümünde açıklandığı gibi Uyarı koşullarına göre API Analytics raporları oluşturun'u tıklayın.

   Uyarıyı kaydettikten sonra kullanıcı arayüzünde şu mesaj gösterilir:

   Alert alertName saved successfully. To customize the report generated, click here.

   İlgili alanlar önceden doldurulmuş olarak raporu yeni bir sekmede açmak için mesajı tıklayın. Özel rapor varsayılan olarak şu şekilde adlandırılır: API Monitoring Generated alertName

2. Özel raporu istediğiniz gibi düzenleyin ve Kaydet'i tıklayın.
3. Listedeki raporun adını tıklayın ve özel raporu çalıştırın.

Uyarı koşullarına göre oluşturulan özel raporu yönetmek için:

1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
2. Ayarlar sekmesini tıklayın.
3. Raporlar sütununda, yönetmek istediğiniz uyarıyla ilişkili özel raporu tıklayın.

   Özel rapor sayfası yeni bir sekmede gösterilir. Raporlar sütunu boşsa henüz özel rapor oluşturulmamıştır. İsterseniz uyarıyı düzenleyerek özel bir rapor ekleyebilirsiniz.

4. Özel raporu istediğiniz gibi düzenleyin ve Kaydet'i tıklayın.
5. Listedeki raporun adını tıklayın ve özel raporu çalıştırın.

Uyarıları etkinleştirme veya devre dışı bırakma

Bir uyarıyı etkinleştirmek veya devre dışı bırakmak için:

1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
2. Etkinleştirmek veya devre dışı bırakmak istediğiniz uyarıyla ilişkili Durum sütunundaki açma/kapatma düğmesini tıklayın.
   

Alert düzenleme

Bir uyarıyı düzenlemek için:

1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
2. Düzenlemek istediğiniz uyarının adını tıklayın.
3. Uyarıyı gerektiği gibi düzenleyin.
4. Kaydet'i tıklayın.

Alert'leri silme

Bir uyarıyı silmek için:

1. Edge kullanıcı arayüzünde Analyze > Alert Rules'u (Analiz > Uyarı Kuralları) tıklayın.
2. İmleci silmek istediğiniz uyarının üzerine getirin ve işlemler menüsünde simgesini tıklayın.

Önerilen uyarılar

Apigee, yaygın sorunlar hakkında bildirim almak için aşağıdaki uyarıları ayarlamanızı önerir. Bu uyarılardan bazıları API'lerinizin uygulanmasına özeldir ve yalnızca belirli durumlarda faydalıdır. Örneğin, aşağıda gösterilen çeşitli uyarılar yalnızca ServiceCallout politikası veya JavaCallout politikası kullanıyorsanız geçerlidir.

Bir API proxy'si için 5xx durum kodu uyarısı ayarlama

Aşağıda, oteller API proxy'si için 5xx durum kodlarının saniyedeki işlem sayısı (TPS) herhangi bir bölgede 10 dakika boyunca 100'ü aştığında tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleyi inceleyin.

API'yi kullanma hakkında bilgi için API'yi kullanarak bir proxy için 5xx durum kodu uyarısı ayarlama başlıklı makaleyi inceleyin.

Bir API proxy'si için P95 gecikme uyarısı ayarlama

Aşağıda, herhangi bir bölgedeki oteller API proxy'si için 95. yüzdelik dilimdeki toplam yanıt gecikmesi 5 dakika boyunca 100 ms'den fazla olduğunda tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleyi inceleyin.

API'yi kullanma hakkında bilgi için API kullanarak bir API proxy'si için P95 gecikme uyarısı ayarlama başlıklı makaleyi inceleyin.

Tüm API proxy'leri için 404 (Uygulama Bulunamadı) uyarısı ayarlama

Aşağıda, tüm API proxy'leri için 404 durum kodlarının yüzdesi herhangi bir bölgede 5 dakika boyunca% 5'i aştığında tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleyi inceleyin.

API'yi kullanma hakkında bilgi için API'yi kullanarak tüm API proxy'leri için 404 (Uygulama Bulunamadı) uyarısı ayarlama başlıklı makaleyi inceleyin.

API'ler için API proxy'si sayısı uyarısı ayarlama

Aşağıda, kullanıcı arayüzünü kullanarak bir uyarı ayarlama örneği verilmiştir. Bu uyarı, herhangi bir bölgede API'ler için 5xx kod sayısı 5 dakika boyunca 200'ü aştığında tetiklenir. Bu örnekte, API'ler Critical API Proxies (Kritik API Proxy'leri) koleksiyonunda yakalanır. Daha fazla bilgi için aşağıdaki sayfaları inceleyin:

• Uyarı ve bildirim ekleme
• Koleksiyonları yönetme

API'yi kullanma hakkında bilgi için API'yi kullanan API'ler için API proxy sayısı uyarısı ayarlama başlıklı makaleyi inceleyin.

Hedef hizmetler için hata oranı uyarısı ayarlama

Aşağıda, hedef hizmetler için 500 kod oranı herhangi bir bölgede 1 saat boyunca% 10'ı aştığında tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Bu örnekte, hedef hizmetler Kritik hedefler koleksiyonunda yakalanır. Daha fazla bilgi için aşağıdaki sayfaları inceleyin:

• Uyarı ve bildirim ekleme
• Koleksiyonları yönetme

API'yi kullanma hakkında bilgi edinmek için API'yi kullanarak hedef hizmetler için hata oranı uyarısı ayarlama başlıklı makaleyi inceleyin.

ServiceCallout politikası için hata oranı uyarısı ayarlama

Aşağıda, ServiceCallout politikası ile belirtilen hizmetin 500 kod oranı herhangi bir bölgede 1 saat boyunca% 10'u aştığında tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Daha fazla bilgi için aşağıdaki sayfaları inceleyin:

• Uyarı ve bildirim ekleme

API'yi kullanma hakkında bilgi için API'yi kullanarak hizmet çağrısı politikası için hata oranı uyarısı ayarlama başlıklı makaleyi inceleyin.

Politika hata kodu uyarısı ayarlama

Aşağıda, JWT AlgorithmMismatch hata kodu sayısı 10 dakika boyunca tüm API'ler için 5'ten büyük olduğunda tetiklenen bir uyarıyı kullanıcı arayüzünü kullanarak ayarlama örneği verilmiştir. Daha fazla bilgi için aşağıdaki sayfaları inceleyin:

• Uyarı ve bildirim ekleme
• Koleksiyonları yönetme

API'yi kullanma hakkında bilgi için API'yi kullanarak politika hata kodu için hata kodu uyarısı ayarlama başlıklı makaleyi inceleyin.