API Analytics'e genel bakış

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

Bu konuda Edge API Analizleri 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'leri üzerinden gelen büyük bilgileri toplar ve hesaplar. Bu verileri Edge kullanıcı arayüzünde grafikler ve şemalarla 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 eğilim gösteriyor?
  • En popüler API yöntemleri hangileridir?
  • En iyi geliştiricilerim kimler?
  • API yanıt süresi en hızlı ne zamandı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ı almanıza yardımcı olur.

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

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

alt_text
  • API Ekibi - API ekibi, ilginç API'ler oluşturmak için dahili sistemlerden faydalanıyor. API ekibi, API programının genel olarak nasıl gittiğini, her bir API'nin performansını ve API'lerinin nasıl iyileştirilebileceğini öğrenmek istemektedir.
  • Uygulama Geliştiriciler: Analiz bilgilerini uygulama geliştiricilerle paylaşarak daha iyi uygulamalar elde edersiniz. Bu geliştiriciler, API'nizle yenilikler yapıyor ve kuruluşunuza gelir elde etmenize yardımcı olacak yaratıcı uygulamalar tasarlıyorlar. Analytics, uygulama geliştiricilerin uygulamalarının nasıl performans gösterdiğini ve kuruluşunuzun kârlılığına ne kadar katkıda bulunduklarını anlamalarına yardımcı olur. Uygulama geliştiriciler, uygulamalarını nasıl daha iyi hale getirebileceklerini bilmek isterler.
  • Operasyon Ekibi: Operasyon ekibi, trafik kalıplarını anlamak ve arka uç kaynaklarının ne zaman ekleneceğini ya da diğer kritik ayarlamaların ne zaman yapılacağını öngörmek ister.
  • İşletme Sahibi: İşletme sahibi, API yatırımının karşılığını aldığını ve gelecekte API paralarını nereye yatırması gerektiğini öğrenmek istiyor.

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

Edge API Analytics, API proxy'leri üzerinden akan aşağıdakiler gibi geniş bir veri yelpazesini toplar ve analiz eder:

  • Yanıt süresi
  • İstek gecikmesi
  • İstek boyutu
  • Hedef hataları
  • API ürün adı
  • Geliştiricinin e-posta adresi
  • Uygulama adı
  • Daha pek çok

API Analytics tarafından toplanan verilerin tam listesi için Analytics metrikleri, boyutları ve filtreleri referansı bölümüne bakın.

Özel analiz verilerini nasıl toplayabilirim?

Edge, oldukça fazla veriyi yerel olarak toplar. API proxy'lerinize, uygulamalarınıza, ürünlerinize veya geliştiricilerinize özel özel analiz verileri de toplamak isteyebilirsiniz. Örneğin sorgu parametrelerinden, istek başlıklarından, istek ve yanıt gövdelerinden veya API'lerinizde tanımladığınız değişkenlerden analiz verileri toplamak isteyebilirsiniz.

Özel analiz verilerini İstatistikler Toplayıcı politikasını kullanarak 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 bölümüne bakın.

Analytics verileri ile API İzleme verileri arasındaki farklar

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

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

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

  • Veri gecikme aralığı - Bir API proxy'sine çağrı yapıldıktan sonra verilerin görüntüleme veya management API çağrıları aracılığıyla erişilebilir hale gelmesi 10 dakikayı bulabilir.
  • Veri saklama: Analiz verilerinin Edge tarafından saklandığı süre plana göre değişir. Planınıza bağlı olarak, son 30, 60, 90 veya 365 güne ait analiz verileri kullanılabilir.

Analytics verilerime nasıl erişebilirim?

Edge API Analizleri, Edge kullanıcı arayüzünde yerleşik olarak bulunan veri görselleştirme araçları sağlar. Bu araçlar arasında, verileri grafikler halinde gösteren ve verileri farklı boyutlarda (API proxy'si, IP adresi veya HTTP durum kodu gibi) gruplandırılmış olarak ayrıntılı bir şekilde incelemenizi sağlayan önceden tanımlanmış analiz kontrol panelleri ve özel raporlar bulunur.

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

Analytics gösterge tabloları

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

Bu kontrol panelinde aşağıdakilerle ilgili grafikler yer alır:

  • Toplam Trafik - Kuruluştaki bir API ortamı için Edge tarafından alınan API isteklerinin toplam sayısı.
  • Başarılı Trafik - 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ı; yani istek, yanıt vermez. Bu sayıya hem Proxy hataları (Apigee tarafı) hem de Hedef hataları (arka uç hizmetleri) dahildir.
  • Ortalama TPS: API isteklerinin ve sonuçta ortaya çıkan yanıtların saniye başına ortalama sayısı.

Önceden tanımlanmış ek kontrol panelleri aşağıdakileri içerir:

Önceden tanımlanmış bu kontrol panelleri hakkında daha fazla bilgi için Analiz kontrol panellerini kullanma bölümüne bakın.

Özel raporlar

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

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

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

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

    Özel sütun grafik

  • Satır - Her API proxy'si farklı bir satırla 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.

Aşağıda, API proxy'leri için analiz verilerini almaya yönelik bir API çağrısı örneği verilmiştir:

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

  • API proxy'si başına istek (mesaj sayısı) toplamı
  • 24 saatlik bir süre için
  • Saate göre gruplanmış

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

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

HH:MM öncesine ait %20 dikkat: timeRange parametresi, HH:MM öncesinde URL kodlamalı boşluk karakteri veya MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM gibi bir + karakteri gerektirir.

Daha fazla bilgi için API program performansını ölçmek üzere Metrik API'lerini kullanma bölümüne bakın.

Analiz verilerini Google Cloud'a aktarma

Edge Management API'yi kullanarak bir güne ait tüm analiz verilerini Edge'den Google Cloud Storage veya BigQuery gibi kendi veri deponuza aktarabilirsiniz. Ardından, kendi veri analizlerinizi 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 Analytics'teki verileri dışa aktarma bölümünü inceleyin.

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

Müşteriniz olarak uygulama geliştiricilerini düşündüğünüzde, API'nizden en iyi şekilde faydalanmak için kullanabilecekleri araç ve bilgilere sahip olduklarından emin olmanız gerekir.

alt_text

Uygulama geliştiriciler yalnızca uygulamalarının kalitesiyle değil, API'lerinizle de çok ilgilenirler. Drupal tabanlı geliştirici portalları, uygulama geliştiricilerin uygulamaları için önemli metriklere erişmelerini sağlamak üzere tasarlanmış isteğe bağlı bir Uygulama Performansı sayfası içerir. Bu sayfa, geliştiricilere şu konular hakkında bilgi verir:

  • Hatalar: Uygulamam hangi API hatalarını görüyor?
  • Performans: API şu anda yavaş mı? Şu anda genellikle hangi API yöntemleri yavaş veya yavaş?
  • Kullanılabilirlik: API şu anda çalışır durumda mı yoksa çalışmıyor mu?
  • Kota: API'nizin kotası var mı? Uygulama geliştirici olarak kotayı nasıl kullanırım?

Daha fazla bilgi için:

Ayrıca, analizleri geliştiricilerinizle şu şekilde paylaşabilirsiniz:

Eksiksiz analiz verilerini nasıl oluşturabilirim?

Eksiksiz analiz derken neyi kastediyoruz? Örneğin, bir API proxy'si oluşturduğunuzda Edge bu proxy hakkında analiz verileri toplar. Peki API proxy'si adını veren geliştirici veya uygulamanın metrikleri 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ı bilmesi için birkaç adım gereklidir. Aşağıda, daha ayrıntılı bilgilere bağlantılar içeren bu adımların listesi verilmiştir:

  1. Bir veya daha fazla API ürünü oluşturun. Bu API, hizmet planıyla birlikte API proxy'lerinden oluşan bir gruptur. API ürünlerini yönetme başlıklı makaleye bakın.
  2. Edge'e uygulama geliştiricilerini 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 bölümüne göz atın.
  4. API proxy'lerinize, API anahtarlarını ve/veya güvenlik jetonlarını doğrulayan güvenlik politikaları ekleyin. Şu konuları inceleyin: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 emin olun (bu eklenti varsayılan olarak etkindir). Analiz eklentisi devre dışı bırakılırsa Edge Microgateway, Analytics verilerini Edge analizlerine göndermez.

Aşağıdaki eğiticiler, geliştiriciler ve uygulamalara yönelik analizleri görmenizi sağlayan gerekli adımlarda size yol gösterecektir: API anahtarları zorunlu kılarak API'nin güvenliğini sağlama ve OAuth ile API'nin güvenliğini sağlama.

API Analytics'i API Monitoring ile karşılaştırma

HemEdge API Monitoring hem de API Analytics'ten yararlanabilirsiniz. API Monitoring, analiz verilerini inceleyerek API performansıyla ilgili gerçek zamanlı bağlamsal analizler sağlar. Böylece sorunları hızla teşhis edebilir ve iş sürekliliği için telafi işlemlerini kolaylaştırabilirsiniz. API Monitoring, API'ler ve arka uçlardaki sorunlu noktaları hızlıca bulabilmeniz için tasarlanmıştır. API Analytics, birkaç farklı ekibin 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 Monitoring ile API Analytics arasındaki temel farklardan biri, API Monitoring'de yerleşik olarak bulunan uyarı mekanizmasıdır. Uyarıları kullandığınızda bir HTTP durum kodu (2xx/4xx/5xx), gecikme veya hata kodu eşiği belirtirsiniz ve bu eşik aşıldığında Operasyon Ekibinize bir uyarı bildirimi gönderir. Uyarı bildirimleri e-posta, Slack, çağrı cihazları veya webhook'lar gibi çeşitli kanallar aracılığıyla gönderilebilir. Böylece sorunlara hemen yanıt verebilirsiniz.

Bu hizmetler arasında daha ayrıntılı bir karşılaştırma için API Monitoring'i Edge API Analytics ile karşılaştırma bölümüne bakın.

Daha fazla bilgi