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), gecikme ve hata kodu eşiklerini tanımlar. Bu eşikler aşıldığında kullanıcı arayüzünde görsel uyarıları tetikler ve e-posta, slack, pagerduty veya webhook'lar gibi çeşitli kanallar üzerinden bildirim gönderir. 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öntemi kullanarak bildirim alırsınız.

Örneğin, üretim ortamınıza dağıtılan siparişler üretim API'si proxy'sine ait 5xx hata oranı% 23'ü aştığında, bir uyarı tetikleyip Operasyon ekibine bildirim göndermek isteyebilirsiniz.

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

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

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

• Uyarı ayarları ve her koşulla ilgili son bir saat içindeki etkinlik de dahil olmak üzere daha fazla ayrıntı görmek için ayrıntıları görüntüleyin.
• Uyarının tanımını görüntülemek için Uyarı tanımı.
• Belirli bir uyarıyla ilgili daha fazla bilgi görüntülemek için Uyarı geçmişi'ni seçin.
• Sağlanmışsa, önerilen işlemleri görüntülemek için başucu kitabını görüntüleyin.
• Uyarı koşulu için özel bir rapor görüntülemek üzere API Analytics Raporunu Görüntüleyin.

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 Monitoring'in ilk sürümü, önceden tanımlanmış bir dizi koşula göre uyarının ne zaman verileceğini belirten kalıp tabanlı kurallar oluşturmanıza olanak tanır. Bu tür uyarılar sabit uyarılar olarak adlandırılır ve API Monitoring'in ilk sürümünde desteklenen tek uyarı türüdür.

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

• [5xx hata oranı] [şundan büyüktür:] [%10] ([10 dakika] için süre: [hedefim1]
• [2xx hatasının sayısı] [bölge us-east-1 bölgesinde [5 dakika] süreyle [şundan küçük] [50]
• [p90 gecikmesi] [proxy myproxy1] üzerinde [10 dakika] için [şundan büyük] [750ms]

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

• Toplam trafik (Beta) uyarıları. Belirli bir zaman aralığında trafik belirli bir yüzde oranında değiştiğinde uyarı vermenizi sağlayan bir uyarı türü.
• Anormallik (Beta) uyarıları. Edge'in trafik ve performans sorunlarını sizin belirlemeniz yerine sizin tespit ettiği bir uyarı türü. Ardından bu anormallikler için uyarı oluşturabilirsiniz.
• TLS Kullanım Süresi (Beta) uyarıları. TLS sertifikasının geçerlilik süresi dolmak üzere olduğunda bildirim göndermenizi sağlayan bir uyarı türü.

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

Uyarı ayarlarını göster

Tanımlanmış durumdaki 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ında şunları yapabilirsiniz:

• Şu anda tanımlanmış olan uyarı ayarlarının özetini görüntüleme
• Tetiklenen uyarı 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ı düzenleme
• Uyarı silme
• Belirli bir dize için uyarı listesinde arama yapma

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

Kuruluşunuz için son 24 saat içinde tetiklenen uyarıların geçmişini görüntülemek amacıyla Edge kullanıcı arayüzünde Analiz > Uyarı Kuralları'nı ve ardından Geçmiş sekmesini tıklayın.

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

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

Uyarı ve bildirim ekleme

Uyarı ve bildirim 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.
   Uyarı Türü	Sabit'i 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 kullanı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 401, 404, 2xx, 4xx veya 5xx HTTP gibi bir durum kodu seçin. Not: API, daha geniş bir durum kodu aralığı belirlemenize olanak tanır. 200-299, 400-599 arasında herhangi bir durum kodu ve 2xx, 4xx veya 5xx joker karakter değerlerini belirtmek için API'yi kullanın. Uyarı Oluşturma başlıklı makaleyi inceleyin. Hız sınırlama uyarıları (HTTP durum kodu 429) için metriği Spike Arrest hata kodu olarak ayarlayın. Bir proxy hatası veya hedef hatası üzerinden HTTP yanıt kodunu yeniden yazmak için assignMessage politikasını kullanabilirsiniz. API Monitoring, yeniden yazılmış kodları yoksayar 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 ayarladığınız eşikten yüksek olduğunda tetiklenen bir uyarı ayarlamak için p95'i seçin. Hata Kodu: Listeden bir kategori, alt kategori ve hata kodu seçin. Kategori veya alt kategori içinde aşağıdakilerden birini de seçebilirsiniz: Tümü - Bu kategorideki/alt kategorideki tüm hata kodlarındaki toplam değer, metrik ölçütlerini karşılamalıdır. Herhangi biri - Bu kategori/alt kategorideki tek hata kodu, metrik ölçütlerini karşılamalıdır. Daha fazla bilgi için Hata kodu referansı bölümüne bakın. Toplam trafik (Beta): Trafik artışını veya azalmasını seçin. Daha fazla bilgi için Trafik (Beta) uyarıları konusuna bakın.
   Eşik	Seçili metrik için eşiği yapılandırın: Durum Kodu: Eşiği, zaman içindeki yüzde oranı, sayı veya saniyedeki 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, gözlemlenen belirtilen yüzdelik dilim, trafik olması halinde her dakika güncellenen ve belirtilen zaman süresini kapsayan zaman aralığının eşik koşulunu aşarsa bir uyarı tetiklenir. Yani eşik koşulu tam zamanlı süre boyunca toplanmaz. Hata Kodu: Eşiği, zaman içindeki yüzde oranı, sayı veya saniyedeki 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çların döndürüleceği boyut ayrıntılarını belirtin. Belirli bir boyutu: Tümü: Boyuttaki tüm öğeler, metrik ölçütlerini karşılamalıdır. Gecikme türündeki bir metrik için Tümü seçeneğini belirleyemezsiniz. Herhangi biri: Yalnızca bölge için geçerlidir. Boyuttaki varlık, herhangi bir tek bölge için metrik ölçütlerini karşılamalıdır. Not: API proxy'leri veya hedef hizmetler söz konusu olduğunda herhangi bir işlevi destekleyecek bir Koleksiyon seçin. Koleksiyonlar: API proxy'leri veya hedef hizmetler grubunu belirtmek için listeden bir koleksiyon seçin. Bu durumda, koleksiyondaki tüm varlıkların ölçütleri karşılaması gerekir. Boyutu Hedef olarak ayarlarsanız bir hedef hizmeti veya bir ServiceDescription politikası tarafından belirtilen hizmeti seçebilirsiniz. Bir ServiceDescription politikasının hedefi, başında "sc://" bulunan bir değer olarak gösterilir. Örneğin, "sc://my.endpoint.net".

5. Koşulla ilgili son bir saat içindeki son verileri görmek 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örüntülenir.
   

   Verileri gizlemek için Koşul verilerini gizle'yi tıklayın.

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

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

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

   Daha fazla bilgi için Uyarıdan özel rapor oluşturma başlıklı makaleye bakın.

   Not: Uyarıyı kaydettikten sonra özel raporu, Özel raporları yönetme bölümünde açıklandığı gibi 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: 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). URL'ye gönderilen nesnenin açıklaması için Webhook nesne biçimi konusuna bakın. Webhook'un URL'sinde kimlik bilgisi bilgilerini iletin. Örneğin: https://apigee.com/test-webhook?auth_token=1234_abcd. Webhook nesnesini değiştirmek veya işlemek için webhook nesnesini ayrıştırabilecek uç noktanın URL'sini belirtebilirsiniz. Örneğin, Edge API gibi bir API'nin 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 üzere ek bildirimler ekleyin.

9. Ek 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ı) Tetiklenen uyarılar için önerilen işlemlerin kısa bir açıklamasını sağlayan serbest biçimli metin alanı. Ayrıca, 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. Geçerli değerler şunları içerir: 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 dize içerirken thresholdViolationsFormatted, uyarıyı açıklayan bir nesne içerir. Genellikle kodu daha kolay çözüldüğü için thresholdViolationsFormatted özelliğini kullanırsınız.

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

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

Aşağıdaki tabloda, farklı uyarı türleri için thresholdViolationsFormatted özelliğinin tüm olası ö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

Bir uyarıdan özel rapor oluşturmak için:

1. Uyarı oluştururken, Uyarı ve bildirim ekleme başlıklı makalede açıklandığı şekilde Uyarı koşullarına dayalı bir API analiz raporu oluşturun'u tıklayın.

   Uyarı kaydedildikten sonra kullanıcı arayüzünde aşağıdaki mesaj görüntülenir:

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

   Raporu, ilgili alanların önceden doldurulduğu yeni bir sekmede açmak için mesajı tıklayın. Varsayılan olarak özel raporun adı şudur: API Monitoring Generated alertName

2. Özel raporu istediğiniz gibi düzenleyin ve Kaydet'i tıklayın.
3. Listede 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 Analiz > Uyarı Kuralları'nı 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örüntülenir. Raporlar sütunu boşsa henüz özel rapor oluşturulmamıştır. İsterseniz özel bir rapor eklemek için uyarıyı düzenleyebilirsiniz.

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

Bir uyarıyı 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 Analiz > Uyarı Kuralları'nı tıklayın.
2. Durum sütununda, etkinleştirmek veya devre dışı bırakmak istediğiniz uyarıyla ilişkili 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 Analiz > Uyarı Kuralları'nı tıklayın.
2. Düzenlemek istediğiniz uyarının adını tıklayın.
3. Uyarıyı gerektiği şekilde düzenleyin.
4. Kaydet'i tıklayın.

Alert'leri silme

Bir uyarıyı silmek için:

1. Edge kullanıcı arayüzünde Analiz > Uyarı Kuralları'nı 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 sorunlarla ilgili 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 yararlıdır. Örneğin, aşağıda gösterilen bazı uyarılar yalnızca ServiceDestination politikasını veya JavaDescription Politikası'nı kullanıyorsanız geçerlidir.

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

Aşağıda, otel API proxy'si için 5xx durum kodlarından oluşan saniyedeki işlem sayısı (TPS), herhangi bir bölgede 10 dakika için 100 değerini aştığında tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı oluşturulacağına dair bir örnek verilmiştir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleye bakın.

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

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

Aşağıda, herhangi bir bölge için oteller API proxy'si için 95. yüzdelik dilim için toplam yanıt gecikmesi 5 dakika için 100 ms'den fazla olduğunda tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı ayarlanacağına dair bir örnek verilmektedir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleye bakın.

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

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

Aşağıda, tüm API proxy'leri için 404 durum kodu yüzdesi herhangi bir bölgede 5 dakika için% 5'i aştığında tetiklenen kullanıcı arayüzünü kullanarak nasıl uyarı oluşturacağınıza dair bir örnek verilmiştir. Daha fazla bilgi için Uyarı ve bildirim ekleme başlıklı makaleye bakın.

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

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

Aşağıda, API'lerdeki 5xx kod sayısı herhangi bir bölgede 5 dakika için 200'ü aştığında tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı oluşturulacağına dair bir örnek verilmektedir. Bu örnekte API'ler, Kritik API Proxy'leri koleksiyonunda yakalanmıştı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ı oluşturma başlıklı makaleye bakın.

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

Aşağıda, hedef hizmetler için 500 kod hızı herhangi bir bölgede 1 saat için% 10'u aştığında tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı oluşturulacağına dair bir örnek verilmektedir. Bu örnekte, hedef hizmetler Kritik hedefler koleksiyonunda yakalanmaktadı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 kullanarak hedef hizmetler için hata oranı uyarısı ayarlama başlıklı makaleye bakın.

Service Console politikası için hata oranı uyarısı ayarlama

Aşağıda, Service callout politikası tarafından belirtilen hizmet için 500 kod hızı herhangi bir bölgede 1 saat için% 10'u aştığında tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı oluşturulacağına dair bir örnek verilmektedir. 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ı oluşturma bölümüne bakın.

Politika hata kodu uyarısı ayarlayın

Aşağıda, VerifyJWT politikasındaki JWT AlgorithmMismatch hata kodu sayısı tüm API'lerde 10 dakika için 5'ten fazla olduğunda tetiklenen kullanıcı arayüzü kullanılarak nasıl uyarı ayarlanacağına dair bir örnek verilmektedir. 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ı makaleye bakın.