API Analytics'e genel bakış

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

Bu konuda Edge API Analytics tanıtılmaktadı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'lerinden geçen ç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.

Analizler, aşağıdaki 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 iyi geliştiricilerim kimler?
  • API yanıt süresi ne zaman en hızlıdır? En yavaş mı?
  • Coğrafi olarak en fazla API trafiğini nerede görüyorum?

Bu gibi soruların yanıtları, API'lerinizi iyileştirmenize, sorunları gidermenize ve API programınızla ilgili daha iyi iş kararları vermenize yardımcı olur.

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

Edge API Analytics, verileri sürekli olarak toplayıp analiz ederek ve görselleştirerek API ekibinizin API'lerini, uygulama geliştiricilerin ise uygulamalarını iyileştirmesine yardımcı olur:

alt_text
  • API Ekibi: API ekibi, ilginç API'ler oluşturmak için dahili sistemlerden yararlanır. API ekibi, API programının genel olarak nasıl performans gösterdiğini, tek tek API'lerin nasıl performans gösterdiğini ve API'lerini nasıl iyileştireceğini öğrenmek istiyor.
  • Uygulama geliştiriciler: Analiz bilgilerini uygulama geliştiricilerle paylaşarak daha iyi uygulamalar elde edebilirsiniz. Bu geliştiriciler, API'nizle yenilikler yapıyor ve işletmenize gelir kazandırmaya yardımcı olan yaratıcı uygulamalar geliştiriyor. Analytics, uygulama geliştiricilerin uygulamalarının performansını ve işletmenizin net karına ne kadar katkıda bulunduğunu anlamalarına 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ını ne zaman ekleyeceğini veya diğer kritik düzenlemeleri ne zaman yapacağını tahmin etmek ister.
  • İşletme sahibi: İşletme sahibi, API yatırımının nasıl geri döndüğünü ve gelecekte API'ye ne kadar yatırım yapması gerektiğini görmek istiyor.

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

Edge API Analytics, API proxy'leri arasında akan geniş bir veri yelpazesini toplar ve 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 toplarım?

Edge, yerel olarak çok sayıda veri toplar. Ayrıca API proxy'leriniz, uygulamalarınız, ürünleriniz veya geliştiricilerinizle ilgili özel analiz verileri de toplamak isteyebilirsiniz. Ö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 eksiksiz bir örnek için Özel analizler kullanarak API mesajı içeriğini analiz etme başlıklı makaleyi inceleyin.

Analytics verileri ile API izleme verileri arasındaki farklar

Bu bölümde, Edge Analytics ve API İzleme tarafından toplanan veriler arasındaki bazı küçük farklar açıklanmaktadır. API İzleme ve Analytics farklı veri işlem hatları 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şımları (istekte HTTP durum kodu 504) hem de istemci zaman aşımları (HTTP durum kodu 499) için bildirilen sonuçlarda zaman aşımı hatalarıyla ilgili tutarsızlıklar görebilirsiniz. Bunlar, Analytics özel raporlarında 200 durum koduyla görünebilir ancak izleme özel raporlarında 504 veya 499 durum koduyla gösterilir.

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

Analytics verilerinizi ne zaman ve ne kadar süreyle 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ülenmek üzere veya Management API çağrıları aracılığıyla erişilebilir olması 10 dakika kadar sürebilir.
  • Veri saklama - Analytics verilerinin saklanma süresi, abonelik planınıza bağlıdır:
    • Standart: 30 gün
    • Enterprise: 3 ay
    • Enterprise Plus: 14 ay
    Daha fazla bilgi için Apigee API Yönetimi fiyatlandırması sayfasına bakın.

Analiz verilerime nasıl erişebilirim?

Edge API Analytics, Edge kullanıcı arayüzüne yerleştirilmiş veri görselleştirme araçları sunar. Bu araçlar arasında, verileri grafikler ve tablolarda gösteren önceden tanımlanmış analiz kontrol panelleri ve özel raporlar yer alır. Ayrıca, farklı boyutlara (ör. API proxy'si, IP adresi veya HTTP durum kodu) göre gruplandırılmış verileri görmek için ayrıntılı inceleme yapmanıza olanak tanır.

Ayrıca, Edge Management API'yi kullanarak da 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 bir dizi önceden tanımlanmış kontrol paneli sunar. Örneğin, aşağıdaki resimde Proxy Performansı kontrol paneli gösterilmektedir:

Bu kontrol panelinde şu konularda 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 toplam istek sayısı. Hata yanıtları sayılmaz.
  • Trafik Hataları: Başarısız olan tüm API isteklerinin toplam sayısıdır. Diğer bir deyişle, istek yanıt vermez. Sayıya hem proxy hataları (Apigee tarafı) hem de hedef hataları (arka uç hizmetleri) dahildir.
  • Ortalama TPS: Saniye başına ortalama API isteği ve sonuçlanan yanıt sayısı.

Diğer önceden tanımlanmış kontrol panelleri şunlardır:

Bu önceden tanımlanmış kontrol panelleri hakkında daha fazla bilgi için Analiz 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'e yerleştirilmiş analiz verilerini 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ırabilirsiniz (filtreleme).

Özel raporda gösterilen grafik türünü sütun veya çizgi grafik olarak da ayarlayabilirsiniz. Aşağıdaki resimlerde, saniye başına işlem sayısının API proxy'sine göre gruplandırılmış 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 gösterilir:

    Özel çizgi grafik

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

Analytics API

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

API proxy'leriyle ilgili analiz verilerini almak için kullanılan örnek bir API çağrısını aşağıda bulabilirsiniz:

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ı şu sonucu döndürür:

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

timeRange sorgu parametresi, şu biçimde zaman aralığını belirtir:

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

HH:MM tarihinden önce %20 tarihine dikkat edin. timeRange parametresi, HH:MM öncesinde URL kodlu bir boşluk karakteri veya + karakteri gerektirir. Örneğin: 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

Bir gün boyunca Edge'den Google Cloud Storage veya BigQuery gibi kendi veri deponuza tüm analiz verilerini aktarmak için Edge Management API'yi kullanabilirsiniz. Ardından, kendi veri analizinizi yapmak için Google Cloud BigQuery ve TensorFlow'un sunduğu güçlü sorgu ve makine öğrenimi özelliklerinden yararlanabilirsiniz.

Daha fazla bilgi için Analizlerden veri dışa aktarma başlıklı makaleyi inceleyin.

Uygulama geliştiricilerle nasıl veri paylaşırım?

Uygulama geliştiricileri müşterileriniz olarak gördüğünüzde, API'nizden en iyi şekilde yararlanabilmeleri için gerekli araçlara ve bilgilere sahip olduklarından emin olmak istersiniz.

alt_text

Uygulama geliştiriciler yalnızca uygulamalarının kalitesiyle ilgilenmez, API'lerinize de büyük önem verir. Drupal tabanlı geliştirici portalları, uygulama geliştiricilere uygulamalarıyla ilgili önemli metriklere erişim sağlamak için tasarlanmış isteğe bağlı bir Uygulama Performansı sayfası içerir. Bu sayfada geliştiricilere aşağıdaki konular hakkında bilgi verilmektedir:

  • Hatalar: Uygulamam hangi API hatalarıyla karşılaşıyor?
  • Performans: API şu anda yavaş mı? Hangi API yöntemleri genellikle yavaş veya şu anda yavaş çalışıyor?
  • Kullanılabilirlik: API şu anda çalışıyor mu yoksa kapalı mı?
  • Kota: API'nizin kotası var mı? Uygulama geliştiricisi olarak kotaya göre nasıl bir performans sergiliyorum?

Daha fazla bilgi için:

Ayrıca, analizleri geliştiricilerinizle paylaşmak için:

Nasıl eksiksiz analiz verileri oluşturabilirim?

Eksiksiz analiz ne anlama geliyor? Ö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 uygulamayla ilgili metrikler ne olacak? Edge, API çağrısını kimin yaptığını bilmiyorsa bu verileri toplayamaz.

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

  1. Bir veya daha fazla API ürünü oluşturun. Bu ürünler, API proxy'lerinin bir hizmet planıyla birlikte gruplandırılmasıdır. 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. Uygulamaları kaydetme ve API anahtarlarını yönetme başlıklı makaleye bakın.
  4. API anahtarlarını ve/veya güvenlik jetonlarını doğrulayan API proxy'lerinize güvenlik politikaları ekleyin. Şu konulara bakın:API anahtarı politikasını doğrulama, OAuthV2 politikası ve JWT politikasını doğrulama.
  5. Edge Microgateway kullanıyorsanız, analiz eklentisini etkinleştirdiğinizden (varsayılan olarak etkindir) emin olun. Analytics eklentisi devre dışı bırakılırsa Edge Microgateway, Edge Analytics'e Analytics verileri göndermez.

Aşağıdaki eğitimler, geliştiriciler ve uygulamalarla ilgili analizleri görmenizi sağlayan gerekli adımlar konusunda size yol gösterir: API anahtarları gerektirerek API'nin güvenliğini sağlama ve OAuth ile API'nin güvenliğini sağlama.

API analizlerini API izleme ile karşılaştırma

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

API İzleme ve API Analizleri arasındaki temel farklardan biri, API İzleme'ye yerleştirilmiş uyarı mekanizmasıdır. Uyarılarla, 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önderilebilir. Bu sayede sorunlara anında yanıt verebilirsiniz.

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

Daha fazla bilgi