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

Private Cloud için Edge v4.18.01

Tüm Edge for Private Cloud müşterilerinin, API ile ilgili Apigee istatistiklerini göndermeleri gerekir proxy trafiğinden farklıdır. Apigee, müşterilerin bu bilgileri günde bir kez, bazen cron işi oluşturmayı öğrendiniz.

Geliştirme aşamasındaki API'ler için değil, üretim API'si dağıtımlarınız için veri göndermeniz gerekir test etmek anlamına gelir. Ç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ının Beta sürümünü sunar yardımcı olur. Bu yardımcı program, API çağrı hacmi raporunu Apigee'ye geri gönderir. Her Uç Private Cloud yüklemesi, trafik verilerini almak ve raporlamak için bu yardımcı programı kullanabilir Apigee.

Şu kullanıcı tarafından yüklenen verilere erişme: apigee-analytics-collector

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

Verileri görüntülemek için Apigee 360'a giriş yapın ve ardından 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 uygulamasını yükleme

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

Nerede yüklenir?

apigee-analytics-collector yardımcı programını yüklediğiniz düğüm, Edge Yönetim Sunucusu'ndaki Edge yönetim API'sine erişebilen herhangi bir düğüm olabilir. Yükleyebilirsiniz doğrudan Yönetim Sunucusu'nda, Edge kurulumunun başka bir düğümünde veya yalnızca söz konusu düğümün Yönetim Sunucusu'na API istekleri gönderebilmesi gerekir.

İnternet erişimi koşullar

apigee-analytics-collector yardımcı programını harici internet erişimi olan bir makineye yükleyin. Daha sonra apigee-analytics-collector yardımcı programı doğrudan Apigee'ye aktarır.

Hem Edge Yönetim Sunucusu'ndaki Edge yönetim API'sine hem de harici internet erişimine sahip bir düğüm yoksa trafik verilerini yerel olarak kaydetmek için Edge yönetim API'sini kullanabilirsiniz. Ardından, verileri yüklemek için internet erişimi olan bir makineye aktarmanız gerekir. Apigee. Bu senaryoda apigee-analytics-collector yardımcı programını kullanmanız gerekmez. Görüntüleyin Verileri Apigee hakkında daha fazla bilgi edinin.

Kurulum

apigee-analytics-collector yardımcı programını yüklemek için aşağıdaki komutu kullanın. Çünkü bir BGBG dosyası yüklüyorsanız, bu komut kök kullanıcı veya tam sudo erişimi. 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 öğesini çalıştırma

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

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

apigee-analytics-collector kodunu kök olmayan bir belirtir. Bu kullanıcı "Apigee" için tam sudo erişimine sahip olmalıdır belirtir.

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ı uygular.

apigee-analytics-collector yardımcı programını yükledikten sonra yapılandırdıktan sonra, doğrulama işlemini gerçekleştirmek için "help" komutunu çalıştırarak apigee-analytics-collector yardımcı programını oluşturun:

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

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

apigee-analytics-collector komutunu çalıştırmak ve Apigee'ye iletmeniz gerekir:

  • apigee_mgmt_api_uri: Yönetiminizdeki Edge API'nin temel URL'si Sunucu. Bu URL genellikle şu şekildedir:
    http://ms_IP:8080/v1

    Burada ms_IP, yönetim sunucunuzun IP adresidir 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 şuradadır: şu formu kullanın:
    http://ms_DNS/v1

    . TLS'yi Edge management API'de etkinleştirirseniz şu biçimde olur:
    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. Genellikle bu Edge sistem yöneticisinin e-posta adresi veya kuruluş yöneticisinin e-posta adresi olacaktır üretim kuruluşları için.
  • apigee_mgmt_api_password: apigee_mgmt_api_email ile 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 almak için lütfen Apigee Destek Ekibi'ne bir destek kaydı gönderin.

Örnek komutlar

Aşağıda, tüm kuruluşlar ve kuruluşlar için trafik verilerini almaya yönelik bir örnek komut gösterilmektedir: ortamlarında yükleme yapabilir ve bu verileri Apigee'ye yükleyebilirsiniz. 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

Komutta apigee_analytics_client_id ve apigee_analytics_secret gibi gerekli tüm bilgilerin yer aldığını unutmayın.

Sonuçları şu biçimde göreceksiniz:

[
  {
    "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. Aşağıdaki seçenekleri kullanarak oluşturulan verilere dahil edilecek kuruluşları ve ortamları belirtin:

  • -i, --include_orgs <virgülle ayrılmış öğe listesi>
  • -x, --excluded_orgs <virgülle ayrılmış öğe listesi>
  • -n, --include_envs <virgülle ayrılmış öğe listesi>
  • -e, --excluded_envs <virgülle ayrılmış öğe listesi>

Ö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 kuruluşunun 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üklemeyi atlar. Ardından, verileri Apigee'ye göndermek için -S seçeneği olmadan komutu yeniden çalıştırabilirsiniz.

-S seçeneğini kullanmanın bir nedeni, farklı veri türlerini yerel olarak görüntüleyebilmenizdir. Apigee için yalnızca API trafik verilerini yükleyebilirsiniz, ancak -D seçeneği API hakkında veriler görüntüleyebilmenizi sağlar ürünler, geliştiriciler, uygulamalar veya API proxy'leri. Aşağıdaki örnekte, geliştirici verilerini görüntülemek için -D ve -S seçenekleri kullanılmaktadır locally:

>  /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 

Aşağıdakileri almak için -v seçeneğini ekleyin: ayrıntılı çıkış ve -R seçeneği apigee-analytics-collector tarafından oluşturulan curl komutlarını görebilirsiniz:

 >  /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 

Bir 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ına yönelik tüm seçenekler listelenmiştir:

Command

Kullanım

-h, --yardım

Çıkış kullanım bilgileri

-D, --dimension <dimension>

Toplanacak trafik boyutu. Geçerli boyutlar: apiproducts, devs, apps, apiproxy (varsayılan)

-d, --days <days>

Geçerli tarihten itibaren toplanacak verilerin geçmiş gün sayısı. İlgili içeriği oluşturmak için kullanılan varsayılan değer 3'tür.

-d değerini belirtirseniz -s ve Saat ayarlamak için -z aralığı.

-m, --Apigee_mgmt_api_uri &lt;apigee_mgmt_api_uri&gt;

Edge management API'nin URL'si.

-u, --Apigee_mgmt_api_email &lt;apigee_mgmt_api_email&gt;

Edge /stats API'lerine erişimi olan bir hesabın e-posta adresi. Bu çoğu zaman Edge sistem yöneticisinin e-posta adresi veya kuruluş yöneticisinin e-posta adresi üretim kurumlarınız.

-p, --Apigee_mgmt_api_password &lt;apigee_mgmt_api_password&gt;

-u ile belirtilen Edge Management API e-posta hesabıyla ilişkili şifre.

-i, --include_orgs &lt;items&gt;

Çıktıya dahil edilecek kuruluşların virgülle ayrılmış listesi.

-x, --exclude_orgs <items>

Çıkıştan hariç tutulacak kuruluşların virgülle ayrılmış listesi.

-n, --include_envs <items>

Çıktıya dahil edilecek ortamların virgülle ayrılmış listesi.

-e, --exclude_envs <items>

Çıktıya dahil edilecek ortamların virgülle ayrılmış listesi.

-o, --output <path>

Çıkışın kaydedileceği yol ve dosya adı.

-s, --time_range_start &lt;time_range_start&gt;

Trafik istatistiklerinin sorgulanması için başlayacak zaman aralığı: "03/01/2016 00:00".

-d belirtirseniz bir zaman aralığı ayarlamak için -s ve -z değerlerini de belirtmeyin.

-z, --time_range_end <time_range_end>

Trafik istatistiklerini sorgulamak için zaman aralığı bitişi: "04/01/2016 24:00".

-d seçeneğini belirtirseniz zaman aralığı ayarlamak için -s ve -z seçeneklerini de belirtmeyin.

-t, --time_unit &lt;time_unit&gt;

Trafik verileri için zaman birimi. Varsayılan hafta. Saate göre varsayılan birimler. Geçerli zaman birimleri: saniye, dakika, saat, gün, hafta.

-S, --standard_output

Çıktıyı Apigee'ye yüklemek yerine terminale (stdout) yazın.

-c, --Apigee_analytics_client_id &lt;apigee_analytics_client_id&gt;

Apigee'ye veri yüklemek için kullandığınız kimliğiniz. Bu özelliği kullanmak için lütfen Apigee Destek Ekibi'ne bir destek kaydı gönderin.

-r, --Apigee_analytics_secret &lt;apigee_analytics_secret&gt;

Apigee'ye veri yükleme sırrınız. Bu özelliği kullanmak için lütfen Apigee Destek Ekibi'ne bir destek kaydı gönderin.

-R, --include_curl_komutları

Hata ayıklama için oluşturulan cURL komutlarını çıkışa dahil edin.

-v, --verbose

Ayrıntılı çıkışı görüntüleyin.

Apigee'ye manuel olarak veri yükleme

Apigee, apigee-analytics-collector yardımcı programını Harici internet erişimi olan bir makinede. Daha sonra apigee-analytics-collector yardımcı programı doğrudan Apigee'ye aktarır.

Ancak makinenin harici internet erişimi yoksa trafik verilerini toplamak için Edge yönetim API'sini kullanın ve ardından cURL komutlarını kullanarak internet erişimi olan bir makineden Apigee'ye yükleyin. Bu işlemi her üretim kuruluşu için tekrarlamanız ve ortamınızı koruyabilirsiniz.

Belirli bir kuruluş ve ortam için belirli bir zaman aralığında trafik verileri 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 ileti sayısı 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.
  • &lt;ms_IP&gt;, Edge'in IP adresi veya DNS adıdır Yönetim Sunucusu.
  • {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&amp;timeUnit=hour toplanacak metriklerin zaman birimlerine bölünmesi. cURL komutunun, zaman aralığındaki boşluklar için %20 onaltılık kodunu kullandığını unutmayın.

Örneğin, 24 saatlik bir süre boyunca API proxy mesajı sayılarını saatlik olarak toplamak için aşağıdaki yönetim API çağrısını kullanın. timeRange, URL'ye kodlanmış 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"

Formda şu yanıtı görü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, bu verileri internet erişimi olan bir makineden 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:ekip_analytics_secret Apigee Desteği'nden aldığınız verileri Apigee'ye yüklemek için gereken kimlik bilgileridir.
  • {org_name}, kuruluşu belirtir.
  • {"environments"...}, yukarıdaki istatistikleri toplamak için kullandığınız cURL komutunun sonuçlarını içerir.