Öğretici: Yayımlanan API'leri izleme

Azure İzleyici ile Azure API Management hizmetinizden gelen ölçümleri veya günlükleri görselleştirebilir, sorgulayabilir, yönlendirebilir, arşivleyebilir ve bunlar üzerinde eylemler gerçekleştirebilirsiniz.

Bu öğreticide şunların nasıl yapıldığı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 bir dizi ek aracı destekler. Daha fazla bilgi edinin

Ön koşullar

Kullanılabilirlik

Önemli

Bu özellik, API Management Premium, Standart, Temel ve Geliştirici katmanlarında kullanılabilir.

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

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

  • Kapasite : API Management hizmetlerinizi yükseltme/düşürme hakkında kararlar almanıza yardımcı olur. Ölçüm dakikada bir gösterilir ve raporlama sırasındaki tahmini ağ geçidi kapasitesini yansıtır. Ölçüm, CPU ile bellek kullanımı gibi ağ geçidi kaynakları temel alınarak hesaplanan 0-100 aralığında değişir.
  • İstekler - API Management hizmetlerinizden geçen API trafiğini analiz etmenize yardımcı olur. Ölçüm dakikada bir gösterilir ve boyutları olan ağ geçidi isteklerinin sayısını bildirir. İstekleri yanıt kodlarına, konuma, ana bilgisayar adına ve hatalara göre filtreleyin.

Önemli

Aşağıdaki ölçümler Mayıs 2019 itibarıyla kullanımdan kaldırılmıştır ve Ağustos 2023'te kullanımdan kaldırılacaktır: 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 eşdeğer işlevler sağlayan İstekler ölçümüne geçin.

API Management Genel Bakış'ta Ölçümlerin ekran görüntüsü

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

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

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

    Portaldaki İzleme menüsündeki Ölçümler öğesinin ekran görüntüsü.

  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 çekici dönemlere 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, Arka Uç Yanıt Kodu Kategorisi'ni seçin ve değer olarak girin 500 . 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 bir 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

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

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

  2. Soldaki menüden Uyarılar'ı seçin.

    Portaldaki İzleme menüsündeki Uyarılar seçeneğinin ekran görüntüsü.

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

  4. Koşul sekmesindeki Sinyal seçin penceresinde:

    1. Sinyal türü'ndeÖlçümler'i seçin.
    2. Sinyal adı'ndaİstekler'i seçin.
    3. Uyarı mantığı bölümünde, uyarının tetiklenmesi gereken oluşum sayısı olan eşik değerini belirtin.
    4. 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.
    5. 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.
    6. 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.

    Portalda uyarı mantığını yapılandırma işleminin ekran görüntüsü.

  5. Kullanıcılara uyarıyı bildirmek 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 eylem grupları oluşturma ve yönetme.

    Portalda yeni eylem grubu için bildirimleri yapılandırma işleminin ekran görüntüsü.

  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. Şimdi api anahtarı olmadan Konferans API'sini çağırarak uyarı kuralını test edin. Örnek:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers 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.

    Portaldaki uyarıların ekran görüntüsü.

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, okuma (GET) işlemlerini ya da Azure portalında gerçekleştirilen veya özgün Yönetim API’leri kullanan 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.

Portaldaki etkinlik günlüğünün ekran görüntüsü.

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

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

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

    Portaldaki İzleme menüsündeki Etkinlik günlüğü öğesinin ekran görüntüsü.

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

Kaynak günlükleri

Kaynak günlükleri, denetim ve sorun giderme amacıyla önemli olan işlemler ve hatalar hakkında zengin bilgiler sağlar. Kaynak günlükleri etkinlik günlüklerinden farklıdır. Etkinlik günlüğü, Azure kaynaklarınızda çalıştırılacak işlemler hakkında içgörüler sağlar. Kaynak günlükleri, kaynağınızın çalıştırdığını işlemler hakkında içgörü sağlar.

Kaynak günlüklerini yapılandırmak için:

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

  2. Tanılama ayarları'nı seçin.

    Portaldaki İzleme menüsündeki Tanılama ayarları öğesinin ekran görüntüsü.

  3. + Tanılama ayarı ekle’yi seçin.

  4. Toplamak istediğiniz günlükleri veya ölçümleri seçin.

    Günlüklerin ve ölçümlerin nereye gönderileceği hakkında çeşitli seçenekleriniz vardır. Örneğin, kaynak günlüklerini bir depolama hesabına ölçümlerle birlikte arşivleyin, bunları bir olay hub'ına akışla aktarın veya Log Analytics çalışma alanına gönderin.

    İpucu

    Log Analytics çalışma alanını seçerseniz, verileri kaynağa özgü ApiManagementGatewayLogs tablosunda 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

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

Daha fazla bilgi için bkz. Platform günlüklerini ve ölçümlerini farklı hedeflere göndermek için tanılama ayarları oluşturma.

Azure İzleyici'de tanılama verilerini görüntüleme

Log Analytics çalışma alanında günlüklerin veya ölçümlerin toplanmasını etkinleştirirseniz verilerin Azure İzleyici'de görünmesi birkaç dakika sürebilir.

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

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

  2. Soldaki menüden Günlükler'i seçin.

    Portaldaki İzleme menüsündeki Günlükler öğesinin ekran görüntüsü.

  3. Verileri görüntülemek için sorgular çalıştırın. Birkaç örnek sorgu 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) 
    

    Portalda ApiManagementGatewayLogs tablosunu sorgulama işleminin ekran görüntüsü.

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

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

Varsayılan olarak, kaynak günlüklerinin toplanmasını etkinleştirmek için bir tanılama ayarı oluşturduğunuzda, günlük tüm API'ler için varsayılan ayarlarla etkinleştirilir. Tüm API'ler için günlük ayarlarını değiştirebilir veya bunları tek tek API'ler için geçersiz kılabilirsiniz. Örneğin, örnekleme hızını veya verilerin ayrıntı düzeyini ayarlayın ya da bazı API'ler için günlüğe kaydetmeyi devre dışı bırakın.

Günlük ayarları hakkında ayrıntılı bilgi için bkz. Tanılama günlüğü ayarları başvurusu.

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>Tüm API'ler'i seçin.
  2. Üst çubuktan Ayarlar sekmesini seçin.
  3. Tanılama Günlükleri bölümüne gidin ve Azure İzleyici sekmesini seçin.
  4. Ayarları gözden geçirin ve gerekirse değişiklikler 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'leri 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 gidin ve Azure İzleyici sekmesini seçin.
  4. Ayarları gözden geçirin ve gerekirse değişiklikler yapın. Kaydet’i seçin.

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: