Öğretici: Yayımlanan API’leri izleme

UYGULANANLAR: Tüm API Management katmanları

Azure İzleyici ile Azure API Management hizmetlerinizden gelen ölçüm ve günlükleri görselleştirebilir, sorgulayabilir, yönlendirebilir, arşivleyebilir ve bunlar üzerinde işlem uygulayabilirsiniz. API Management için Azure İzleyici'ye genel bakış için bkz . API Management'ı izleme.

İpucu

API ekipleri bu özelliği çalışma alanlarında kullanabilir. Çalışma alanları, API'lere ve kendi API çalışma zamanı ortamlarına yalıtılmış yönetim erişimi sağlar.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

• API'nizin ölçümlerini görüntüleme
• Uyarı kuralı ayarlama
• Etkinlik günlüklerini görüntüleme
• Kaynak günlüklerini etkinleştirme ve görüntüleme

Not

API Management, yerleşik analiz ve Application Insights ile tümleştirme de dahil olmak üzere API'leri gözlemlemek için çeşitli ek araçları destekler. Daha fazla bilgi edinin

Önkoşullar

• Azure API Management terminolojisini öğrenin.
• Şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.
• Ayrıca, şu öğreticiyi tamamlayın: İlk API'nizi içeri aktarma ve yayımlama.

API'lerinizin ölçümlerini görüntüleme

API Management, ölçümleri dakikada bir yayarak API'lerinizin durumu ve durumu hakkında neredeyse gerçek zamanlı görünürlük sağlar. En sık kullanılan ölçümler aşağıdadır. Kullanılabilir tüm ölçümlerin listesi için bkz . Ölçümler.

• Kapasite : API Management hizmetlerinizi yükseltme/düşürme hakkında kararlar almanıza yardımcı olur. Ölçüm dakikada bir yayılır ve raporlama sırasındaki tahmini ağ geçidi kapasitesini yansıtır. Ölçüm, CPU ve bellek kullanımı gibi ağ geçidi kaynaklarına ve diğer faktörlere göre hesaplanan 0-100 arasında değişir.

  İpucu

  v2 hizmet katmanlarında ve çalışma alanı ağ geçitlerinde API Management, ağ geçidi kapasitesi ölçümünü ayrı CPU ve bellek kullanımı ölçümleriyle değiştirmiştir. Bu ölçümler ölçeklendirme kararları ve sorun giderme için de kullanılabilir. Daha fazla bilgi edinin

• İstekler - API Management hizmetlerinizden geçen API trafiğini analiz etmenize yardımcı olur. Ölçüm dakikada bir gönderilir ve boyuta sahip ağ geçidi isteklerinin sayısını bildirir. İstekleri yanıt kodlarına, konuma, konak adına ve hatalara göre filtreleyin.

Not

İstekler metriği çalışma alanlarında kullanılamaz.

Önemli

Aşağıdaki ölçümler kullanımdan kaldırıldı: Toplam Ağ Geçidi İstekleri, Başarılı Ağ Geçidi İstekleri, Yetkisiz Ağ Geçidi İstekleri, Başarısız Ağ Geçidi İstekleri, Diğer Ağ Geçidi İstekleri. Lütfen benzer işlevler sağlayan İstekler ölçümüne geçin.

Ölçümlere erişmek için:

1. Azure portalında API Management örneğine gidin. Genel Bakış sayfasındaki İzleyici sekmesinde API'lerinizin önemli ölçümlerini gözden geçirin.

2. Ölçümleri ayrıntılı olarak araştırmak için soldaki menüden İzleme

   

   İpucu

   Çalışma alanında, çalışma alanı ağ geçidinin kapsadığı kapasite ölçümlerini görüntüleyebilirsiniz. Çalışma alanı ağ geçidinin sol menüsünde İzlemeÖlçümleri'ne gidin.>

3. Açılan listeden ilgilendiğiniz ölçümleri seçin. Örneğin, İstekler.

4. Grafikte, API çağrılarının toplam sayısı gösterilmektedir. İlgi dönemlerine odaklanmak için zaman aralığını ayarlayın.

5. İstekler ölçümünün boyutlarını kullanarak grafiği filtreleyebilirsiniz. Örneğin, Filtre ekle'yi seçin Grafik, API arka uçta başarısız olan isteklerin sayısını gösterir.

Uyarı kuralı ayarlama

Ölçümlere ve etkinlik günlüklerine göre uyarılar alabilirsiniz. Azure İzleyici'de, tetiklendiğinde eylem gerçekleştirmek için bir uyarı kuralı yapılandırın. Yaygın eylemler şunlardır:

• E-posta bildirimi gönderme
• Web kancası çağırma
• Bir Azure Mantıksal Uygulamasını çağırma

İstek ölçümünü temel alan örnek bir uyarı kuralı yapılandırmak için:

1. Azure portalında API Management örneğine gidin.

2. Soldaki menüden İzleme

   

3. + Uyarı kuralı oluştur'u> seçin.

4. Koşul sekmesinde:

   1. Sinyal adı bölümünde İstekler'i seçin.
   2. Uyarı mantığı'nda uyarının varsayılan değerlerini gözden geçirin veya değiştirin. Örneğin, uyarının tetiklenmesi gereken oluşum sayısı olan statik Eşik değerini güncelleştirin.
   3. Boyutlara göre böl bölümünde Boyut adı bölümünde Ağ Geçidi Yanıt Kodu Kategorisi'ni seçin.
   4. Boyut değerleri'nde yetkisiz veya geçersiz istekler gibi istemci hataları için 4xx'i seçin. Boyut değeri görünmüyorsa Özel değer ekle'yi seçin ve 4xx girin.
   5. Değerlendirme zamanları bölümünde, varsayılan ayarları kabul edin veya kuralın çalışma sıklıklarını yapılandırmak için diğer ayarları seçin. İleri'yi seçin.

   

5. Kullanıcılara uyarı hakkında bilgi vermek ve eylem yapmak için Eylemler sekmesinde bir veya daha fazla eylem grubu seçin veya oluşturun. Örneğin, adresine bildirim e-postası admin@contoso.comgöndermek için yeni bir eylem grubu oluşturun. Ayrıntılı adımlar için bkz . Azure portalında eylem grupları oluşturma ve yönetme.

   

6. Uyarı kuralı oluştur'un Ayrıntılar sekmesinde, uyarı kuralının adını ve açıklamasını girin ve önem düzeyini seçin.

7. İsteğe bağlı olarak kalan ayarları yapılandırın. Ardından Gözden Geçir + oluştur sekmesinde Oluştur'u seçin.

8. İsteğe bağlı olarak, uyarıyı tetikleyen bir isteğin benzetimini yapmak için BIR HTTP istemcisi kullanarak uyarı kuralını test edin. Örneğin, aşağıdaki komutu bir terminalde çalıştırarak API Management ana bilgisayar adını API Management örneğinizin konak adıyla değiştirin:

   curl GET https://contoso.azure-api.net/non-existent-endpoint HTTP/1.1 
   

   Uyarı, değerlendirme dönemine göre tetiklenir ve adresine admin@contoso.come-posta gönderir.

   Uyarılar, API Management örneğinin Uyarılar sayfasında da görünür.

   

Etkinlik günlükleri

Etkinlik günlükleri, API Management hizmetlerinizdeki işlemler hakkında içgörü sağlar. Etkinlik günlüklerini kullanarak, API Management hizmetleriniz üzerinde gerçekleştirilen herhangi bir yazma işlemi (PUT, POST, DELETE) için "ne, kim ve ne zaman" sorularını yanıtlayabilirsiniz.

Not

Etkinlik günlükleri, Azure portalında gerçekleştirilen okuma (GET) işlemlerini veya işlemleri içermez.

API Management hizmetinizdeki etkinlik günlüklerine veya Azure İzleyici’deki tüm Azure kaynaklarınızın günlüklerine erişebilirsiniz.

Etkinlik günlüğünü görüntülemek için:

1. Azure portalında API Management örneğine gidin.

2. Etkinlik günlüğü'nü seçin.

   

3. İstediğiniz filtreleme kapsamını ve ardından Uygula'yı seçin.

Kaynak günlükleri

Kaynak günlükleri (Azure İzleyici günlükleri), API Management işlemleri ve hataları hakkında denetim ve sorun giderme amacıyla önemli olan zengin bilgiler sağlar. Bir tanılama ayarı aracılığıyla etkinleştirildiğinde, günlükler API Management ağ geçidi tarafından alınan ve işlenen API istekleri hakkında bilgi toplar.

Not

Tüketim katmanı kaynak günlüklerinin toplanmasını desteklemez.

İpucu

Çalışma alanları olan API Management örneklerinde, API Management hizmeti genelindeki federasyon günlüklerine merkezi API izleme için API platformu ekibi tarafından erişilebilirken, çalışma alanı ekipleri çalışma alanının API'lerine özgü günlüklere erişebilir. Çalışma alanları ile Azure Monitor günlüğü hakkında daha fazla bilgi edinin

Kaynak günlüklerinin toplanması için bir tanılama ayarı yapılandırmak için:

1. Azure portalında API Management örneğine gidin.

2. Soldaki menüde, İzleme altında Tanılama ayarları>+ Tanılama ayarı ekle'yi seçin.

   

3. Tanılama ayarı sayfasında, tanılama ayarı için ayrıntıları girin veya seçin:

   1. Tanılama ayarı adı: Açıklayıcı bir ad girin.
   2. Kategori grupları: İsteğe bağlı olarak senaryonuz için bir seçim yapın.
   3. Kategoriler: Altında bir veya daha fazla kategori seçin. Örneğin ApiManagement Ağ Geçidi ile ilgili günlükler'i seçerek API Management ağ geçidine yapılan çoğu isteğin günlüklerini toplayın.
   4. Hedef ayrıntıları'nın altında bir veya daha fazla seçenek belirleyin ve hedefin ayrıntılarını belirtin. Örneğin, günlükleri bir Azure Log Analytics çalışma alanına gönderin, günlükleri bir depolama hesabına arşivleyin veya bir olay hub'ına akışla aktarabilirsiniz. Daha fazla bilgi için bkz. Azure İzleyici'de tanılama ayarları.
   5. Kaydet'i seçin.

   İpucu

   • API Management için Azure İzleyici tabanlı panoda API analizini görüntülemek için (İzleme>Analizi dikey penceresi), hedef olarak bir Azure Log Analytics çalışma alanı seçin.
   • Log Analytics çalışma alanını seçerseniz, verileri kaynağa özgü bir tabloda (örneğin ApiManagementGatewayLogs tablosu) depolamayı veya genel AzureDiagnostics tablosunda depolamayı seçebilirsiniz. Bunu destekleyen günlük hedefleri için kaynağa özgü tabloyu kullanmanızı öneririz. Daha fazla bilgi edinin

4. Günlük hedefi veya hedefleri için ayrıntıları yapılandırdıktan sonra Kaydet'i seçin.

Not

API Management hizmetinizin MinApiVersion özelliği 2022-09-01-preview'dan daha yüksek bir API sürümüne ayarlandıysa tanılama ayarı nesnesi eklemek hataya neden olabilir.

Not

API Management çalışma alanları için tanılama ayarlarını etkinleştirmek için bkz. Çalışma alanı oluşturma ve yönetme.

Azure Log Analytics'te günlükleri ve ölçümleri görüntüleme

Log Analytics çalışma alanında günlüklerin veya ölçümlerin toplanmasını etkinleştirirseniz verilerin Azure İzleyici'de ve API Management için Azure İzleyici tabanlı panoda (İzleme>Analizi dikey penceresi) görünmesi birkaç dakika sürebilir.

Verileri görüntülemek için:

1. Azure portalında API Management örneğine gidin.

2. Soldaki menüde İzleme'nin altında Günlükler'i seçin.

3. Verileri görüntülemek için sorgular çalıştırın. Çeşitli örnek sorgular sağlanır veya kendi sorgunuzu çalıştırın. Örneğin, aşağıdaki sorgu ApiManagementGatewayLogs tablosundan en son 24 saatlik verileri alır:

   ApiManagementGatewayLogs
   | where TimeGenerated > ago(1d) 
   

   

API Management için kaynak günlüklerini kullanma hakkında daha fazla bilgi için bkz:

• Log Analytics öğreticisi.
• Azure İzleyici'deki günlük sorgularını genel bakış.

API günlük ayarlarını değiştirme

API Yönetimi ağ geçidi veya üretken yapay zeka ağ geçidi (LLM) günlüklerinin toplanmasını sağlamak için tanılama ayarını oluşturmak amacıyla portalı kullandığınızda, günlükler varsayılan ayarlarla etkinleştirilir. Varsayılan ayarlar istek veya yanıt gövdeleri gibi isteklerin veya yanıtların ayrıntılarını içermez. Tüm API'ler için günlük ayarlarını yapabilir veya bunları tek tek API'ler için geçersiz kılabilirsiniz. Örneğin, örnekleme oranını veya ağ geçidi günlük verilerinin ayrıntı düzeyini ayarlayın, LLM istek veya yanıt iletilerinin kaydedilmesini etkinleştirin ya da belirli API'lerin kaydını devre dışı bırakın.

Günlük ayarları hakkında ayrıntılı bilgi için Tanılama - Oluştur veya Güncelle ve API Tanılama - Oluştur veya Güncelle REST API başvuru sayfalarına bakın.

Tüm API'ler için günlük ayarlarını yapılandırmak için:

1. API Management örneğinizin sol menüsünde API'ler API'ler
2. Üst çubuktan Ayarlar sekmesini seçin.
3. Tanılama Günlükleri bölümüne kadar aşağı kaydırın ve Azure İzleyici sekmesini seçin.
4. Ayarları gözden geçirin ve gerekirse değişiklik yapın. Kaydet'i seçin.

Belirli bir API için günlük ayarlarını yapılandırmak için:

1. API Management örneğinizin sol menüsünde API API'lerini> ve ardından API'nin adını seçin.
2. Üst çubuktan Ayarlar sekmesini seçin.
3. Tanılama Günlükleri bölümüne kadar aşağı kaydırın ve Azure İzleyici sekmesini seçin.
4. Ayarları gözden geçirin ve gerekirse değişiklik yapın. Kaydet'i seçin.

Önemli

API Management, Azure İzleyici'ye gönderilen günlük girdilerinin boyutu için 32 KB sınırı uygular. Günlük girdisinin sınırı aşması davranışı günlük kategorisine ve günlüğe kaydedilen veri özniteliklerine bağlıdır:

• API Management ağ geçidi günlükleri - Günlük girdisindeki günlüğe kaydedilen istek veya yanıt yükleri toplanırsa her birinin sayısı en fazla 8.192 bayt olabilir. Bir girdideki tüm özniteliklerin birleşik boyutu 32 KB'yi aşarsa, API Management tüm gövde ve izleme içeriğini kaldırarak girişi kırpır.
• Üretken Yapay Zeka Ağ Geçidi Günlükleri - 32 KB'a kadar olan LLM istek veya yanıt mesajları toplandığında, tek bir girişte gönderilir. 32 KB'tan büyük iletiler bölünür ve daha sonra yeniden yapılandırma için sıra numaraları içeren 32 KB öbeklerinde günlüğe kaydedilir. İstek iletileri ve yanıt iletileri 2 MB'ı aşamaz.

Sonraki adımlar

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:

• API'nizin ölçümlerini görüntüleme
• Uyarı kuralı ayarlama
• Etkinlik günlüklerini görüntüleme
• Kaynak günlüklerini etkinleştirme ve görüntüleme

Sonraki öğreticiye ilerleyin:

İzleme çağrıları