API Gateway'de yayımlanan API'ler için CloudMonitor kullanarak uyarılar yapılandırabilirsiniz. Bu işlem, API hizmetlerinizin çalışma durumunu takip etmenize ve kararlılıklarını sağlamanıza yardımcı olur.
1. Kaynakları ilişkilendirin
API Gateway'in izleme ve uyarı özelliği çeşitli iş gereksinimlerini karşılayabilir. API Gateway aşağıdaki izleme ölçümlerini destekler:
HttpStatusCode
API yanıt süresi
Toplam API istekleri
Gelen trafik
Giden trafik
Bir uyarı kuralı oluşturmak ve bu kuralı bir veya daha fazla API ile ilişkilendirmek için aşağıdaki yöntemlerden birini kullanabilirsiniz:
Bir veya daha fazla API'yi manuel olarak ilişkilendirin. Bu yöntem, aynı uyarı kuralını belirli API'lere uygulamak için uygundur. API yapılandırması değiştirilirse uyarı kuralı bundan etkilenmez.
Bir API grubu ilişkilendirin. Bu işlem, çağrı durumlarını izlemek amacıyla gruptaki tüm API'lere aynı uyarı kuralını uygular. Gruptaki API'leri eklerseniz, silerseniz veya değiştirirseniz uyarı kuralı otomatik olarak senkronize edilir.
Tüm kaynakları ilişkilendirin. Bu işlem, kuralı hesabınız altındaki API Gateway'deki tüm API'lere uygular. Bu yöntem, az sayıda API yönettiğiniz senaryolar için daha uygundur.
İlk veya ikinci yöntemi kullanıyorsanız, API'ler için izleme ve uyarı yapılandırmak üzere bir uyarı kuralı oluşturmak istediğiniz belirli bir ortamı seçebilirsiniz. Örneğin, üretim (RELEASE), hazırlama (PRE) veya test (TEST) ortamını seçebilirsiniz.
2. Uyarı seviyelerini ve yöntemlerini yapılandırın
CloudMonitor, eşik aralığına bağlı olarak Kritik, Uyarı veya Bilgi uyarıları tetikleyebilir. Her seviye farklı kanallar aracılığıyla bildirim gönderebilir. Uyarı bildirimleriyle ilgili ayrıntılar için bkz. Genel Bakış.
Kritik: Telefon çağrısı + SMS mesajı + e-posta + DingTalk sohbet botu (ücretli özellik).
Uyarı: SMS mesajı + e-posta + DingTalk sohbet botu.
Bilgi: E-posta + DingTalk sohbet botu.
Örneğin, beş dakika boyunca art arda her dakikada 2XX durum kodlarının sayısı 200'ü aşarsa bir bildirim tetikleyen bir uyarı kuralı ayarlayabilirsiniz.
3. Bir uyarı kuralını bir veya daha fazla API ile ilişkilendirin
Uyarı şablonlarını, uyarı kurallarını, bildirim kişilerini ve uyarı bildirimlerini yapılandırma hakkında ayrıntılı bilgi için bkz. Genel Bakış.
API Gateway konsolunda oturum açın ve bir bölge seçin. Sol gezinme bölmesinde seçeneğini belirleyin ve uyarı kuralı eklemek istediğiniz API'yi bulun.
API List sayfasında API adını tıklayarak ayrıntılar sayfasını açın. Sol gezinme bölmesinde Monitoring öğesine tıklayın. Ardından, CloudMonitor konsolunu açmak için sağ üst köşede Alert seçeneğine tıklayın.
Alert Rules sayfasında Create Alert Rule seçeneğine tıklayın. Create Alert Rule sayfasında Ürün değerini API Gateway olarak ve Resource Range değerini Instance olarak ayarlayın. Aşağıda yer alan Add Instance seçeneğine tıklayın. Add Instance iletişim kutusunda eklemek istediğiniz API'leri seçin.
4. Bir uyarı kuralını bir API grubuyla ilişkilendirin
Bir API grubundaki tüm API'lere aynı uyarı kuralını uygulamak için grubun ayrıntılar sayfasına gidin ve sağ üst köşede Enable CloudMonitor seçeneğine tıklayın.
Bir API grubu için CloudMonitor'u ilk kez yapılandırdığınızda bir iletişim kutusu size bir AliyunServiceRoleForApiGatewayMonitoring hizmet bağlantılı rolü oluşturmanızı ister.
Tamam'a tıkladıktan sonra CloudMonitor'un etkinleştirildiğini belirten bir mesaj görüntülenir ve CloudMonitor'daki karşılık gelen uygulama grubunun adı sağlanır. Yetkinizle API Gateway, mevcut API grubunu yansıtmak için bu uygulama grubunu oluşturur. Ad,
APIGATEWAY_${region}_${groupId}biçimini izler; buradaregionAPI grubunun bölgesini vegroupIdkimliğini temsil eder.CloudMonitor etkinleştirildikten sonra, geçerli uygulama grubu için uyarı kurallarını doğrudan yapılandırmak amacıyla grup ayrıntıları sayfasında Go to CloudMonitor to Configure seçeneğine tıklayın.
5. Bir uyarı kuralını tüm API'lerle ilişkilendirin
Yordam, Kaynak Aralığını "Tüm Kaynaklar" olarak ayarlamanız gerektiği dışında Bir veya daha fazla API için uyarı kuralı oluşturma bölümündekiyle aynıdır. Ayarlandığında, aynı uyarı kuralı hesabınız altındaki API Gateway'deki tüm bölgelerdeki tüm API'lere uygulanır. Bu yöntemle belirli API'leri seçemezsiniz.
6. API Gateway tarafından desteklenen uyarı kuralları
API Gateway tarafından sağlanan beş ölçüme dayalı olarak uyarılar yapılandırabilirsiniz: HttpStatusCode, API yanıt süresi, Toplam API istekleri, gelen trafik ve giden trafik.
Bir API'nin yanıt süresi: bir arka uç hizmetinin yanıt süresidir.
Bir API için toplam istek sayısı: belirli bir süre içinde istemcilerden belirli bir API için API Gateway tarafından alınan toplam istek sayısıdır.
Gelen trafik: belirli bir süre içinde istemcilerden API Gateway tarafından alınan isteklerin trafiğidir.
Giden trafik: belirli bir süre içinde API Gateway'den arka uç hizmetlerine gönderilen isteklerin trafiğidir.
HTTP durum kodu: API Gateway tarafından döndürülen durum kodlarıdır. Aşağıdaki HTTP durum kodları desteklenir:
-HTTP 2XX durum kodu: API isteği alındı. Not: Alınan bir istek, istekle amaçlanan işlemin başarılı olduğu anlamına gelmez.
-HTTP 4XX durum kodu: Parametre hatası gibi bir istemci tarafı hatası oluştu.
-Kod5XX: Sunucu tarafı hatasını gösterir. API geliştiricileri genellikle bu hataları yakından izlemelidir.
7. Kullanım notları
API'nizin yayımlandığı ortama göre bir uyarı kuralı yapılandırabilirsiniz. VPC'de yayımlanan bir API için yapılandırılan bir uyarı kuralı etkili olmazsa aşağıdaki işlemleri gerçekleştirmenizi öneririz: API Gateway konsolunda oturum açın, API'yi bulun ve API ayrıntıları sayfasına gitmek için API adına tıklayın. Sol gezinme ağacında İzleme seçeneğine tıklayın. İzleme Verileri sayfasında API'nin izleme verilerini ortama göre sorgulayıp sorgulayamadığınızı kontrol edin. İzleme verilerini ortama göre sorgulayamıyorsanız API Gateway örneğinizin sürümünü güncellemek için bir destek talebi oluşturun.