İzleme aracını kullanma

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

İzleme aracı nedir?

Trace, Apigee Edge'de çalışan API proxy'leri için sorun giderme ve izleme aracıdır. Trace, bir API proxy akışı aracılığıyla her adımın ayrıntılarını araştırmanıza olanak tanır.

Trace aracına giriş için bu videoyu izleyin.

Trace nasıl kullanılır?

Trace'in kullanımı kolaydır. Bir izleme oturumu başlatır, ardından Edge platformuna bir API çağrısı gönderir ve sonuçları okursunuz.

  1. API proxy'leri sayfasına aşağıda açıklandığı şekilde erişin.

    Edge

    Edge kullanıcı arayüzünü kullanarak API proxy'leri sayfasına erişmek için:

    1. apigee.com/edge adresinde oturum açın.
    2. Sol gezinme çubuğunda Geliştirme > API Proxy'leri öğesini seçin.

    Klasik Edge (Private Cloud)

    Klasik Edge kullanıcı arayüzünü kullanarak API proxy'leri sayfasına erişmek için:

    1. http://ms-ip:9000 üzerinde oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.
    2. Üst gezinme çubuğunda API'lar > API Proxy'leri seçeneğini belirleyin.
  2. API Proxy'leri sayfasından bir API proxy'si seçin.
  3. İzlemek istediğiniz API'nin dağıtıldığından emin olun.
  4. İzleme aracı görünümüne gitmek için İzle'yi tıklayın.
  5. İzlemek istediğiniz dağıtım ortamını ve proxy düzeltmesini seçmek için İzlemek için Dağıtım açılır menüsünü kullanın.
  6. İzleme Oturumu Başlat'ı tıklayın. İzleme oturumu etkin olduğunda API proxy'si, işleme ardışık düzenindeki her adımın ayrıntılarını kaydeder. İzleme oturumu çalışırken mesajlar ve içerik verileri canlı trafikten yakalanır.

  7. Proxy'niz üzerinden canlı trafiğiniz yoksa API'ye bir istek gönderin. İsteği göndermek için curl, Postman veya bildiğiniz herhangi bir aracı kullanabilirsiniz. İsterseniz isteği doğrudan İzleme aracından da gönderebilirsiniz. URL'yi girip Gönder'i tıklamanız yeterlidir. Not: Yalnızca İzleme aracından GET isteği gönderebilirsiniz, POST isteği gönderemezsiniz.

    Not: Bir Trace oturumu, seçili API proxy'si aracılığıyla mesaj işleyici başına 10 istek/yanıt işlemini destekleyebilir. Edge bulutunda, trafiği yöneten 2 mesaj işlemcisi ile 20 istek/yanıt işlemi desteklenir. Manuel olarak durdurmazsanız izleme oturumu 10 dakika sonra otomatik olarak durur.
  8. Yeterli sayıda istek yakaladığınızda İzleme Oturumu Durdur'u tıklayın.
  9. Soldaki menüde, yakalanan istek/yanıt işlemlerinin listesi gösterilir. İşlemlerden herhangi birini tıklayarak ayrıntılı sonuçları görebilirsiniz.

İzleri okuma

İzleme aracı, işlem haritası ve aşama ayrıntıları olmak üzere iki ana bölümden oluşur:

  • İşlem haritasında politika yürütme, koşullu adımlar ve geçişler dahil olmak üzere API proxy işlemi sırasında gerçekleşen her önemli adımı işaretlemek için simgeler kullanılır. Özet bilgileri görmek için fareyle herhangi bir simgenin üzerine gelin. İstek akışı adımları, işlem haritasının üst kısmında ve yanıt akışı adımlarının alt kısmında görünür.
  • Aracın aşama ayrıntıları bölümü, ayarlanan veya okunan değişkenler, istek ve yanıt başlıkları ve çok daha fazlası dahil olmak üzere proxy'nin dahili işlemesiyle ilgili bilgileri listeler. Söz konusu adımın aşama ayrıntılarını görmek için herhangi bir simgeyi tıklayın.

Aşağıda, ana proxy işleme segmentlerinin etiketlenmiş olduğu örnek bir izleme aracı haritası verilmiştir:

İzleme aracının işlem haritası

İşlem haritası açıklaması

Aşağıdaki tabloda, işlem haritasında göreceğiniz simgelerin amacı açıklanmaktadır. Bu simgeler, proxy akışındaki önemli işleme adımlarının her birini işaretler.

İşlem haritası simgeleri

API proxy'sinin ProxyEndpoint'ine istek gönderen istemci uygulaması.
Daireler, proxy akışındaki geçiş uç noktalarını işaretler. Bunlar istemciden bir istek geldiğinde, istek hedefe ulaştığında, yanıt hedeften geri geldiğinde ve yanıt istemciye geri döndüğünde mevcuttur.

Uzun çubuklar, API proxy akışındaki bir akış segmentinin başlangıcını belirtir. Akış segmentleri şunlardır: ProxyEndpoint isteği, TargetEndpoint isteği, TargetEndpoint yanıtı ve ProxyEndpoint yanıtı. Segmentler PreFlow, Koşullu Akışlar ve PostFlow'u içerir.

Daha fazla bilgi için Akışları yapılandırma bölümüne bakın.

Analytics işlemlerinin arka planda gerçekleştiğini belirtir.

Doğru olarak değerlendirilen koşullu akış. Koşullu akışlara giriş için Akışları yapılandırma bölümüne bakın.

Bazı koşulların Edge tarafından oluşturulduğunu unutmayın. Örneğin aşağıda, Edge'in ProxyEndpoint'te bir hata oluşup oluşmadığını kontrol etmek için kullandığı bir ifade verilmiştir:

((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))

Yanlış olarak değerlendirilen koşullu akış. Koşullu akışlara giriş için Akışları yapılandırma bölümüne bakın.

Bazı koşulların Edge tarafından oluşturulduğunu unutmayın. Örneğin aşağıda, Edge'in TargetEndpoint'te bir hata oluşup oluşmadığını kontrol etmek için kullandığı bir ifade verilmiştir:

(((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))

Politikalar. Her politika türünün benzersiz bir simgesi vardır. Bu, AttributionMessage politikası içindir. Bu simgeler, politikaların nerede doğru sırayla yürütüldüğünü ve başarılı olup olmadığını görmenizi sağlar. Yürütme sonuçlarını ve beklenip beklenmediğini görmek için bir politika simgesini tıklayabilirsiniz. Örneğin, mesajın doğru şekilde dönüştürülüp dönüştürülmediğini veya önbelleğe alınıp alınmadığını görebilirsiniz.

Politikaların doğru şekilde yürütülmesi, onay işaretleriyle açıkça belirtilir. Hata olması durumunda simge üzerinde kırmızı bir ünlem işareti görüntülenir.

İpucu: Herhangi bir politikanın beklenenden uzun sürmesi olup olmadığını görmek için ipucuna veya zaman çizelgesine dikkat edin.

Arka uç hedefi bir Node.js uygulaması olduğunda görünür. Apigee Edge'de Node.js'ye genel bakış sayfasını inceleyin.
API proxy'si tarafından çağrılan arka uç hedefi.
Zaman çizgisi, işleme süresinin ne kadar sürdüğünü (milisaniye cinsinden) gösterir. Geçen zaman segmentlerini karşılaştırmak, API çağrılarınızı yavaşlatan ve yürütülmesi en uzun süren politikaları ayırmanıza yardımcı olur.
Epsilon bir milisaniyeden daha kısa bir zaman aralığını gösterir.

Devre dışı. Bir politika devre dışı bırakıldığında politika simgesinde görünür. Bir politika, herkese açık API ile devre dışı bırakılabilir. API proxy'si yapılandırma referansı başlıklı makaleyi inceleyin.

Hata. Politika Adımı koşulu yanlış olarak değerlendirildiğinde (bkz. Akış değişkenleri ve koşulları) veya bir PromoteFault politikası her yürütüldüğünde bir politika simgesinde görünür.
Atlandı. Adım koşulu "yanlış" olarak değerlendirildiği için politika yürütülmediğinde bir politika simgesinde görünür. Daha fazla bilgi için Akış değişkenleri ve koşulları bölümüne bakın.

Aşama ayrıntılarını anlama

Aracın Aşama Ayrıntıları bölümü, her işleme adımında proxy'nizin durumu hakkında birçok bilgi verir. Aşama Ayrıntıları'nda belirtilen ayrıntılardan bazıları aşağıda verilmiştir. Seçilen adımın ayrıntılarını görmek için izleme aracında herhangi bir simgeyi tıklayın veya bir adımdan diğerine geçmek için İleri/Geri düğmelerini kullanın.

Aşama Ayrıntısı Açıklama
Proxy Uç Noktası Yürütme için hangi ProxyEndpoint akışının seçildiğini belirtir. Bir API proxy'sinin birden fazla adlandırılmış proxy uç noktası olabilir.
Değişkenler

Bir politika tarafından okunan ve bir değere atanan akış değişkenlerini listeler. Ayrıca bkz. Akış değişkenleriyle proxy durumunu yönetme.

Not:

  • Eşittir işareti (=), değişkene atanan değeri gösterir.
  • Üstü çizili eşittir işareti (≠), salt okunur olduğu veya politikanın yürütülmesinde bir hata olduğu için değişkene bir değer atanamadığı anlamına gelir.
  • Boş bir alan, değişken değerinin okunduğunu gösterir.
İstek Başlığı HTTP istek başlıklarını listeler.
İçerik İsteyin HTTP isteği gövdesini gösterir.
Özellikler Özellikler, API proxy'sinin dahili durumunu temsil eder. Bunlar varsayılan olarak gösterilmez.
Hedef Uç Nokta Yürütme işlemi için hangi TargetEndpoint'in seçildiğini belirtir.
Yanıt Başlıkları HTTP yanıt başlıklarını listeler.
Yanıt İçeriği HTTP yanıt gövdesini gösterir.
PostClientFlow İstek istekte bulunan istemci uygulamasına döndürüldükten sonra yürütülen PostClientFlow ile ilgili bilgileri gösterir. PostClientFlow'a yalnızca MessageLogging politikaları eklenebilir. PostClientFlow, şu anda öncelikli olarak yanıt mesajı için başlangıç ve bitiş zaman damgaları arasındaki zaman aralığını ölçmek için kullanılmaktadır.

Filtreleri kullanarak ileti yakalamayı hassaslaştırma

Başlık ve/veya sorgu parametresi değerlerini belirterek İzleme aracında hangi isteklerin gösterileceğini filtreleyebilirsiniz. Filtreler, sorunlara neden olabilecek belirli çağrıları hedeflemenize olanak tanır. Örneğin, belirli içerik barındıran veya belirli iş ortaklarından ya da uygulamalardan gelen isteklere odaklanmanız gerekebilir. Şu ölçütlere göre filtreleme yapabilirsiniz:

  • HTTP üst bilgileri: İzi yalnızca belirli bir üst bilgiyi içeren çağrılarla sınırlandırın. Bu, sorunları gidermenize yardımcı olmanın iyi bir yoludur. Uygulama geliştiricinize bir üst bilgi göndererek soruna neden olan çağrıya bunu eklemesini isteyebilirsiniz. Bu durumda Apigee Edge, sonuçları inceleyebilmeniz için yalnızca bu spesifik başlıkla yapılan çağrıları kaydeder.
  • Sorgu parametreleri: Yalnızca belirli bir parametre değerine sahip çağrılar kaydedilir.

Filtre özelliği hakkında bilmeniz gerekenler

  • Filtre alanlarında filtre parametrelerini belirttikten sonra İzleme oturumunuzu yeniden başlatmanız gerekir.
  • Filtre parametreleri birbirine VE ile eklenir. Belirtilen tüm sorgu ve/veya başlık adı/değer çiftleri, başarılı bir eşleşme için istekte bulunmalıdır.
  • Filtreler aracında kalıp eşleştirme desteklenmemektedir.
  • Filtre parametreleri ve değerleri büyük/küçük harfe duyarlıdır.

İz filtresi oluşturma

  1. Bir izleme oturumu çalışıyorsa İzleme Oturumu Durdur'u tıklayarak oturumu durdurun.
  2. Filtreler alanını genişletmek için İzleme aracının sol üst köşesindeki Filtreler'i tıklayın.

    İzleme aracında, Filtreler kenar çubuğu etiketi daire içine alınmıştır.
  3. Filtreler alanında, filtrelemek istediğiniz sorgu parametresini ve/veya başlık değerlerini belirtin. Bu örnekte, filtrelenecek iki sorgu parametresi belirtiyoruz. Başarılı bir eşleşme için istekte her iki parametre de mevcut olmalıdır.

    İzleme aracında, Filtreler, Sorgu Parametresi'nin altında iki örnek ad ve değer ayarlanmıştır.
  4. İzleme oturumunu başlatın.
  5. API'lerinizi çağırın. Yalnızca belirtilen başlıkların ve/veya sorgu parametrelerini içeren istekler başarılı bir eşleşme üretir.

İşlemler bölümünde, önceden ayarlanmış iki sorgu parametresiyle eşleşen dört sonuç gösterilir.

Yukarıdaki örnekte, şu API çağrısı Trace'te gösterilir:

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

Ancak bu durumda:

http://docs-test.apigee.net/cats?name=Penny

Trace ile hata ayıklama

Trace, API proxy'si ile ilgili birçok dahili ayrıntıyı görmenizi sağlar. Örneğin:

  • Hangi politikaların doğru şekilde çalıştığını veya başarısız olduğunu bir bakışta görebilirsiniz.
  • Analytics kontrol panellerinden birinde API'lerinizden birinin performansında olağan dışı bir düşüş olduğunu fark ettiğinizi varsayalım. Artık Trace'i kullanarak performans sorununun nerede meydana geldiğini belirleyebilirsiniz. Trace, her bir işleme adımının tamamlanması için gereken süreyi milisaniye cinsinden verir. Bir adımın fazla uzun sürdüğünü fark ederseniz düzeltici eylemde bulunabilirsiniz.
  • Aşama ayrıntılarına bakarak arka uca gönderilen başlıkları kontrol edebilir, politikalar tarafından ayarlanan değişkenleri görüntüleyebilirsiniz.
  • Temel yolu doğrulayarak bir politikanın mesajı doğru sunucuya yönlendirdiğinden emin olabilirsiniz.

Görünüm Seçeneklerini Belirleme

İzleme oturumu için görüntüleme seçeneklerini belirleyin.

Seçenek Açıklama
Devre Dışı Bırakılan Politikaları Göster Devre dışı bırakılan politikaları göster. Bir politika, herkese açık API ile devre dışı bırakılabilir. API proxy yapılandırma referansı bölümüne bakın.
Atlanan Aşamaları Göster Atlanan aşamaları gösterir. Atlanan aşama, adım koşulu "yanlış" olarak değerlendirildiği için politika yürütülmediğinde ortaya çıkar. Daha fazla bilgi için Akış değişkenleri ve koşulları bölümüne bakın.
Tüm FlowInfo'ları göster Bir akış segmentindeki geçişleri temsil eder.
Seçilen Aşamayı Otomatik Olarak Karşılaştırın Seçilen aşamayı önceki aşamayla karşılaştırır. Yalnızca seçilen aşamayı görmek için bu özelliği devre dışı bırakın.
Değişkenleri Göster Okunan ve/veya değer atanan değişkenleri gösterir veya gizler.
Özellikleri Göster Özellikler, API proxy'sinin dahili durumunu temsil eder. (Varsayılan olarak gizlidir.)

İz sonuçları indiriliyor

Metin düzenleyicide çevrimdışı olarak görüntülemek ve aramak için ham iz sonuçlarının XML dosyasını indirebilirsiniz. Bu dosya; tüm üst bilgiler, değişkenler ve politikaların içeriği de dahil olmak üzere dinleme oturumunun tüm ayrıntılarını gösterir.

İndirmek için İzleme Oturumu İndir'i tıklayın.

İstekler curl olarak gösteriliyor

Hedef sunucuya yapılan bir API çağrısını izledikten sonra isteği bir curl komutu olarak görüntüleyebilirsiniz. Bu, özellikle birkaç nedenden dolayı hata ayıklama için kullanışlıdır:

  • API proxy'si isteği değiştirebilir. Bu nedenle, proxy'den hedef sunucuya yapılan isteğin orijinal istekten nasıl farklı olduğunu görmek faydalı olacaktır. curl komutu, değiştirilen isteği temsil eder.
  • Curl, daha büyük mesaj yükleri için HTTP üst bilgilerini ve mesaj içeriğini tek bir yerde görmenize olanak tanır. (Şu anda yaklaşık 1.000 karakterle sınırlıdır. Bu sınırı aşmayla ilgili ipucu için bu topluluk yayınına göz atın.)

Curl özelliği, güvenlik amacıyla HTTP Yetkilendirmesi başlığını maskeler.

Trace'te bir API çağrısı geldiğinde istekleri curl olarak görmek için İşlem Haritası şemasında "İstek hedef sunucuya gönderildi" aşamasını seçin ve ardından Aşama Ayrıntıları bölmesindeki "Hedef sunucuya gönderilen istek" sütununda curl'i göster düğmesini tıklayın.

Resim ek açıklamaları, Curl'yi Göster düğmesini ve İşlem Haritası şemasındaki dairelerden birini işaret eder.

Trace'in Apigee Desteği kullanımı

Apigee Edge, varsayılan olarak Apigee Desteği'nin destek sağlamak için API proxy'lerinizdeki İzleme aracını kullanmasına izin verir. Bu seçeneği istediğiniz zaman devre dışı bırakabilirsiniz. Ancak bu seçeneğin devre dışı bırakılması, Apigee Desteği'nin size destek sağlama imkanını sınırlayabilir.

Apigee Desteği'nin Trace aracını kullanmasını devre dışı bırakmak için:

  1. https://Apigee.com/edge adresinde oturum açın.
  2. Sol gezinme çubuğunda Yönetici > Gizlilik ve Güvenlik'i seçin.
  3. Trace Desteği tarafından Trace aracının kullanılmasını devre dışı bırakmak için Apigee Desteği'ni Etkinleştir Trace'i Etkinleştir düğmesini tıklayın.