API Analytics'e genel bakış

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

Bu konu, Edge API Analytics'i tanıtır.

Video: Edge API Analytics hizmetlerine genel bakış için kısa bir video izleyin.

Analizler aracılığıyla API'nizi iyileştirme

Edge API Analytics, API proxy'leri üzerinden akan çok sayıda bilgiyi toplar ve hesaplar. Bu verileri Edge kullanıcı arayüzündeki grafiklerle görselleştirebilir veya Edge yönetim API'lerini kullanarak çevrimdışı analiz için ham verileri indirebilirsiniz.

Analytics, aşağıdakiler gibi yaygın soruları yanıtlamanıza yardımcı olur:

  • API trafiğim zaman içinde nasıl bir trend izliyor?
  • En popüler API yöntemleri hangileri?
  • En başarılı geliştiricilerim kimler?
  • API yanıt süresi en hızlı ne zamandır? En yavaş?
  • Coğrafi olarak en fazla API trafiğini nerede görüyorum?

Bu tür soruların yanıtları, API'lerinizi iyileştirmenize, sorunları gidermenize ve API programınızla ilgili daha iyi iş kararları almanıza yardımcı olur.

API Analytics, herkesin gelişmesine yardımcı olur

Edge API Analytics, sürekli bir veri toplama, analiz etme ve görselleştirme süreciyle API ekibinizin API'lerini ve uygulama geliştiricilerin uygulamalarını iyileştirmesine yardımcı olur:

alt_text
  • API Ekibi: API ekibi, ilgi çekici API'ler oluşturmak için dahili sistemlerden yararlanır. API ekibi, API programının genel durumunu, API'lerin tek tek nasıl performans gösterdiğini ve API'lerin nasıl iyileştirileceğini öğrenmek ister.
  • Uygulama geliştiriciler: Analiz bilgilerini uygulama geliştiricilerle paylaşarak daha iyi uygulamalar elde edersiniz. Bu geliştiriciler, API'nizle yenilik yapıyor ve kuruluşunuza gelir elde etmenize yardımcı olacak yaratıcı uygulamalar oluşturuyor. Analytics, uygulama geliştiricilerin uygulamalarının nasıl performans gösterdiğini ve işletmenizin kârlılığına ne kadar katkıda bulunduğunu öğrenmesine yardımcı olur. Uygulama geliştiriciler, uygulamalarını nasıl iyileştirebileceklerini öğrenmek istiyor.
  • Operasyon Ekibi: Operasyon ekibi, trafik kalıplarını anlamak ve arka uç kaynakları ne zaman ekleneceğini veya diğer önemli düzenlemelerin ne zaman yapılacağını tahmin etmek ister.
  • İşletme sahibi: İşletme sahibi, API yatırımının ne kadar kârlı olduğunu ve gelecekte API'ye nereye yatırım yapacağını görmek ister.

Ne tür veriler toplanır ve analiz edilir?

Edge API Analytics, API proxy'leri üzerinden akan geniş bir veri yelpazesini toplayıp analiz eder. Örneğin:

  • Yanıt süresi
  • İstek gecikmesi
  • İstek boyutu
  • Hedef hataları
  • API ürün adı
  • Geliştiricinin e-posta adresi
  • Uygulama adı
  • Diğer birçok kaynak

API Analytics tarafından toplanan verilerin tam listesi için Analytics metrikleri, boyutları ve filtreleri referansı başlıklı makaleyi inceleyin.

Özel analiz verilerini nasıl toplayabilirim?

Edge, doğal olarak çok sayıda veri toplar. API proxy'lerinize, uygulamalarınıza, ürünlerinize veya geliştiricilerinize özel özel analiz verileri de toplayabilirsiniz. Örneğin, sorgu parametrelerinden, istek üstbilgilerinden, istek ve yanıt gövdelerinden veya API'lerinizde tanımladığınız değişkenlerden analiz verileri toplamak isteyebilirsiniz.

StatisticsCollector politikasını kullanarak özel analiz verileri toplarsınız. Özel veriler ayıklandıktan sonra, verileri incelemek için Analytics kullanıcı arayüzünü veya API'yi kullanabilirsiniz. Özel analiz verilerinin nasıl toplanacağını gösteren tam örnek için Özel analizler kullanarak API mesajı içeriğini analiz etme başlıklı makaleyi inceleyin.

Analytics verileri ile API İzleme verileri arasındaki farklar

Bu bölümde, Edge Analytics ile API İzleme tarafından toplanan veriler arasındaki bazı küçük farklılıklar açıklanmaktadır. API İzleme ve Analytics farklı veri ardışık düzenlerini kullandığından, İzleme tarafından oluşturulan özel raporlar ile Analytics tarafından oluşturulan raporlar arasında küçük farklılıklar görebilirsiniz. Örneğin, hem arka uç zaman aşımı (istekteki HTTP durum kodu 504) hem de istemci zaman aşımı (HTTP durum kodu 499) hataları için raporlanan sonuçlarda tutarsızlıklar görebilirsiniz. Bunlar Analytics özel raporlarında 200 durum koduyla görünebilir ancak İzleme özel raporlarında 504 veya 499 durum koduyla gösterilir.

Analiz verilerim ne zaman ve ne kadar süreyle kullanılabilir?

Analiz verilerinizi ne zaman ve ne kadar süre boyunca görüntüleyebileceğinizi kontrol eden iki zaman aralığı vardır:

  • Veri gecikmesi aralığı: Bir API proxy'sine çağrı yapıldıktan sonra verilerin görüntüleme için veya yönetim API çağrıları aracılığıyla erişilebilir hale gelmesi 10 dakika kadar sürebilir.
  • Veri saklama: Analytics verilerinin saklanacağı süre, abonelik planınıza bağlıdır:
    • Standart: 30 gün
    • Kurumsal: 3 ay
    • Enterprise Plus: 14 ay
    Daha fazla bilgi için Apigee API Yönetimi fiyatlandırması başlıklı makaleyi inceleyin.

Analiz verilerime nasıl erişebilirim?

Edge API Analytics, Edge kullanıcı arayüzüne yerleştirilmiş veri görselleştirme araçları sağlar. Bu araçlar arasında, verileri grafiklerde ve tablolarda gösteren ve farklı boyutlarda (ör. API proxy'sine, IP adresine veya HTTP durum koduna göre) gruplandırılmış verileri görmek için ayrıntılı inceleme yapmanıza olanak tanıyan önceden tanımlanmış analiz kontrol panelleri ve özel raporlar bulunur.

Ayrıca, Edge Management API'yi kullanarak analiz verilerini indirebilirsiniz. İndirilen verileri kendi veri görselleştirme araçlarınıza veya analiz sisteminize aktarabilirsiniz.

Analytics kontrol panelleri

Edge kullanıcı arayüzü, analiz verilerini görüntülemek için kullanabileceğiniz önceden tanımlanmış bir dizi kontrol paneli sunar. Örneğin, aşağıdaki resimlerde Proxy Performansı kontrol paneli gösterilmektedir:

Bu kontrol panelinde aşağıdakiler için grafikler bulunur:

  • Toplam Trafik: Bir kuruluştaki API ortamı için Edge tarafından alınan toplam API isteği sayısı.
  • Trafik Başarısı: Başarılı bir yanıtla sonuçlanan isteklerin toplam sayısı. Hata yanıtları sayılmaz.
  • Trafik Hataları: Başarısız olan tüm API isteklerinin toplam sayısıdır. Yani istek yanıt vermez. Sayı hem Proxy hatalarını (Apigee tarafı) hem de hedef hatalarını (arka uç hizmetleri) içerir.
  • Ortalama TPS: Saniye başına ortalama API isteği ve sonuçlanan yanıt sayısı.

Önceden tanımlanmış diğer kontrol panelleri şunlardır:

Bu önceden tanımlanmış kontrol panelleri hakkında daha fazla bilgi için Analizler kontrol panellerini kullanma başlıklı makaleyi inceleyin.

Özel raporlar

Özel raporlar, belirli API metriklerini ayrıntılı olarak incelemenize ve tam olarak görmek istediğiniz verileri görüntülemenize olanak tanır. Edge'de yerleşik olan analiz verilerinden herhangi birini veya StatisticsCollector politikası tarafından toplanan özel analiz verilerini kullanarak özel bir rapor oluşturabilirsiniz.

Özel rapor oluştururken görmek istediğiniz verileri (metrikler) seçer, verileri anlamlı şekillerde gruplandırır (boyutlar) ve isteğe bağlı olarak döndürülen verileri verilerin belirli özelliklerine göre sınırlandırırsınız (filtreleme).

Özel raporda gösterilen grafik türünü sütun veya çizgi grafiği olarak da ayarlayabilirsiniz. Aşağıdaki resimlerde, API proxy'sine göre gruplandırılmış saniye başına işlem sayısı grafik örnekleri gösterilmektedir:

  • Sütun: Her API proxy'si farklı bir sütunla temsil edilir:

    Özel sütun grafiği

  • Çizgi: Her API proxy'si farklı bir çizgiyle temsil edilir:

    Özel çizgi grafik

Daha fazla bilgi için Özel raporlar oluşturma ve yönetme başlıklı makaleyi inceleyin.

Analytics API

Analiz verilerini indirmek için Edge Management API'yi kullanın. Örneğin, portallara veya özel uygulamalara yerleştirebileceğiniz kendi görselleştirme araçlarınızı oluşturmak için API'yi kullanabilirsiniz.

API proxy'leri için analiz verilerini almak üzere örnek bir API çağrısı:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

Bu çağrı aşağıdaki sonucu döndürür:

  • API proxy'si başına isteklerin toplamı (mesaj sayısı)
  • 24 saat boyunca
  • Saate göre gruplandırılmış

timeRange sorgu parametresi, dönem bilgisini şu biçimde belirtir:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

%20 tarihinden önce HH:MM tarihine dikkat edin. timeRange parametresi için HH:MM'den önce URL kodlu bir boşluk karakteri veya + karakteri gerekir (ör. MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM).

Daha fazla bilgi için API programı performansını ölçmek üzere Metrik API'lerini kullanma başlıklı makaleyi inceleyin.

Analiz verilerini Google Cloud'a aktarma

Edge yönetim API'sini kullanarak Edge'deki bir güne ait tüm analiz verilerini Google Cloud Storage veya BigQuery gibi kendi veri deponuza aktarabilirsiniz. Ardından, kendi veri analizinizi gerçekleştirmek için Google Cloud BigQuery ve TensorFlow'un sunduğu güçlü sorgu ve makine öğrenimi özelliklerinden yararlanabilirsiniz.

Daha fazla bilgi için Analizler'deki verileri dışa aktarma başlıklı makaleyi inceleyin.

Verileri uygulama geliştiricilerle nasıl paylaşırım?

Uygulama geliştiricileri müşterileriniz olarak düşündüğünüzde, API'nizi en iyi şekilde kullanabilmeleri için gerekli araçlara ve bilgilere sahip olduklarından emin olmak istersiniz.

alt_text

Uygulama geliştiriciler yalnızca uygulamalarının kalitesiyle değil, API'lerinizle de ilgilenir. Drupal tabanlı geliştirici portallarında, uygulama geliştiricilerine uygulamalarıyla ilgili önemli metriklere erişim sağlamak için tasarlanmış isteğe bağlı bir Uygulama Performansı sayfası bulunur. Bu sayfada geliştiricilere aşağıdakiler hakkında bilgi verilir:

  • Hatalar: Uygulamam hangi API hatalarını görüyor?
  • Performans: API şu anda yavaş mı? Genellikle yavaş olan veya şu anda yavaş olan API yöntemleri hangileri?
  • Kullanılabilirlik: API şu anda çalışıyor mu yoksa çalışmıyor mu?
  • Kota: API'nizin kotası var mı? Uygulama geliştirici olarak kotayla ilgili durumum nasıl?

Daha fazla bilgi için:

Ayrıca, aşağıdakileri yaparak analizleri geliştiricilerinizle paylaşabilirsiniz:

Tam analiz verilerini nasıl oluşturabilirim?

Tam analizler ne anlama gelir? Örneğin, bir API proxy'si oluşturabilirsiniz. Edge, bu proxy ile ilgili analiz verilerini toplar. Peki API proxy'sini çağıran geliştirici veya uygulamanın metrikleri ne olacak? Edge, API çağrısını kimin yaptığını bilmiyorsa bu verileri toplayamaz.

Edge'in, API proxy'lerinizi hangi geliştiricilerin ve hangi geliştirici uygulamalarının çağırdığını belirlemesi için birkaç adım gerekir. Bu adımların listesini ve daha ayrıntılı bilgilere giden bağlantıları aşağıda bulabilirsiniz:

  1. Bir hizmet planıyla birlikte API proxy'lerinin gruplandırıldığı bir veya daha fazla API ürünü oluşturun. API ürünlerini yönetme başlıklı makaleyi inceleyin.
  2. Edge'e uygulama geliştiricileri kaydedin. Uygulama geliştiricilerini kaydetme başlıklı makaleyi inceleyin.
  3. Uygulamaları kaydedin ve geliştiricileriniz için API anahtarları oluşturun. Uygulama kaydetme ve API anahtarlarını yönetme başlıklı makaleyi inceleyin.
  4. API anahtarlarını ve/veya güvenlik jetonlarını doğrulayan güvenlik politikalarını API proxy'lerinize ekleyin. Aşağıdaki konulara bakın:API anahtarı politikasını doğrulama, OAuthV2 politikası ve JWT politikasını doğrulama.
  5. Edge Microgateway kullanıyorsanız Analytics eklentisini etkinleştirdiğinizden (varsayılan olarak etkindir) emin olun. Analytics eklentisi devre dışı bırakılırsa Edge Microgateway, Edge Analytics'e analiz verileri göndermez.

Aşağıdaki eğitici içerikler, geliştiriciler ve uygulamalarla ilgili analizleri görmenizi sağlayan gerekli adımlarda size yol gösterir: API anahtarlarını zorunlu kılarak API'nin güvenliğini sağlama ve OAuth ile API'nin güvenliğini sağlama.

API Analytics'i API İzleme ile karşılaştırma

Hem Edge API İzleme hem de API Analytics'ten yararlanabilirsiniz. API Monitoring, API performansıyla ilgili gerçek zamanlı bağlamsal analizler sunmak için analiz verilerini inceler. Böylece sorunları hızlı bir şekilde teşhis edebilir ve işletmenizin sürekliliği için düzeltici işlemleri kolaylaştırabilirsiniz. API İzleme, API'leriniz ve arka uçlarınızdaki sorunlu noktaları hızlıca bulmak için tasarlanmıştır. API Analytics, çeşitli farklı ekipler tarafından kullanılmak üzere çok çeşitli analiz verilerini yakalamak için tasarlanmıştır ancak veriler genellikle gerçek zamanlı olmayan senaryolarda analiz için kullanılır.

API İzleme ile API Analytics arasındaki temel farklardan biri, API İzleme'ye yerleştirilmiş uyarı mekanizmasıdır. Uyarıları kullanarak, aşıldığında operasyon ekibinize uyarı bildirimi gönderen bir HTTP durum kodu (2xx/4xx/5xx), gecikme veya hata kodu eşiği belirtirsiniz. Uyarı bildirimleri; e-posta, Slack, çağrı cihazları veya webhook'lar gibi çeşitli kanallar üzerinden gönderilerek sorunlara hemen yanıt vermenizi sağlar.

Bu hizmetler arasındaki farkları daha ayrıntılı bir şekilde karşılaştırmak için API İzleme'yi Edge API Analytics ile karşılaştırma başlıklı makaleyi inceleyin.

Daha fazla bilgi