تحميل بيانات عدد زيارات واجهة برمجة التطبيقات إلى Apigee - الإصدار التجريبي

الإصدار 4.19.01 من Edge for Private Cloud

على جميع عملاء Edge for Private Cloud إرسال إحصاءات واجهة برمجة التطبيقات إلى Apigee. زيارات الخادم الوكيل. تنصح Apigee بأن يحمّل العملاء تلك المعلومات مرة واحدة في اليوم، وربما عن طريق تقوم بإنشاء وظيفة cron.

يجب إرسال البيانات الخاصة بعمليات نشر واجهة برمجة التطبيقات للإنتاج، ولكن ليس لواجهات برمجة التطبيقات قيد التطوير. أو اختبار عمليات النشر في معظم عمليات تثبيت Edge، ستُحدِّد مؤسسات أو بيئات لواجهات برمجة تطبيقات الإنتاج. البيانات التي ترسلها مخصّصة لشركات الإنتاج فقط. المؤسسات والبيئات.

للمساعدة في تحميل هذه البيانات، توفّر Apigee الإصدار التجريبي من سطر الأوامر apigee-analytics-collector. الأخرى. ترسل هذه الأداة تقرير حجم طلبات البيانات من واجهة برمجة التطبيقات إلى Apigee. كل حواف يمكن لتثبيت Private Cloud استخدام هذه الأداة لاسترداد بيانات حركة المرور والإبلاغ عنها إلى Apigee.

الإجراء المطلوب: يُرجى التواصل مع فريق دعم Apigee قبل تحميل البيانات

قبل أن تتمكّن من تحميل البيانات إلى Apigee، عليك التواصل مع Apigee Edge Support لإكمال عملية الإعداد.

تثبيت أداة جمع التحليلات من واجهة برمجة التطبيقات apigee

apigee-analytics-collector الأداة هي قيمة RPM تقوم بتثبيتها باستخدام أداة apigee-service.

مكان التثبيت

يمكن أن تكون العقدة التي يتم تثبيت الأداة apigee-analytics-collector عليها عقدة يمكنها الوصول إلى واجهة برمجة تطبيقات إدارة Edge على خادم إدارة Edge. يمكنك تثبيته مباشرة على خادم الإدارة، أو على عقدة أخرى من تثبيت Edge، أو على قاعدة بيانات طالما أن هذه العقدة يمكنها تقديم طلبات واجهة برمجة التطبيقات إلى خادم الإدارة.

الوصول إلى الإنترنت المتطلبات

ثبِّت أداة apigee-analytics-collector على الجهاز مع اتصال خارجي بالإنترنت. بعد ذلك، يمكن استخدام أداة apigee-analytics-collector لتحميل البيانات مباشرةً إلى Apigee.

في حال لم يكن هناك عقدة تتيح الوصول إلى واجهة برمجة تطبيقات إدارة Edge على خادم إدارة Edge ومع الوصول الخارجي إلى الإنترنت، يمكنك استخدام واجهة برمجة تطبيقات إدارة Edge لحفظ حركة البيانات البيانات محليًا. يجب بعد ذلك نقل البيانات إلى جهاز متصل بالإنترنت لتحميلها إليه Apigee. في هذا السيناريو، لن تحتاج إلى استخدام الأداة apigee-analytics-collector. عرض تحميل البيانات يدويًا إلى يمكنك الاطّلاع على Apigee أدناه لمعرفة مزيد من المعلومات.

تثبيت

استخدِم الأمر التالي لتثبيت الأداة apigee-analytics-collector. لأنّ تثبيت ملف RPM، فيجب تشغيل هذا الأمر عن طريق المستخدم الجذر أو المستخدم الذي الإذن بالوصول الكامل إلى برنامج sudo. للحصول على إمكانية الوصول الكامل إلى برنامج sudo، هذا يعني أنّ المستخدم لديه إذن الوصول إلى برنامج sudo لتنفيذ الإجراء نفسه العمليات كجذر.

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

تشغيل apigee-analytics-collect

يصف هذا القسم كيفية تشغيل أداة apigee-analytics-collector.

ضبط مستخدِم لتشغيل أداة جمع الإحصاءات من واجهة برمجة التطبيقات apigee

يجب تشغيل apigee-analytics-collector بصفته غير جذر المستخدم. يجب أن يكون لدى هذا المستخدم إذن وصول كامل إلى "واجهة برمجة التطبيقات" (apigee) المستخدم.

لتكوين مستخدم لديه إمكانية الدخول الكامل إلى sudo إلى "apigee". استخدم "visudo" أمر موجَّه إلى تعديل ملف sudoers لإضافة ما يلي:

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

حيث analyticsUser هو اسم المستخدم للشخص الذي يدير أداة apigee-analytics-collector.

بعد تثبيت أداة apigee-analytics-collector وتكوين المستخدم، يمكنك اختبار الأداة من خلال تشغيل أمر help أداة apigee-analytics-collector:

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

المعلومات المطلوبة لتشغيل apigee-analytics-collector

ستحتاج إلى المعلومات التالية لتشغيل الأمر apigee-analytics-collector إعادة توجيه البيانات إلى Apigee:

  • apigee_mgmt_api_uri: عنوان URL الأساسي لواجهة Edge API في إدارتك الخادم. يكون عنوان URL عادةً بالتنسيق التالي:
    http://ms_IP:8080/v1

    حيث يكون ms_IP هو عنوان IP أو خادم الإدارة و8080 المنفذ الذي تستخدمه واجهة برمجة تطبيقات Edge. إذا أنشأت إدخال نظام أسماء نطاقات لواجهة برمجة تطبيقات Edge، فسيكون عنوان URL في النموذج:
    http://ms_DNS/v1

    في حال تفعيل بروتوكول أمان طبقة النقل (TLS) على واجهة برمجة التطبيقات لإدارة Edge، سيكون على النحو التالي:
    https://ms_IP:8080/v1
    https://ms_DNS/v1
  • apigee_mgmt_api_email: عنوان البريد الإلكتروني لحساب يمكنه الوصول إلى واجهات برمجة تطبيقات Edge /stats غالبًا ما تتضمن هذه سيكون البريد الإلكتروني لمشرف نظام Edge أو البريد الإلكتروني لمشرف المؤسسة لمؤسسات الإنتاج
  • apigee_mgmt_api_password: كلمة مرور Edge للحساب الذي تم تحديده من خلال apigee_mgmt_api_email.
  • apigee_analytics_client_id وapigee_analytics_secret: بيانات الاعتماد الخاصة بك لتحميل البيانات إلى Apigee يُرجى إرسال تذكرة إلى Apigee Edge Support للحصول على apigee_analytics_client_id وapigee_analytics_secret.

أمثلة على الطلبات

في ما يلي مثال على أمر لاسترداد بيانات حركة المرور لجميع المؤسسات البيئات في تثبيت Edge وتحميل تلك البيانات إلى Apigee. هل لاحظت كيف استخدام apigee-service من أجل شغِّل الأمر apigee-analytics-collector:

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

لاحظ أن الأمر يحتوي على جميع المعلومات المطلوبة، مثل apigee_analytics_client_id و apigee_analytics_secret.

من المفترض أن تظهر لك النتائج في النموذج:

[
  {
    "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
      }
    ]
  }
]

استخدام خيارات سطر الأوامر للأمر للتحكم في إجراءاته. استخدِم الخيارات التالية لتنفيذ ما يلي: تحديد المؤسسات والبيئات المراد تضمينها في البيانات التي تم إنشاؤها:

  • -i، --include_orgs <قائمة العناصر المفصولة بفواصل>
  • -x، --استبعاد_orgs <قائمة العناصر المفصولة بفواصل>
  • -n، --include_envs <قائمة العناصر المفصولة بفواصل>
  • -e، --استبعاد_envs <قائمة العناصر المفصولة بفواصل>

على سبيل المثال، لتحديد مؤسسات وبيئات الإنتاج فقط، استخدم الخيارات -i (أو -include_orgs) و-n (أو --include_envs):

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

في هذا المثال، يمكنك جمع البيانات فقط من بيئة إنتاج myOrg.

لتفريغ البيانات إلى شاشة لفحصها قبل إرسالها إلى Apigee، استخدِم الخيار -S:

>  /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 إلى حذف البيانات. حمِّلها على Apigee. يمكنك بعد ذلك إعادة تشغيل الأمر بدون الخيار -S لإرسال البيانات إلى Apigee.

أحد أسباب استخدام -S حتى تتمكن من عرض أنواع مختلفة من البيانات محليًا. تتطلّب Apigee منك فقط تحميل بيانات عدد زيارات واجهة برمجة التطبيقات، ولكن يتيح لك الخيار -D عرض بيانات عن واجهة برمجة التطبيقات المنتجات أو المطورين أو التطبيقات أو الخوادم الوكيلة لواجهة برمجة التطبيقات. يستخدم المثال أدناه خيارَي -D و-S لعرض بيانات المطوِّرين. محليًا:

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

ضمِّن الخيار -v للحصول على النتائج المطوَّلة، والخيار -R للاطّلاع على أوامر curl التي تم إنشاؤها بواسطة apigee-analytics-collector:

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

يحتوي القسم التالي على قائمة كاملة بخيارات سطر الأوامر.

مَعلمات الأوامر

يسرد الجدول التالي مجموعة كاملة من الخيارات لأداة apigee-analytics-collector:

الأمر

الاستخدام

-h، --مساعدة

معلومات استخدام الناتج

-D، --السمة &lt;dimension&gt;

سمة الزيارات المطلوب جمعها السمات الصالحة: apiproducts وdevs وapps وapiproxy (تلقائية)

-d، --أيام <days>

عدد الأيام الماضية، بدءًا من التاريخ الحالي، للبيانات المطلوب جمعها. تشير رسالة الأشكال البيانية والافتراضية هي 3.

إذا حددت -d، عليك إجراء لا تحدد أيضًا -s -z لضبط وقت النطاق.

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

واجهة برمجة تطبيقات إدارة عنوان URL إلى Edge

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

عنوان البريد الإلكتروني لحساب يمكنه الوصول إلى واجهات برمجة تطبيقات Edge /stats. غالبًا ما يكون هذا هو البريد الإلكتروني لمشرف نظام Edge أو البريد الإلكتروني لمشرف المؤسسة في مؤسسات الإنتاج لديك.

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

كلمة المرور المرتبطة بحساب البريد الإلكتروني الخاص بواجهة برمجة تطبيقات إدارة Edge الذي تم تحديده من خلال -u.

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

قائمة مفصولة بفواصل من المؤسسات المطلوب تضمينها في المخرجات.

-x، --استبعاد_orgs &lt;items&gt;

قائمة مفصولة بفواصل للمؤسسات المطلوب استبعادها من الناتج.

-n، --include_envs &lt;items&gt;

قائمة مفصولة بفواصل للبيئات المطلوب تضمينها في الناتج.

-e، --استبعاد_envs &lt;items&gt;

قائمة مفصولة بفواصل للبيئات المطلوب تضمينها من المخرجات.

-o, --output &lt;path&gt;

المسار واسم الملف لحفظ الناتج.

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

النطاق الزمني لبدء الاستعلام عن إحصاءات حركة المرور، على النحو: "03/01/2016 00:00".

إذا حددت -d، فلا تحدد أيضًا -s و-z لتعيين نطاق زمني.

-z, --time_range_end &lt;time_range_end&gt;

نهاية النطاق الزمني للاستعلام عن إحصاءات حركة المرور، في النموذج: "04/01/2016 24:00".

إذا حددت -d، فلا تحدد أيضًا -s و-z لتعيين نطاق زمني.

-t، --time_unit &lt;time_unit&gt;

الوحدة الزمنية لبيانات حركة المرور. الوحدات التلقائية هي hour. وحدات زمنية صالحة: ثانيًا، دقيقة، ساعة، يوم، أسبوع.

-S، --standard_output

اكتب الناتج في الوحدة الطرفية (stdout)، بدلاً من تحميله على Apigee.

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

رقم التعريف الخاص بك لتحميل البيانات إلى Apigee يُرجى إرسال تذكرة إلى Apigee Edge Support من أجل التي يحصل عليها.

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

الطريقة السرّية لتحميل البيانات إلى Apigee يُرجى إرسال تذكرة إلى Apigee Edge Support من أجل التي يحصل عليها.

-R، --include_curl_commands

أدرِج أوامر cURL التي تم إنشاؤها في الإخراج لتصحيح الأخطاء.

-v، --verbose

عرض النتائج المطوَّلة

تحميل البيانات يدويًا إلى Apigee

تنصح Apigee بتثبيت أداة apigee-analytics-collector على الجهاز مع اتصال خارجي بالإنترنت. بعد ذلك، يمكن استخدام أداة apigee-analytics-collector لتحميل البيانات مباشرةً إلى Apigee.

ومع ذلك، إذا لم يكن للجهاز إمكانية وصول خارجي إلى الإنترنت، فاستخدم واجهة برمجة التطبيقات Edge management API وتجميع بيانات حركة المرور، ثم استخدام أوامر cURL لتحميلها إلى Apigee من جهاز باستخدام الوصول إلى الإنترنت. يتعين عليك تكرار هذه العملية لكل مؤسسة إنتاج جديدة في تثبيت Edge.

يمكنك استخدام أمر cURL التالي لجمع بيانات حركة البيانات لمؤسسة معيَّنة البيئة خلال فترة زمنية محددة:

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"

يستخدم هذا الأمر واجهة برمجة تطبيقات عدد الرسائل في Edge Get API. وفي هذا الأمر:

  • apigee_mgmt_api_email:apigee_mgmt_api_password، يحدد عنوان بريد إلكتروني لحساب لديه إمكانية الوصول إلى واجهات برمجة تطبيقات Edge /stats.
  • &lt;ms_IP&gt; هو عنوان IP أو اسم نظام أسماء النطاقات في Edge. خادم الإدارة.
  • تحدّد {org_name} و{org_name} المؤسسة والبيئة.
  • apiproxy هو البُعد الذي يجمع المقاييس حسب الخوادم الوكيلة لواجهة برمجة التطبيقات.
  • يحدّد MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&amp;timeUnit=hour. النطاق الزمني مقسومًا على وحدات زمنية للمقاييس التي يجب جمعها. لاحظ أن الأمر cURL تستخدم الرمز السداسي %20 للمسافات في النطاق الزمني.

على سبيل المثال، لجمع أعداد رسائل الخادم الوكيل لواجهة برمجة التطبيقات ساعة بساعة على مدار 24 ساعة، يمكنك استخدام السمة تتم متابعة إدارة طلب بيانات من واجهة برمجة التطبيقات يحتوي النطاق الزمني على أحرف مرمّزة في عنوان URL.

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&timeUnit=hour"

من المفترض أن يظهر لك ردّ في النموذج:

{
  "environments" : [ {
    "dimensions" : [ {
      "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"
      } ],
    "name" : "prod"
  } ],
  "metaData" : {
    "errors" : [ ],
    "notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
  }
}

لتحميل تلك البيانات إلى Apigee من جهاز متصل بالإنترنت، استخدِم زر cURL التالي: :

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"...}'

حيث:

  • apigee_analytics_client_id:apigee_analytics_secret بيانات الاعتماد لتحميل البيانات إلى Apigee التي حصلت عليها من Apigee Support.
  • تحدّد السمة {org_name} المؤسسة.
  • يحتوي {"environments"...} على نتائج الأمر cURL الذي التي استخدمتها لجمع الإحصائيات أعلاه.