API Analytics'e genel bakış

Apigee Edge belgelerini görüntülüyorsunuz.
Git: Apigee X belgeleri.
bilgi

Bu konuda, Edge API Analizi 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 akan pek çok bilgiyi toplar ve hesaplar. Bu verileri Edge kullanıcı arayüzündeki grafikler ve tablolar ile görselleştirebilir veya Google Cloud'un ham verileri için kullanarak çevrimdışı analiz yapabilirsiniz.

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 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 sayesinde herkes

Edge API Analytics, kesintisiz bir veri toplama, analiz ve görselleştirme süreci sayesinde, API ekibiniz API'lerini iyileştirir ve uygulama geliştiricilerin uygulamalarını iyileştirmelerine yardımcı olur:

alt_text
  • API Ekibi: API ekibi, ilginç API'ler oluşturmak için dahili sistemlerden yararlanıyor. API ekibi, API programının genel durumunu, API'lerin tek tek durumlarını ve API'lerin nasıl iyileştirileceğini öğrenmek ister.
  • Uygulama Geliştiriciler: Analiz bilgilerini uygulama geliştiriciler ile 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 performansını ve kullanım alanlarını öğrenmelerine yardımcı olur. şirketinizin kârlılığına katkı sağlar. Uygulama geliştiriciler, uygulamalarını nasıl daha iyi hale getireceklerini bilmek ister.
  • Operasyon Ekibi: Operasyon ekibi, trafik kalıplarını ve arka uç kaynaklarını ne zaman eklemeniz veya başka kritik düzenlemeler yapmanız gerektiğini tahmin edebilirsiniz.
  • İşletme Sahibi - İşletme sahibi, diğer işletmelerin API yatırımlarının karşılığını alıyorsunuz ve gelecekte API paralarını nereye yatırılması gerekiyor?

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ı
  • Birçok başka kullanıcı

API Analytics tarafından toplanan verilerin tam listesi için bkz. Analytics metrikleri, boyutları ve filtreleri referansları.

Özel analiz verilerini nasıl toplarım?

Edge, yerel olarak büyük miktarda veri toplar. Ayrıca, isteğe bağlı özel analiz verilerini de toplamak isteyebilirsiniz. API proxy'lerinize, uygulamalarınıza, ürünlerinize veya geliştiricilerinize. Örneğin, analiz verileri toplamak sorgu parametrelerinden, istek başlıklarından, istek ve yanıt gövdelerinden veya API'lerinizde tanımladığınız değişkenlerden.

Özel analiz verilerini İstatistik 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 analizler kullanarak API mesaj içeriğini analiz etme başlıklı makaleyi inceleyin. videosuna göz atın.

Analytics verileri ile API Monitoring verileri arasındaki farklar

Bu bölümde, proje yönetimi ekibi tarafından toplanan veriler arasındaki bazı küçük Edge Analytics ve API Monitoring. API Monitoring ve Analytics, farklı boyutlarda veri ardışık düzenlerinde küçük farklılıklar Monitoring tarafından oluşturulan özel raporlar ile Analiz. Örneğin, bir hafta içinde Zaman aşımı hataları (her iki arka uç zaman aşımı) için raporlanan sonuçlarda tutarsızlıklar (istekte HTTP durum kodu 504) ve istemci zaman aşımları (HTTP durum kodu 499). 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?

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

  • Veri gecikmesi aralığı: API proxy'sine yapılan bir çağrının yapılmasının ardından, çağrının gelmesi Verilerin görüntüleme veya yönetim API çağrıları aracılığıyla erişilebilir olması için 10 dakika.
  • Veri saklama: Analiz verilerinin Edge tarafından saklanma süresi plana göre değişiklik gösterir. Planınıza bağlı olarak analiz verileri son 30, 60, 90 veya 365 gün için kullanılabilir.

Analiz verilerime nasıl erişebilirim?

Edge API Analytics, Edge kullanıcı arayüzünde yerleşik olarak bulunan veri görselleştirme araçları sunar. Bu araçlar şunları içerir: Önceden tanımlanmış analiz kontrol panelleri ile özel raporlar oluşturabilirsiniz. verileri farklı boyutlarda (ör. API proxy'si, IP adresi veya HTTP durum koduna göre) gruplandırılmış olarak görmek için ayrıntılı inceleme yapabilirsiniz.

Ayrıca, Edge Management API'yi kullanarak analiz verilerini indirebilirsiniz. İndirdikten sonra, bu 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 şunlar için grafikler bulunur:

  • Toplam Trafik: Bir kuruluştaki bir 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ıya her iki Proxy hatası da dahildir (Apigee tarafı) ve Hedef hatalar (arka uç hizmetleri).
  • Ortalama TPS: Saniye başına API isteklerinin ve sonuç olarak alınan yanıtların ortalama sayısı.

Önceden tanımlanmış ek kontrol panelleri şunlardır:

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

Özel raporlar

Özel raporlar, belirli API metriklerini ayrıntılı olarak incelemenizi ve tam olarak görmek istediğiniz verileri görüntülemenizi sağlar. 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 grafik olarak da ayarlayabilirsiniz. Aşağıdaki resimlerde, API proxy'sine göre gruplandırılan 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

  • 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, API'yi kullanarak portallara veya özel uygulamalara yerleştirebileceğiniz kendi görselleştirme araçlarınızı oluşturabilirsiniz.

Aşağıda, API proxy'lerine ilişkin analiz verilerini almak için hazırlanmış 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ı şu sonucu döndürür:

  • API proxy'si başına isteklerin (mesaj sayısı) toplamı
  • 24 saatlik bir süre için
  • 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

HH:MM öncesinde %20 olduğunu fark edin. timeRange parametresi için HH:MM öncesinde URL kodlamalı boşluk karakteri veya aşağıdaki gibi bir + karakteri MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Daha fazla bilgi için bkz. API programı performansını ölçmek için metrik API'lerini kullanın.

Analiz verilerini Google Cloud'a aktarın

Edge management API'yi kullanarak bir gündeki tüm analiz verilerini Edge'den dışa aktarabilirsiniz veri deponuza (ör. Google Cloud Storage veya BigQuery) bağlayabilirsiniz. Böylece, Google Ads'in sunduğu güçlü sorgu ve makine öğrenimi özelliklerinden Google Cloud BigQuery ve TensorFlow ile kendi veri analizinizi yapın.

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

Uygulama geliştiricilerle nasıl veri 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.

alternatif_metin

Uygulama geliştiriciler yalnızca uygulamalarının kalitesiyle değil, API'lerinizle de büyük ilgilenirler. 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ğıdaki konular hakkında bilgi verilir:

  • Hatalar: Uygulamam hangi API hatalarını görü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 çalışmıyor mu?
  • Kota: API'nizin bir kotası var mı? Uygulama geliştirici olarak, sipariş edebilir miyiz?

Daha fazla bilgi için:

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

Eksiksiz analiz verilerini nasıl oluşturabilirim?

Tam analiz derken neyi kastediyoruz? Örneğin bir API proxy'si oluşturabilirsiniz. Sonrasında Edge proxy hakkında analiz verilerini toplayabilir. Peki, geliştirici veya uygulama için API proxy'si mi kullanılıyor? Edge, API çağrısını kimin yaptığını bilmiyorsa bu verileri toplayamaz.

Edge'in hangi geliştiricilerin ve geliştirici uygulamalarının API proxy'lerinizi çağırın. Aşağıda, bu adımların daha ayrıntılı bilgi bağlantılarıyla birlikte bir listesi verilmiştir:

  1. Bir veya daha fazla API ürünü oluşturun. Bu ürün, API proxy'leriyle birlikte bir grup olabilir. API ürünlerini yönetme başlıklı makaleyi inceleyin.
  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. Bkz. Uygulamaları kaydetme ve API anahtarlarını yönetme
  4. API proxy'lerinize, API anahtarlarını ve/veya güvenlik jetonlarını doğrulayan güvenlik politikaları ekleyin. Şu konulara göz atı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 emin olun. (varsayılan olarak etkindir). Analiz eklentisi devre dışı bırakılırsa Edge Microgateway, analiz verilerini Edge analizine göndermez.

Aşağıdaki eğiticiler, işletmeniz için analizler görmenize olanak tanıyan gerekli adımlarda size yol gösterir. geliştiriciler ve uygulamalar: API anahtarları zorunlu kılarak bir API'nin güvenliğini sağlama ve OAuth ile API güvenliğini sağlama başlıklı makaleleri inceleyin.

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

HemEdge API Monitoring'den yararlanabilirsiniz. ve API Analizleri. 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 Monitoring, API'lerinizdeki ve arka uçlarınızdaki sorun noktalarını hızlı bir şekilde 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 Monitoring ile API Analytics arasındaki temel farklardan biri, API Monitoring'e entegre edebilirsiniz. Uyarıları kullanarak bir HTTP durum kodu (2xx/4xx/5xx), gecikme veya hata kodu belirtebilirsiniz. eşik aşıldığında Operasyon Ekibinize bir uyarı bildirimi gönderilmesini tetikler. Uyarı bildirimleri; e-posta, Slack, çağrı cihazları veya webhook'lar gibi çeşitli kanallar aracılığıyla gönderilebilir. Bu sayede sorunlara hemen yanıt verebilirsiniz.

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