Öğretici: İstek izlemeyi kullanarak API'lerinizde hata ayıklama

ŞUNLAR IÇIN GEÇERLIDIR: Tüketim | Geliştirici | Temel | Standart | Premium

Bu öğreticide, Azure API Management'ta istek işlemenin nasıl denetlendiği (izlenir) açıklanır. İzleme, API'nizde hata ayıklamanıza ve sorun gidermenize yardımcı olur.

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

  • Örnek bir çağrıyı izleme
  • İstek işleme adımlarını gözden geçirme

API denetçisini gösteren ekran görüntüsü.

Not

Şu anda API isteği izleme, Temel v2 ve Standart v2 katmanlarında desteklenmemektedir.

Önkoşullar

İzlemeye izin ver ayarını doğrulama

İstek işlemeyi izlemek için API'nizde hata ayıklamak için kullanılan abonelik için İzlemeye izin ver ayarını etkinleştirmeniz gerekir. Portalı iade etmek için:

  1. AYARLARı gözden geçirmek için API Management örneğine gidin ve Abonelikler'i seçin.

    Abonelik için izlemeye izin verme işlemini gösteren ekran görüntüsü.

  2. İzleme, kullandığınız abonelik için etkinleştirilmediyse aboneliği seçin ve İzlemeye izin ver'i etkinleştirin.

Uyarı

  • Aboneliklerle yalnızca hata ayıklama amacıyla izlemeye izin verin. Yetkisiz kullanıcılar için izlemeye izin veren abonelik anahtarlarının paylaşılması anahtarlar, erişim belirteçleri, parolalar, iç ana bilgisayar adları ve IP adresleri gibi izleme günlüklerinde yer alan hassas bilgilerin açığa çıkmasına yol açabilir.
  • Test konsolunda API Management, abonelikte etkinleştirildikten 1 saat sonra izlemeyi otomatik olarak devre dışı bırakır.

Çağrı izleme

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. API’ler seçeneğini belirleyin.

  3. API listenizden Demo Konferans API'sini seçin.

  4. Test sekmesini seçin.

  5. GetSpeakers işlemini seçin.

  6. İsteğe bağlı olarak, "eye" simgesini seçerek istekte kullanılan Ocp-Apim-Subscription-Key üst bilgisinin değerini denetleyin.

    İpucu

    Portalda başka bir abonelik için bir anahtar alarak Ocp-Apim-Subscription-Key değerini geçersiz kılabilirsiniz. Abonelikler'i seçin ve başka bir abonelik için bağlam menüsünü (...) açın. Anahtarları göster/gizle'yi seçin ve anahtarlardan birini kopyalayın. Gerekirse anahtarları da yeniden oluşturabilirsiniz. Ardından test konsolunda + Üst bilgi ekle'yi seçerek yeni anahtar değeriyle bir Ocp-Apim-Subscription-Key üst bilgisi ekleyin.

  7. İzle'yi seçin.

    • Aboneliğiniz henüz izlemeye izin vermiyorsa, aramayı izlemek istiyorsanız etkinleştirmeniz istenir.

    • İsteği izlemeden göndermeyi de seçebilirsiniz.

      API izlemeyi yapılandırmayı gösteren ekran görüntüsü.

İzleme bilgilerini gözden geçirme

  1. Arama tamamlandıktan sonra HTTP yanıtında İzleme sekmesine gidin.

  2. Ayrıntılı izleme bilgilerine atlamak için aşağıdaki bağlantılardan herhangi birini seçin: Gelen, Arka uç, Giden, Hatada.

    Yanıt izlemesini gözden geçirme

    • Gelen - Arayandan alınan özgün istek API Management'ı ve isteğe uygulanan ilkeleri gösterir. Örneğin, Öğretici: API'nizi dönüştürme ve koruma altına ilkeler eklediyseniz, bunlar burada görünür.

    • Arka uç - API arka ucuna gönderilen istekler API Management'ı ve aldığı yanıtı gösterir.

    • Giden - Arayana geri göndermeden önce yanıta uygulanan ilkeleri gösterir.

    • Hata durumunda - İsteğin işlenmesi sırasında oluşan hataları ve hatalara uygulanan ilkeleri gösterir.

    İpucu

    Her bir adım, isteğin API Yönetimi tarafından alınmasından bu yana geçen süreyi de gösterir.

  3. İleti sekmesinde, ocp-apim-trace-location üst bilgisi Azure blob depolamada depolanan izleme verilerinin konumunu gösterir. Gerekirse, izlemeyi almak için bu konuma gidin. İzleme verilerine 24 saate kadar erişilebilir.

    Azure Depolama'de izleme konumu

Ocp-Apim-Trace üst bilgisini kullanarak izlemeyi etkinleştirme

kullanarak curlAPI Management'a istekler yaparken Postman gibi bir REST istemcisi veya bir istemci uygulaması, aşağıdaki istek üst bilgilerini ekleyerek izlemeyi etkinleştirin:

  • Ocp-Apim-Trace - değeri olarak ayarlayın true
  • Ocp-Apim-Subscription-Key - API'ye erişime izin veren izleme özellikli bir aboneliğin anahtarına değer ayarlayın

Yanıt, Azure blob depolamada izleme verilerinin konumunun URL'si ile Ocp-Apim-Trace-Location üst bilgisini içerir.

İzleme bilgilerini özelleştirme hakkında bilgi için izleme ilkesine bakın.

Sonraki adımlar

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

  • Örnek bir çağrıyı izleme
  • İstek işleme adımlarını gözden geçirme

Sonraki öğreticiye ilerleyin: