Azure API Management'ı Azure Application Insights ile Tümleştirme

  • Makale
  • Okumak için 4 dakika

azure Application Insights azure API Management ile kolayca tümleştirebilirsiniz. Azure Application Insights, birden çok platformda uygulama oluşturup yöneten web geliştiricileri için genişletilebilir bir hizmettir. Bu kılavuzda şunları yapmanız gerekir:

  • Application Insights tümleştirmenin her adımını API Management ' de gözden geçir.
  • API Management hizmet örneğiniz üzerindeki performans etkisini azaltmaya yönelik stratejiler öğrenin.

Önkoşullar

Azure API Management örneğine ihtiyacınız vardır. Önce bir tane oluşturun .

Application Insights örneği oluşturma

Application Insights kullanmak için Application Insights hizmetin bir örneğini oluşturun. Azure portal kullanarak bir örnek oluşturmak için, bkz. çalışma alanı tabanlı Application Insights kaynakları.

Application Insights ile API Management arasında bağlantı oluşturma

  1. Azure Portal Azure API Management hizmet örneğinize gidin.
  2. soldaki menüden Application Insights seçin.
  3. + Ekle'yi seçin.
    Yeni bir bağlantının nereye ekleneceğini gösteren ekran görüntüsü
  4. daha önce oluşturduğunuz Application Insights örneğini seçin ve kısa bir açıklama sağlayın.
  5. Application Insights API Management örneğinizin kullanılabilirlik izlemesini etkinleştirmek için, kullanılabilirlik izleyicisi ekle onay kutusunu seçin.
    • Bu ayar, API Management hizmeti uç noktasının yanıt verip vermediğini düzenli olarak doğrular.
    • sonuçlar Application Insights örneğinin kullanılabilirlik bölmesinde görünür.
  6. Oluştur’u seçin.
  7. bir izleme anahtarı ile yeni Application Insights günlükçüsü 'nin artık listede göründüğünü denetleyin.
    izleme anahtarıyla yeni oluşturulan Application Insights günlükçüsü 'nin nerede görüntüleneceği gösteren ekran görüntüsü

Not

arka planda, Application Insights örneğinin izleme anahtarını içeren API Management örneğiniz için bir günlükçü varlığı oluşturulur.

apı 'niz için Application Insights günlüğe kaydetmeyi etkinleştirme

  1. Azure Portal Azure API Management hizmet örneğinize gidin.

  2. Soldaki menüden API'ler seçeneğini belirleyin.

  3. Bu örnekte, API 'nize tıklayarak bu örnek Tanıtım Konferansı API 'si. Yapılandırıldıysa, bir sürüm seçin.

  4. üstteki çubukta Ayarlar sekmesine gidin.

  5. Tanılama günlükleri bölümüne gidin.
    uygulama Analizler günlükçüsü

  6. Etkinleştir kutusunu işaretleyin.

  7. Hedef açılan menüsünde, eklenen günlükçüyü seçin.

  8. Örnekleme (%) olarak 100 girin ve her zaman günlük hataları onay kutusunu seçin.

  9. Geri kalan ayarları olduğu gibi bırakın.

    Uyarı

    Günlük değeri 0 olan Yük baytlarının varsayılan sayısını geçersiz kılmak API 'nizin performansını önemli ölçüde azaltabilir.

  10. Kaydet’i seçin.

  11. Arka planda adlı bir Tanılama VARLıĞı, applicationinsights API düzeyinde oluşturulur.

Not

API Management tüm yanıtı istemciye gönderdiğinde istekler başarılı olur.

Ayar adı Değer türü Description
Etkinleştir boolean Bu API 'nin günlüğe kaydetmenin etkinleştirilip etkinleştirilmeyeceğini belirtir.
Hedef Azure Application Insights günlükçüsü kullanılacak Azure Application Insights günlükçüsü belirtir.
Örnekleme (%) decimal 0 ile 100 (yüzde) arasında değerler.
Application Insights için günlüğe kaydedilecek isteklerin yüzdesini belirtir. %0 örnekleme, %100 örnekleme, günlüğe kaydedilen tüm isteklerin olduğu anlamına gelen sıfır istek günlüğe kaydedilir.
Application Insights istekleri günlüğe kaydederken performans üzerindeki etkiyi azaltmak için bu ayarı kullanın. Bkz. performans etkileri ve günlük örneklemesi.
Her zaman günlüğe kaydetme hataları boolean bu ayar seçilirse, örnekleme ayarından bağımsız olarak tüm arızalar Application Insights kaydedilir.
Günlük istemcisi IP adresi bu ayar seçilirse, apı istekleri için istemci ıp adresi Application Insights kaydedilir.
Ayrıntı Düzeyi Ayrıntı düzeyini belirtir. Yalnızca daha yüksek önem düzeyine sahip özel izlemeler günlüğe kaydedilir. Varsayılan: bilgi.
Bağıntı protokolü Birden çok bileşen tarafından gönderilen Telemetriyi ilişkilendirmek için kullanılan protokolü seçin. Varsayılan: eski
bilgi için bkz. Application Insights telemetri bağıntısı.
Temel seçenekler: günlüğe kaydedilecek üst bilgiler list istekler ve yanıtlar için Application Insights için günlüğe kaydedilecek üst bilgileri belirtir. Varsayılan: günlüğe hiçbir üst bilgi kaydedilmez.
Temel seçenekler: günlüğe kaydedilecek yük baytlarının sayısı tamsayı isteklerin ve yanıtların Application Insights için gövdenin kaç tane ilk baytından kaydedildiğini belirtir. Varsayılan: 0.
Gelişmiş Seçenekler: ön uç Isteği ön uç isteklerinin Application Insights için günlüğe kaydedilip edilmeyeceğini belirtir. Ön uç isteği , Azure API Management hizmetine gelen bir isteğidir.
Gelişmiş Seçenekler: ön uç yanıtı Application Insights için ön uç yanıtlarının kaydedilip kaydedilmeyeceğini belirtir. Ön uç yanıtı , Azure API Management hizmetinden giden bir yanıttır.
Gelişmiş Seçenekler: arka uç Isteği Application Insights için arka uç isteklerinin günlüğe kaydedilip edilmeyeceğini belirtir. Arka uç isteği , Azure API Management hizmetinden giden bir istek.
Gelişmiş Seçenekler: arka uç yanıtı Application Insights için arka uç yanıtlarının kaydedilip kaydedilmeyeceğini belirtir. Arka uç yanıtı , Azure API Management hizmetine gelen bir yanıttır.

Not

Günlükçüleri farklı düzeylerde belirtebilirsiniz:

  • Tek API günlükçüsü.
  • Tüm API 'Ler için bir günlükçü.

Her ikisini de belirtme:

  • farklı Günlükçüler farklıysa, her ikisi de kullanılır (çoğullama günlükleri).
  • farklı ayarlarla aynı Günlükçüler varsa, tek bir API günlükçüsü (daha ayrıntılı düzeyi) tüm API 'Ler için geçersiz kılınır.

Application Insights eklenen veriler

Application Insights şunu alır:

Telemetri öğesi Description
İstek Gelen her istek için:
  • ön uç isteği
  • ön uç yanıtı
Bağımlılık Arka uç hizmetine iletilen her istek için:
  • arka uç isteği
  • arka uç yanıtı
Özel durum Başarısız olan her istek için:
  • Kapalı istemci bağlantısı nedeniyle başarısız oldu
  • API ilkelerinin hatayla ilgili bölümü tetiklandı
  • 4xx veya 5xx ile eşleşen bir yanıt HTTP durum koduna sahip
İzleme bir izleme ilkesi yapılandırdısanız.
severityİlkenin trace ayarı, Uygulama Günlüğü'Analizler verbosity ayarına eşit veya Analizler gerekir.

Özel ölçümleri yayma

İlkeyi yapılandırarak özel ölçümler emit-metric yaymanızı sağlar.

Uygulama ölçümlerini Analizler ölçümler için önceden API Management sağlamak için hizmette özel ölçümleri el ile etkinleştirmeniz gerekir.

  1. emit-metricİlkeyi API Oluşturma veya Güncelleştirme ile kullanın.
  2. Diğer "metrics":true özelliklerle birlikte yüküne ekleyin.

Not

Uygulama Analizler başına ölçüm ve olay sayısı üst sınırı ve sayısı hakkında bilgi için bkz. Uygulama Analizler sınırları.

Performans etkileri ve günlük örnekleme

Uyarı

Tüm olayların günlüğe kaydı, gelen istek hızına bağlı olarak ciddi performans etkilerine neden olabilir.

İç yük testlerine bağlı olarak, günlük özelliğinin etkinleştirilmesi, istek hızı saniye başına 1.000 istek aşılırken aktarım hızının %40-50 azalmasına neden oldu. Uygulama Analizler, istatistiksel analiz kullanarak uygulama performansını değerlendirmek için tasarlanmıştır. Şu şekilde değildir:

  • Bir denetim sistemi olması amaçlanan.
  • Yüksek hacimli API'ler için her bir isteği günlüğe kaydetmeye uygun.

Örnekleme ayarını ayarlayarak günlüğe kaydedilen isteklerin sayısını işebilirsiniz. %100 değeri tüm isteklerin günlüğe kaydedileceğini, %0'lık bir değerin ise günlüğe kaydetmeyi yansıtmadığı anlamına gelir.

Örnekleme, telemetri hacminin azaltılmasına yardımcı olur ve günlüğe kaydetmenin avantajlarını taşımaya devam ederken önemli performans düşüşlerini etkili bir şekilde önler.

Performans sorunlarını geliştirmek için şunları atlayabilirsiniz:

  • İstek ve yanıt üst bilgileri.
  • Gövde günlüğü.

Video

Sonraki adımlar