Öğretici: Yayımlanan API'leri izleme

Bu Azure İzleyici, Azure API Management hizmetinize gelen ölçümleri veya günlükleri görselleştirebilirsiniz, sorgular, rotalar, arşivler ve 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

Api'nizin API Management performansını izlemek için yerleşik analizlerini de kullanabilirsiniz.

Önkoşullar

Kullanılabilirlik

Önemli

Bu özellik, Premium ,Standard, Basicve Developer katmanlarında API Management.

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

API Management dakikada bir ölçümler yayarak API'nizin durumuna ve durumuna neredeyse gerçek zamanlı görünürlük sağlar. Aşağıda en sık kullanılan iki ölçüm yer almaktadır. Kullanılabilir tüm ölçümlerin listesi için bkz. desteklenen ölçümler.

  • Kapasite - APIM hizmetlerinizi yükseltme/düşürme hakkında kararlar alamanıza yardımcı olur. Ölçüm, dakika başına yayılır ve raporlama zamanındaki 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 - Hizmet hizmetlerinizi kullanarak API trafiğini analiz etmenize API Management olur. Ölçüm dakikada bir yayılmakta ve yanıt kodları, konum, ana bilgisayar adı ve hatalar gibi boyutlara sahip ağ geçidi isteklerinin sayısını rapor eder.

Önemli

Aşağıdaki ölçümler Mayıs 2019'dan itibaren kullanımdan kaldırılacaktı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şlevsellik sağlayan İstekler ölçümüne geçiş yapma.

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

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

  1. uygulama Azure portal,uygulama örneğinize API Management gidin. Genel Bakış sayfasında API'leriniz için ana ölçümleri gözden geçirebilirsiniz.

  2. Ölçümleri ayrıntılı olarak araştırmak için sayfanın alt kısmında bulunan menüden Ölçümler'i seçin.

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

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

  4. Grafikte, API çağrılarının toplam sayısı gösterilmektedir.

  5. Grafik, İstekler ölçümlerinin boyutları kullanılarak filtrelenmiş olabilir. Örneğin Filtre ekle'yi seçin,Arka Uç Yanıt Kodu Kategorisi'ne tıklayınve değer olarak 500 girin. Şimdi 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 gönderebilirsiniz. Azure İzleyici tetiklendiğinde aşağıdakini yapmak için bir uyarı yapılandırmaya olanak sağlar:

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

İstek ölçümüne göre örnek bir uyarı kuralı yapılandırmak için:

  1. uygulama Azure portal,uygulama örneğinize API Management gidin.

  2. Sayfanın alt kısmında bulunan menü çubuğundan Uyarılar'ı seçin.

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

  3. + Yeni uyarı kuralı'nı seçin.

  4. Uyarı kuralı oluştur penceresindeKoşul'ı seçin.

  5. Sinyal mantığını yapılandır penceresinde:

    1. Sinyal türü'neÖlçümler'i seçin.
    2. Sinyal adı'nınaltında İstekler'i seçin.
    3. Boyuta göre böl'deBoyut adı'nın altındaAğ Geçidi Yanıt Kodu Kategorisi'ni seçin.
    4. Boyut değerleri'ninaltında, yetkisiz veya geçersiz istekler gibi istemci hataları için 4xx'i seçin.
    5. Uyarı mantığı'da,uyarının tetiklendikten sonra tetiklen bir eşik belirtin ve Bitti'yi seçin.

    Sinyal Mantığını Yapılandır pencerelerinin ekran görüntüsü

  6. Var olan bir eylem grubunu seçin veya yeni bir grup oluşturun. Aşağıdaki örnekte yeni bir eylem grubu oluşturulur. adresine bir bildirim e-postası admin@contoso.com gönderilir.

    Yeni eylem grubu için bildirimlerin ekran görüntüsü

  7. Uyarı kuralının adını ve açıklamasını girin ve önem düzeyini seçin.

  8. Uyarı kuralı oluşturma’yı seçin.

  9. Şimdi bir 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 
    

    Değerlendirme süresine göre bir uyarı tetiklenir ve adresine e-posta admin@contoso.com gönderilir.

    Uyarılar, örnek için Uyarılar sayfasında da API Management görünür.

    Portalda uyarıların ekran görüntüsü

Etkinlik günlükleri

Etkinlik günlükleri, API Management hizmetleriniz üzerinde gerçekleştirilen işlemler hakkında bilgi 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.

Portalda etkinlik günlüğünün ekran görüntüsü

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

  1. uygulama Azure portal,uygulama örneğinize API Management gidin.

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

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

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

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ız üzerinde gerçekleştirilen işlemlerle ilgili içgörüler sağlar. Kaynak günlükleri, kaynağınız tarafından gerçekleştirilen işlemler hakkında içgörü sağlar.

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

  1. uygulama Azure portal,uygulama örneğinize API Management gidin.

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

    İzleme menüsünde 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.

    Kaynak günlüklerini ve ölçümleri bir depolama hesabına arşivleyebilirsiniz, bunları olay hub'larına akışla gönderebilir veya Log Analytics çalışma alanına gönderebilirsiniz.

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

Tanılama verilerini Azure İzleyici

Log Analytics çalışma alanında GatewayLogs veya ölçüm toplamayı etkinleştirirsiniz, verilerin log analytics çalışma alanında görünmesi Azure İzleyici. Verileri görüntülemek için:

  1. uygulama Azure portal,uygulama örneğinize API Management gidin.

  2. Sayfanın alt tarafında bulunan menüden günlükleri seçin.

    Izleme menüsündeki Günlükler öğesinin ekran görüntüsü

Verileri görüntülemek için sorguları çalıştırın. Birkaç örnek sorgu sağlanır veya kendi kendinize çalıştırılır. Örneğin, aşağıdaki sorgu, GatewayLogs tablosundan en son 24 saat 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.:

Aşağıdaki JSON başarılı bir API isteği için GatewayLogs 'ta örnek bir giriş gösterir. Ayrıntılar için bkz. şema başvurusu.

{
    "Level": 4,
    "isRequestSuccess": true,
    "time": "2020-10-14T17:xx:xx.xx",
    "operationName": "Microsoft.ApiManagement/GatewayLogs",
    "category": "GatewayLogs",
    "durationMs": 152,
    "callerIpAddress": "xx.xx.xxx.xx",
    "correlationId": "3f06647e-xxxx-xxxx-xxxx-530eb9f15261",
    "location": "East US",
    "properties": {
        "method": "GET",
        "url": "https://apim-hello-world.azure-api.net/conference/speakers",
        "backendResponseCode": 200,
        "responseCode": 200,
        "responseSize": 41583,
        "cache": "none",
        "backendTime": 87,
        "requestSize": 526,
        "apiId": "demo-conference-api",
        "operationId": "GetSpeakers",
        "apimSubscriptionId": "master",
        "clientTime": 65,
        "clientProtocol": "HTTP/1.1",
        "backendProtocol": "HTTP/1.1",
        "apiRevision": "1",
        "clientTlsVersion": "1.2",
        "backendMethod": "GET",
        "backendUrl": "https://conferenceapi.azurewebsites.net/speakers"
    },
    "resourceId": "/SUBSCRIPTIONS/<subscription ID>/RESOURCEGROUPS/<resource group>/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/APIM-HELLO-WORLD"
}

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: