API Trafik Verilerini Apigee'ye Yükleme - Beta Sürümü

Edge for Private Cloud 4.18.01 sürümü

Tüm Edge for Private Cloud müşterilerinin, API proxy trafiğiyle ilgili istatistikleri Apigee'ye göndermesi gerekir. Apigee, müşterilerin bu bilgileri günde bir kez (ör. bir cron işi oluşturarak) yüklemesini önerir.

Üretim API dağıtımlarınızla ilgili verileri göndermeniz gerekir ancak geliştirme veya test dağıtımlarındaki API'lerle ilgili verileri göndermeniz gerekmez. Çoğu Edge kurulumunda, üretim API'leriniz için belirli kuruluşlar veya ortamlar tanımlarsınız. Gönderdiğiniz veriler yalnızca bu üretim kuruluşları ve ortamları içindir.

Apigee, bu verilerin yüklenmesine yardımcı olmak için apigee-analytics-collector komut satırı yardımcı programının beta sürümünü sunar. Bu yardımcı program, API çağrısı hacmi raporunu Apigee'ye geri gönderir. Özel Bulut için her Edge kurulumu, trafik verilerini alıp Apigee'ye bildirmek için bu yardımcı programı kullanabilir.

apigee-analytics-collector tarafından yüklenen verilere erişme

apigee-analytics-collector yardımcı programıyla veri yükledikten sonra bu verileri Apigee 360'ta görüntüleyebilirsiniz.

Verileri görüntülemek için Apigee 360'a giriş yapın ve Kullanım seçeneğini belirleyin. Kullanım sayfasında, Edge kuruluşlarınızın her biri için bir kullanım grafiği ve kullanım verileri tablosu gösterilir.

apigee-analytics-collector yükleniyor

apigee-analytics-collector yardımcı programı, apigee-service yardımcı programını kullanarak yüklediğiniz bir RPM'dir.

Nereye yüklenir?

apigee-analytics-collector yardımcı programını yüklediğiniz düğüm, Edge Yönetim Sunucusu'ndaki Edge Management API'ye erişebilen herhangi bir düğüm olabilir. Doğrudan Yönetim Sunucusu'na, Edge kurulumunun başka bir düğümüne veya Yönetim Sunucusu'na API istekleri gönderebildiği sürece ayrı bir düğüme yükleyebilirsiniz.

İnternet erişimi gereksinimleri

Harici internet erişimi olan bir makineye apigee-analytics-collector yardımcı programını yükleyin. Ardından apigee-analytics-collector yardımcı programı, verileri doğrudan Apigee'ye yükleyebilir.

Edge Yönetim Sunucusu'nda hem Edge Management API'ye hem de harici internete erişimi olan bir düğüm yoksa trafik verilerini yerel olarak kaydetmek için Edge Management API'yi kullanabilirsiniz. Ardından, Apigee'ye yüklemek için verileri internet erişimi olan bir makineye aktarmanız gerekir. Bu senaryoda apigee-analytics-collector yardımcı programını kullanmanız gerekmez. Daha fazla bilgi için aşağıdaki Apigee'ye manuel olarak veri yükleme bölümünü inceleyin.

Kurulum

apigee-analytics-collector yardımcı programını yüklemek için aşağıdaki komutu kullanın. Bir RPM dosyası yüklediğiniz için bu komutun kök kullanıcı veya tam sudo erişimi olan bir kullanıcı tarafından çalıştırılması gerekir. Tam sudo erişimi, kullanıcının root ile aynı işlemleri gerçekleştirmek için sudo erişimine sahip olduğu anlamına gelir.

> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector install 

apigee-analytics-collector'ı çalıştırma

Bu bölümde, apigee-analytics-collector yardımcı programının nasıl çalıştırılacağı açıklanmaktadır.

apigee-analytics-collector'ı çalıştıracak bir kullanıcıyı yapılandırma

apigee-analytics-collector'ı kök olmayan bir kullanıcı olarak çalıştırmanız gerekir. Bu kullanıcının "apigee" kullanıcısına tam sudo erişimi olmalıdır.

Bir kullanıcıyı "apigee" kullanıcısına tam sudo erişimi olacak şekilde yapılandırmak için "visudo" komutunu kullanarak sudoers dosyasını düzenleyip şunları ekleyin:

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

Burada analyticsUser, apigee-analytics-collector yardımcı programını çalıştıran kişinin kullanıcı adıdır.

apigee-analytics-collector yardımcı programını yükleyip kullanıcıyı yapılandırdıktan sonra apigee-analytics-collector yardımcı programının yardım komutunu çalıştırarak yardımcı programı test edebilirsiniz:

> /opt/apigee/apigee-service/bin/ apigee-service apigee-analytics-collector export traffic --help

apigee-analytics-collector'ı çalıştırmak için gereken bilgiler

apigee-analytics-collector komutunu çalıştırmak ve verileri Apigee'ye yönlendirmek için aşağıdaki bilgilere ihtiyacınız vardır:

• apigee_mgmt_api_uri: Yönetim sunucunuzdaki Edge API'nin ana URL'si. Bu URL genellikle şu biçimdedir:
  http://ms_IP:8080/v1
  
  Burada ms_IP, IP adresi veya Yönetim Sunucunuzdur ve 8080, Edge API tarafından kullanılan bağlantı noktasıdır. Edge API için bir DNS girişi oluşturduysanız URL şu biçimdedir:
  http://ms_DNS/v1
  
  Edge Management API'de TLS'yi etkinleştirirseniz URL şu biçimdedir:
  https://ms_IP:8080/v1
  https://ms_DNS/v1
• apigee_mgmt_api_email: Edge /stats API'lerine erişimi olan bir hesabın e-posta adresi. Bu genellikle Edge sistem yöneticisinin e-posta adresi veya üretim kuruluşlarınızın kuruluş yöneticisinin e-posta adresidir.
• apigee_mgmt_api_password: apigee_mgmt_api_email tarafından belirtilen hesabın Edge şifresi.
• apigee_analytics_client_id ve apigee_analytics_secret: Apigee'ye veri yüklemek için kimlik bilgileriniz. apigee_analytics_client_id ve apigee_analytics_secret değerlerini almak için lütfen Apigee Destek Ekibi'ne destek kaydı gönderin.

Örnek komutlar

Aşağıda, Edge kurulumundaki tüm kuruluşlar ve ortamlar için trafik verilerini alıp bu verileri Apigee'ye yükleyen örnek bir komut gösterilmektedir. apigee-analytics-collector komutunu çalıştırmak için apigee-service'i nasıl kullandığınıza dikkat edin:

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

Komutun, apigee_analytics_client_id ve apigee_analytics_secret gibi gerekli tüm bilgileri içerdiğine dikkat edin.

Sonuçlar şu şekilde görünür:

[
  {
    "org": "myOrg",
    "env": "prod",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  },
  {
    "org": "VALIDATE",
    "env": "test",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  }
]

Komutun işlemlerini kontrol etmek için komut satırı seçeneklerini kullanın. Oluşturulan verilere dahil edilecek kuruluşları ve ortamları belirtmek için aşağıdaki seçenekleri kullanın:

• -i, --include_orgs <comma-separated list of items>
• -x, --exclude_orgs <virgülle ayrılmış liste>
• -n, --include_envs <comma-separated list of items>
• -e, --exclude_envs <virgülle ayrılmış liste>

Örneğin, yalnızca üretim kuruluşlarını ve ortamlarını belirtmek için -i (veya --include_orgs) ve -n (veya --include_envs) seçeneklerini kullanın:

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

Bu örnekte, yalnızca myOrg'un prod ortamından veri toplarsınız.

Verileri Apigee'ye göndermeden önce incelemek üzere bir ekrana aktarmak için -S seçeneğini kullanın:

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

-S seçeneği, Apigee'ye veri yükleme işlemini atlar. Ardından, verileri Apigee'ye göndermek için komutu -S seçeneği olmadan yeniden çalıştırabilirsiniz.

-S seçeneğini kullanmanın bir nedeni, farklı veri türlerini yerel olarak görüntüleyebilmektir. Apigee yalnızca API trafiği verilerini yüklemenizi gerektirir ancak -D seçeneği API ürünleri, geliştiriciler, uygulamalar veya API proxy'leri hakkındaki verileri görüntülemenize olanak tanır. Aşağıdaki örnekte, geliştirici verilerini yerel olarak görüntülemek için -D ve -S seçenekleri kullanılmaktadır:

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -D devs \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

Ayrıntılı çıkış almak için -v seçeneğini, apigee-analytics-collector tarafından oluşturulan curl komutlarını görmek için -R seçeneğini ekleyin:

 >  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -R -v \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

Sonraki bölümde komut satırı seçeneklerinin tam listesi yer alır.

Komut parametreleri

Aşağıdaki tabloda, apigee-analytics-collector yardımcı programının tüm seçenekleri listelenmiştir:

Apigee'ye manuel olarak veri yükleme

Apigee, apigee-analytics-collector yardımcı programını harici internet erişimi olan bir makineye yüklemenizi önerir. Ardından apigee-analytics-collector yardımcı programı, verileri doğrudan Apigee'ye yükleyebilir.

Ancak makinenin harici internet erişimi yoksa trafik verilerini toplamak için Edge Management API'yi kullanın ve ardından internet erişimi olan bir makineden Apigee'ye yüklemek için cURL komutlarını kullanın. Edge kurulumunuzdaki her üretim kuruluşu ve ortamı için bu işlemi tekrarlamanız gerekir.

Belirli bir kuruluş ve ortam için belirli bir zaman aralığındaki trafik verilerini toplamak üzere aşağıdaki cURL komutunu kullanın:

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://<ms_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/stats/apiproxy?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour"

Bu komut, Edge Get API message count API'sini kullanır. Bu komutta:

• apigee_mgmt_api_email:apigee_mgmt_api_password, Edge /stats API'lerine erişimi olan bir hesabın e-posta adresini belirtir.
• <ms_IP>, Edge Yönetim Sunucusu'nun IP adresi veya DNS adıdır.
• {org_name} ve {env_name}, kuruluşu ve ortamı belirtir.
• apiproxy, metrikleri API proxy'lerine göre gruplandıran boyuttur.
• MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour, toplanacak metriklerin zaman birimlerine bölünmüş zaman aralığını belirtir. cURL komutunun, zaman aralığındaki boşluklar için onaltılık kod %20 kullandığına dikkat edin.

Örneğin, 24 saatlik bir süre boyunca saatlik API proxy mesaj sayılarını toplamak için aşağıdaki yönetim API'si çağrısını kullanın. timeRange, URL kodlu karakterler içeriyor.

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/apiproxy?select=sum(message_count)&timeRange=01%2F01%2F2018%2000%3A00~01%2F02%2F2018%2000%3A00"

Aşağıdaki biçimde bir yanıt alırsınız:

{
  "environments" : [ {
    "metrics" : [ {
      "name" : "sum(message_count)",
      "values": [
                {
                  "timestamp": 1514847600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514844000000,
                  "value": "19.0"
                },
                {
                  "timestamp": 1514840400000,
                  "value": "58.0"
                },
                {
                  "timestamp": 1514836800000,
                  "value": "28.0"
                },
                {
                  "timestamp": 1514833200000,
                  "value": "29.0"
                },
                {
                  "timestamp": 1514829600000,
                  "value": "33.0"
                },
                {
                  "timestamp": 1514826000000,
                  "value": "26.0"
                },
                {
                  "timestamp": 1514822400000,
                  "value": "57.0"
                },
                {
                  "timestamp": 1514818800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514815200000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514811600000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514808000000,
                  "value": "66.0"
                },
                {
                  "timestamp": 1514804400000,
                  "value": "50.0"
                },
                {
                  "timestamp": 1514800800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514797200000,
                  "value": "49.0"
                },
                {
                  "timestamp": 1514793600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514790000000,
                  "value": "89.0"
                },
                {
                  "timestamp": 1514786400000,
                  "value": "42.0"
                },
                {
                  "timestamp": 1514782800000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514779200000,
                  "value": "21.0"
                },
                {
                  "timestamp": 1514775600000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514772000000,
                  "value": "20.0"
                },
                {
                  "timestamp": 1514768400000,
                  "value": "12.0"
                },
                {
                  "timestamp": 1514764800000,
                  "value": "7.0"
                }
              ]
            }
          ],
          "name" : "proxy1"
  } ],
  "metaData" : {
    "errors" : [ ],
    "notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
  }
}

Ardından, internet erişimi olan bir makineden bu verileri Apigee'ye yüklemek için aşağıdaki cURL komutunu kullanın:

curl -X POST -H 'Content-Type:application/json' \
-u apigee_analytics_client_id:apigee_analytics_secret \
https://nucleus-api-prod.apigee.com/v1/apigee-analytics-cli-api/traffic/orgs/{org_name}/apis -d '{"environments"...}'

Bu örnekte:

• apigee_analytics_client_id:apigee_analytics_secret, Apigee Destek Ekibi'nden aldığınız, Apigee'ye veri yükleme kimlik bilgilerinizi belirtir.
• {org_name}, kuruluşu belirtir.
• {"environments"...}, yukarıda istatistikleri toplamak için kullandığınız cURL komutunun sonuçlarını içerir.