Öğretici: yayımlanan API 'Leri Izleme

Azure Izleyici ile Azure API Management hizmetinizden gelen ölçümleri veya günlükleri görselleştirin, sorgulayabilir, yönlendirebilir, arşivleyebilir ve bunlar üzerinde işlem yapabilirsiniz.

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

Ayrıca, API 'nizin kullanımını ve performansını izlemek için API Management yerleşik analizlerini de kullanabilirsiniz.

Ö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.

Kullanılabilirlik

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

API Management ölçümleri her dakikada sunarak API 'lerinizin durumunu ve durumunu neredeyse gerçek zamanlı görünürlük sağlar. En sık kullanılan iki ölçüm aşağıda verilmiştir. Tüm kullanılabilir ölçümlerin bir listesi için bkz. desteklenen ölçümler.

• Kapasite -APIM hizmetlerinizi yükseltme/eski sürüme düşürme hakkında kararlar almanı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 -API Management hizmetleriniz aracılığıyla API trafiğini çözümlemenize yardımcı olur. Ölçüm, dakika başına yayılır ve yanıt kodları, konum, ana bilgisayar adı ve hatalar dahil olmak üzere boyutlara sahip ağ geçidi isteklerinin sayısını raporlar.

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

1. Azure portalAPI Management örneğinize gidin. Genel bakış sayfasında API 'leriniz için temel ölçümleri gözden geçirin.

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

   

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

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

5. Grafik, istek ölçümünün boyutları kullanılarak filtrelenebilir. Örneğin, Filtre Ekle' yi seçin, arka uç yanıt kodu kategorisini seçin, değer olarak 500 girin. Artık grafik, API arka ucunda başarısız olan isteklerin sayısını gösterir.

Uyarı kuralı ayarlama

Ölçümler ve etkinlik günlüklerine göre Uyarı alabilirsiniz. Azure Izleyici, tetiklendiğinde aşağıdakileri yapmak için bir uyarı yapılandırmanıza olanak sağlar:

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

Bir istek ölçüsüne göre örnek bir uyarı kuralı yapılandırmak için:

1. Azure portalAPI Management örneğinize gidin.

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

   

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

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

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

   1. Sinyal türü' nde ölçümler' i seçin.
   2. Sinyal adı' nda istekler' i seçin.
   3. Boyutlara göre Böl' de Boyut adı' nda 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.
   5. Uyarı mantığı' nda, uyarının tetiklenme sonrasında bir eşik belirtin ve bitti' yi seçin.

   

6. Mevcut bir eylem grubu seçin veya yeni bir tane oluşturun. Aşağıdaki örnekte yeni bir eylem grubu oluşturulur. Bir bildirim e-postası gönderilecek admin@contoso.com .

   

7. Uyarı kuralının adını ve açıklamasını girip önem derecesini 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 e-posta gönderilir admin@contoso.com .

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

   

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.

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 portalAPI Management örneğinize gidin.

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

   

3. İstenen filtreleme kapsamını seçin ve ardından uygulayın.

Kaynak günlükleri

Kaynak günlükleri, denetim ve sorun giderme amacıyla önemli 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şlemlere yönelik öngörüler sağlar. Kaynak günlükleri, kaynağınızın gerçekleştirdiği işlemlere ilişkin öngörüler sağlar.

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

1. Azure portalAPI Management örneğinize gidin.

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

   

3. + Tanılama ayarı Ekle' yi seçin.

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

   Kaynak günlüklerini, ölçümlerle birlikte bir depolama hesabına arşivleyebilirsiniz, bunları bir olay hub 'ına bağlayabilir veya bir 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.

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

Log Analytics çalışma alanında GatewayLogs veya ölçümler koleksiyonunu etkinleştirirseniz verilerin Azure Izleyici 'de görünmesi birkaç dakika sürebilir. Verileri görüntülemek için:

1. Azure portalAPI Management örneğinize gidin.

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

   

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.:

• Azure izleyici Log Analytics kullanmaya başlayınveya Log Analytics demo ortamınıdeneyin.

• Azure izleyici 'de günlük sorgularına genel bakış.

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:

Sonraki öğreticiye ilerleyin: