Özel raporlar oluşturma

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

Özel raporlar, belirli API metriklerini ayrıntılı bir şekilde inceleyebilmenizi ve tam olarak görmek istediğiniz verileri görüntülemenizi sağlar. API İzleme kontrol panellerinden, oluşturma sırasında yapılandırılmış koşullara göre önceden ayarlanmış filtre ve metrikleri içeren özel bir rapor oluşturabilirsiniz. Ayrıca, raporda sizin için bir dizi varsayılan boyut ve metrik yapılandırılır.

Bağlamınıza göre özel rapor oluşturun

Aşağıdaki tabloda özetlendiği şekilde, bağlamınıza göre hızlıca özel raporlar oluşturun. Özel Raporlar sayfasında, API Monitoring kullanılarak oluşturulan özel raporlar, tabloda gösterildiği gibi benzersiz bir şekilde (varsayılan olarak) adlandırılır; özel raporu düzenlerken adı değiştirebilirsiniz.

Özel rapor bağlamı Özel rapor için varsayılan adlandırma kuralı
En son kontrol paneli API Monitoring Recent Generated
Zaman çizelgesi kontrol paneli API Monitoring Timeline Generated
Kontrol panelini inceleyin API Monitoring Investigate Generated
Uyarı koşulu API Monitoring Generated: alert-name

Varsayılan boyut ve metrikler

Özel rapor, varsayılan olarak API Monitoring tarafından oluşturulan tüm raporlar için aşağıdaki tabloda listelenen boyutları ve metrikleri içerecektir.

Bileşen Varsayılanlar
Boyutlar İstek URI'si
Metrikler
  • Toplam yanıt süresi
  • Hedeflenen yanıt süresi
  • Proxy hataları
  • Hedef hataları

Özel raporu düzenleme

Önceki bölümde belirtildiği gibi, özel raporlarda önceden tanımlanmış bir API İzleme varsayılan boyutları ve metrikleri grubu önceden yapılandırılmıştır. Rapor oluşturulduktan sonra, gerektiği şekilde metrik ve boyut eklemek veya silmek için özel raporu düzenleyebilirsiniz. Örneğin, araştırmanızı belirli bir erişim jetonu, geliştirici uygulaması, API proxy'si veya istek kimliğiyle daraltmak isteyebilirsiniz.

Aşağıdaki özel raporda, önceden tanımlanmış Gateway Flow ID boyutunu ekleyeceksiniz. Burada Gateway Flow ID, Edge'e yapılan her API isteğinin benzersiz UUID'sini içerir. Raporun zaten Request URI boyutunu kullandığını unutmayın:

Aşağıdaki örnek, özel rapora Client ID boyutunu ekler. Client ID boyutu, API çağrısını yapan geliştiricinin tüketici anahtarını (API anahtarı) içerir. İstekte API anahtarı olarak iletilebilir veya OAuth jetonuna dahil olabilir:

Özel rapor, tüm Client ID değerleriyle ilgili bilgileri içerir. Sonraki örnekte, belirli bir Client ID için özel rapor oluşturabilmeniz amacıyla bir filtre eklenmiştir:

Bir rapora ekleyebileceğiniz önceden tanımlanmış tüm boyutlar ve metrikler hakkında daha fazla bilgi için Analytics metrikleri, boyutları ve filtreleri referansı başlıklı makaleyi inceleyin.

Bir sonraki örnekte, policies.ratelimit.QuotaViolation hata kodu ve 5xx durum kodları için varsayılan metrikleri ve boyutları yakalayan özel bir rapora bir Filtre ekleyeceksiniz:

Bir özel raporu düzenlemeyle ilgili tüm ayrıntılar için Özel raporları yönetme başlıklı makaleyi inceleyin.

Örnek: Dağıtım sorunlarını teşhis etmek için özel raporları kullanma

Kullanıcı veya ürün kimliği, fiyat, REST işlemi, hedef sürüm, hedef URL ve mesaj uzunluğu gibi özel analiz verilerini toplamak için API proxy'lerinize İstatistiklerCollector politikasını ekleyin. Veriler Apigee tarafından önceden tanımlanmış akış değişkenlerinden, istek üstbilgilerinden, sorgu parametrelerinden veya sizin tanımladığınız özel değişkenlerden gelebilir.

Örneğin, API proxy'nize yapılan isteklerde ürün kimliği, kullanıcı kimliği ve hedef sunucu sürümünün başlıkları bulunur. Bu istek aşağıdaki biçimde olabilir:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

Ardından, API proxy'nizle ilgili çalışma zamanı sorunlarını teşhis etmek için başlıklardaki bilgileri kullanabilirsiniz.

Bu başlıklarla ilgili özel rapor oluşturmak için:

  1. Özel üstbilgilerin değerini yakalamak için API'nize StatsCollector politikasını ekleyin:

    <StatisticsCollector name="publishPurchaseDetails">
      <Statistics>
        <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
        <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
        <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
      </Statistics>
    </StatisticsCollector>
    
  2. Proxy'nizi dağıtın ve erişim için zaman tanıyın.

  3. API'nizle ilgili sorunları görüntülemek için Edge kullanıcı arayüzünde Analiz > API İzleme > Son seçeneklerini tıklayın. myapi proxy'si için 4xx ve 5xx hataları aldığınıza dikkat edin:

  4. Son kontrol panelinin sağ bölmesinde daha fazla ayrıntı görüntülemek için myapi proxy satırını seçin.

  5. İnceleme kontrol paneline erişmek için, En son kontrol panelinin sağ bölmesinde Diğer menüsü > İncelemede Görüntüle'yi seçin:

  6. İnceleme kontrol panelini myapi proxy'sine göre filtreleyin ve ardından üstteki grafikte Durum Kodu'nu görüntüleyin. 403 ve 501 hataları aldığınıza dikkat edin:

  7. Edge kullanıcı arayüzünde, Analytics > Özel Raporlar > Raporlar'ı seçerek Boyut olarak bu özel metriklerin değerlerini içeren özel bir rapor oluşturun.

  8. myapi_errors adlı bir özel rapor oluşturmak için + Özel Rapor'u seçin.

  9. Metrik için Proxy Hataları'nı seçin ve Toplama İşlevi'ni Toplam olarak ayarlayın. İsterseniz daha fazla metrik ekleyebilirsiniz.

  10. Önceden tanımlanmış Yanıt Durumu Kodu Boyutu'nu seçin ve ardından Boyutlar'a üç özel prodid, targetersion ve userid istatistiği ekleyin:

  11. Filtreyi yalnızca (apiproxy eq 'myapi') myapi API proxy'sine ait verileri içerecek şekilde ayarlayın:

  12. Raporu kaydedin.

  13. Raporu önceki 24 saat için çalıştırın. Rapor ilk kez açıldığında HTTP 403 ve 501 hatalarının bir grafiğini görürsünüz:

  14. Özet bölümünde, hataları hangi ürünün oluşturduğunu görmek için 403 veya 510'u tıklayın. Örneğin, 403'ü seçersiniz:

  15. Hataları hedef sürüme (alfa veya beta) göre görmek için Özet altında bir ürün kimliğini tıklayın:

  16. Kullanıcıya göre hataları görmek için Özet'in altında bir hedef sürümü tıklayın: