Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Bildirmek için bir trafik uyarısı kullanın Bir ortam, proxy veya bölgenin trafiği belirtilen bir yüzde oranında değiştiğinde bir bildirim zaman aralığına göre değişiyor.
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ığının trafiğini önceki zaman aralığının trafiğiyle karşılaştırarak çalışır. Örneğin, bir saatlik bir zaman aralığı belirtirsiniz. Ardından, uyarı en son saatteki trafiği karşılaştırır. trafikteki yüzde değişimini hesaplamak için:
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ı tetikleyen eşiği, API trafiğinde yüzdelik artış veya düşüş olarak ayarlarsınız belirtilen süre boyunca geçerli olur.
Bu yüzdeyi ayarlamadan önce normal değerlerinizle uyumlu olduğundan emin olun. yardımcı olabilir. Örneğin, API trafiğiniz normalde %100'e varan saatlik trafik artışlarıyla gün içinde dalgalanıyorsa bu artışlar normaldir ve bir uyarı tetiklemez. Ancak, bir uyarıyı saatlik trafikte% 50'lik herhangi bir artışı tetikleyecek şekilde yapılandırırsını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ı makaleye göz atın.
Trafik uyarıları ve bildirimler ekleme
Trafik uyarıları ve bildirimler eklemek için:- Analiz et > Uyarı Kuralları'nı tıklayın.
- +Uyarı'yı tıklayın.
- 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. Görüntüleyin Uyarı türleri hakkında daha fazla bilgi edinin. 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. - Uyarıyı tetikleyecek koşul için eşik ve boyutu tanımlayın.
Koşul Alanı Açıklama Eşik Trafik arttığında veya önceki bir zaman aralığına kıyasla belirli bir yüzde azaltılmış olmalıdır.
Artan yüzdesini %0'a eşit veya daha büyük bir değere ayarlayın. Yüzde azalan oranını %0'a eşit veya daha büyük bir değere ayarlayın. ve %100'den küçük veya %100'e eşittir.
Şu şekilde bir zaman aralığı seçebilirsiniz:
- 1 saat
- 1 gün
- 1 hafta
Boyut +Boyut Ekle'yi tıklayın ve aşağıdakiler dahil olmak üzere sonuçların döndürüleceği boyut ayrıntılarını belirtin. API proxy'si ve bölge.
Belirli bir boyutu şu değere ayarlayın:
- Proxy: Belirli bir proxy'ye veya Tüm proxy'lere ayarlayın. Proxy, "Herhangi biri" değerini desteklemez. Bunun yerine İlgilendiğ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 desteklemiyor. Bunun yerine İlgilendiğiniz her bölge için ayrı bir uyarı ekleyebilirsiniz.
- 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 - E-posta adresi (ör.
joe@company.com
) - Slack - Slack kanal URL'si (ör.
https://hooks.slack.com/services/T00000000/B00000000/XXXXX
) - PagerDuty - PagerDuty kodu, örneğin
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.
- E-posta - E-posta adresi (ör.
- Başka bildirimler eklemek için önceki adımı tekrarlayın.
- Bir bildirim eklediyseniz aşağıdaki alanları ayarlayın:
Alan Açıklama Başucu Kitabı (İsteğe bağlı) Önerilen işlemlerin kısa bir açıklamasını sağlayan serbest biçimli metin alanı uyarıları çözümleyebilirsiniz. Ayrıca, dahili wiki'nize veya en iyi uygulamalara başvurduğunuz topluluk sayfası. Bu alandaki bilgiler, dahil edilir. Bu alandaki içerikler 1.500 karakterden uzun olamaz. Klape Bildirim gönderme sıklığı. Açılır listeden bir değer seçin. - 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 paneli. Etkinlikler kontrol panelinde gösterilen etkinliklerin listesi hem sabit hem de sertifikalı tüm uyarıları içerir.
Bir uyarıyı görüntülemek için:
Analiz et > Etkinlikler'i tıklayın. Yeni Etkinlikler kontrol paneli görünür:
Etkinlikler kontrol panelini şu ölçütlere göre filtreleyin:
- Ortam
- Bölge
- Dönem
- Etkinlik kontrol panelinde, süresi dolacak olan sertifikayı içeren Anahtar Deposu'nu göstermek için bir satır seçin. uyarıyı daha ayrıntılı olarak inceleyin. Anahtar Deposu sayfasından yeni bir sertifika yükleyebilir ve sertifikanın süresi doluyor.
Uyarı API'lerini trafik uyarılarıyla kullanma
Trafik uyarılarını oluşturmak ve yönetmek için kullandığınız çoğu API, kullandıklarınızla aynıdır. diğer uyarı türleriyle:
- Uyarı alın: Düzeltilen veya anormallik uyarısının tanımını alın.
- Uyarı geçmişini alın: Uyarı geçmişi metriklerini alın.
- Uyarı silme: Düzeltilmiş veya anormallik uyarı tanımını silin.
- Uyarı örneği al: Tetiklenen bir uyarı hakkında bilgi alın.
- Uyarı sayısını alın: Toplam uyarı sayısını öğrenin.
Ancak bazı API'ler, anormallik uyarılarını desteklemek için kullanılan ek özelliklere sahiptir. Örneğin:
- Uyarıları al: Düzeltilen uyarılar ve anormallik uyarıları dahil olmak üzere tüm uyarıları listeleyin.
- Uyarı oluştur: Düzeltilmiş veya anormallik uyarısı oluşturun.
- Uyarı güncelleme: Düzeltilmiş veya anormallik uyarı tanımını güncelleyebilirsiniz.
Trafik uyarısı oluşturma veya güncelleme
Oluşturmak için aynı API'leri kullanın. veya güncelleyin diğer uyarı türleri için yaptığınız gibi bir trafik uyarısı görebilirsiniz. Trafik uyarısı oluşturmaya veya güncellemeye yönelik API çağrısının gövdesi, uyarı için kullanılanla aynıdır. aşağıdaki değişikliklerle birlikte diğer uyarılar:
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
dizisinindimensions
öğesinde:org
,env
,proxy
, veregion
mülk. Yalnızca bu özellikler desteklenir.proxy
veregion
öğeleriniALL
olarak ayarlayabilirsiniz.traffic
özelliğinin değerinitotal
olarak ayarlamanız gerekir.
conditions
dizisinde:metrics
özelliğitrafficChange
değerine sahip olmalıdır.comparator
özelliği,increasedBy
veyadecreasedBy
olarak ayarlanmalıdır.threshold
özelliği, trafikteki artış veya azalma yüzdesini belirten pozitif bir değer içeriyor burada1.0
değeri %100'e karşılık gelir.increasedBy
için değer en az 0,0 (%0) olmalıdır.decreasedBy
için değer şöyle olmalıdır: 0,0 (%0) değerinden büyük veya 1,0'a (%100) eşit ya da küçüktü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.
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 }'
OAuth 2.0 erişim jetonunuz için $ACCESS_TOKEN
öğesini şurada açıklandığı şekilde ayarlayın:
OAuth 2.0 erişim jetonu alın.
Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne 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'si, tanımlı tüm uyarılarla ilgili bilgileri döndürür. Bu API artık sonuçları filtrelemenizi sağlamak için sorgu parametrelerini alır:
enabled
-true
yalnızca etkin uyarıların döndürüleceğini belirtirse. Varsayılan değerfalse
değeridir.alertType
- Döndürülecek uyarının türünü belirtir. İzin verilen değerler:runtime
, varsayılan vecert
.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 ü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ı, hem etkin hem de devre dışı olan yalnızca 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 başlıklı makalede açıklandığı şekilde, $ACCESS_TOKEN
öğesini OAuth 2.0 erişim jetonunuza ayarlayın. Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.