عرض بيانات المقاييس باستخدام واجهة برمجة التطبيقات

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

استخدِم واجهات برمجة التطبيقات الموضّحة أدناه للحصول على مقاييس "مراقبة واجهة برمجة التطبيقات". المقاييس هي قيم البيانات المجمّعة من خلال ميزة "مراقبة واجهة برمجة التطبيقات" من البيانات الأولية الواردة في سجلّات "مراقبة واجهة برمجة التطبيقات".

توضّح الأقسام التالية كيفية إدارة المقاييس باستخدام واجهة برمجة التطبيقات.

اطّلِع على Metrics API لمعرفة المزيد عن واجهة برمجة التطبيقات هذه.

للحصول على معلومات عن خيارات cURL المستخدَمة في هذه الأمثلة، اطّلِع على استخدام cURL.

واجهات برمجة التطبيقات للمقاييس

عنوان URL الأساسي الذي تستخدمه لتقديم طلب GET إلى واجهة برمجة التطبيقات "مقاييس Google" هو:

https://apimonitoring.enterprise.apigee.com/metrics/resource

حيث يتوافق resource مع مقياس معيّن. يسرد الجدول التالي مراجع المقاييس:

المرجع الوصف
/traffic الحصول على مقاييس الزيارات يمكنك تحديد فلاتر مثل اسم الخادم الوكيل والفاصل الزمني وفترة الوقت المستهدَف ورمز الحالة وغير ذلك الكثير.
/latency الحصول على مقاييس وقت الاستجابة للطلبات

إلى Edge وإلى استهدافات الخلفية. يمكنك تحديد فلاتر مثل اسم الخادم الوكيل والفاصل الزمني والهدف ورمز الحالة وغيرها الكثير.

/targets الحصول على جميع النطاقات المستهدَفة لمؤسسة وبيئة معيّنتين
/alerthistory الحصول على مقاييس سجلّ التنبيهات لمؤسسة ونطاق زمني محدّدَين
/alertinstance/instanceid الحصول على مقاييس سجلّ التنبيهات لرقم تعريف مثيل التنبيه المحدّد
/alertsummary الحصول على إجمالي عدد التنبيهات لمؤسسة وفترة زمنية
/faultcodenames الحصول على جميع أسماء رموز الخطأ
/faultcodes الحصول على رموز الأعطال
/faultcodecategories الحصول على فئات رموز الأعطال
/faultcodesubcategories الحصول على الفئات الفرعية لرمز الخطأ
/faultcodedetails الحصول على جميع رموز الخطأ مع التفاصيل

الحصول على معلومات عن الخطأ

تعرض جميع موارد /fault* بيانات وصفية عن الأخطاء المحتمَلة في Edge. على سبيل المثال، للاطّلاع على قائمة بجميع فئات الأعطال المحتملة:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/faultcodecategories" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

اضبط $ACCESS_TOKEN على رمز الوصول عبر OAuth 2.0، كما هو موضّح في مقالة الحصول على رمز وصول عبر OAuth 2.0.

يظهر الردّ على النحو التالي:

{
  "faultCodeCategories":[
    "","API Protocol","Developer/App","Extension Policy","Gateway",
    "Mediation Policy","Mint","Security Policy","Sense","Traffic Mgmt Policy"
  ]
}

يمكنك بعد ذلك تحديد قائمة رموز الأعطال لفئة API Protocol:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/faultcodes?faultCodeCategory=API Protocol" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

للاطّلاع على خيارات إضافية، يُرجى الاطّلاع على Metrics API.

تسجيل مقاييس عدد الزيارات ووقت الاستجابة

تتضمّن Metrics API فلاتر يمكنك تطبيقها على واجهة برمجة التطبيقات لتحديد النطاقات الزمنية المخصّصة والخوادم الوكيلة والمناطق والبيئات والفلاتر الأخرى على المقاييس المحسوبة. على سبيل المثال، لعرض مقياس المعاملات في الثانية (tps) كل 10 دقائق للساعة السابقة لجميع البيئات:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=10m&groupBy=env&org=myorg" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

اضبط $ACCESS_TOKEN على رمز الوصول عبر OAuth 2.0، كما هو موضّح في مقالة الحصول على رمز وصول عبر OAuth 2.0.

تُرجع هذه الدعوة النتائج على النحو التالي:

{
  "results":[
    {
      "series":[
        {
          "name":"proxy",
        "tags":
             {
                "env":"prod",
                "intervalSeconds":"60",
                "org":"myorg",
                "region":"myregion"
              },
            "columns":["time","tps"],
            "values":[
              ["2018-08-15T13:10:00Z",5.03],
              ["2018-08-15T13:20:00Z",5.01],
              ["2018-08-15T13:30:00Z",5.81],
              ["2018-08-15T13:40:00Z",5.95],
              …
            ]
          },
       …
       }
    }]
}

لاحظ كيف تحدّد السمة columns تنسيق values. يحتوي الحقل values على عدد عمليات تسجيل الدخول في الثانية التي يتم احتسابها كل 10 دقائق، وذلك للفترة السابقة التي تبلغ 10 دقائق.

تحدِّد مَعلمة طلب البحث interval معدّل تكرار حفظ المقياس في النتائج وفترة أخذ العينات للقيمة في النتائج. في المثال أعلاه، يتم احتساب المقياس على مدار آخر 10 دقائق، ويتم تسجيله في النتائج كل 10 دقائق.

استخدِم مَعلمتَي طلب البحث from وto لتحديد نطاق زمني بتنسيق ISO. الحد الأقصى لمدة البث المحدّد من خلال from وto هو 24 ساعة.

يمكن أن يكون تنسيق التاريخ على النحو التالي:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

على سبيل المثال:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

أو استخدِم مَعلمتَي طلب البحث from وto لتحديد نطاق زمني نسبي، مثلاً للساعة الأخيرة:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

ويمكنك أيضًا استخدام مَعلمة طلب البحث proxy لعرض عدد المعاملات في الثانية (tps) لوكيل نيابة واحد:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/traffic?from=-1h&to=now&select=tps&interval=1m&groupBy=env&org=myorg&proxy=PublicAPI" \
-H "accept: application/json"  \
-H "Authorization: Bearer $ACCESS_TOKEN"

بالنسبة إلى مقاييس وقت الاستجابة، حدِّد العديد من المعايير نفسها المستخدَمة في مقاييس عدد الزيارات. ومع ذلك، بالنسبة إلى المورد /latency:

  • يجب تحديد مَعلمة طلب البحث percentile على أنّها 50 أو 90 أو 95 أو 99. على سبيل المثال، إذا حدّدت 90، ستعرِض واجهة برمجة التطبيقات إجمالي قيمة وقت استجابة الاستجابة في الشريحة المئوية التسعون.
  • يتم ضبط windowsize على دقيقة واحدة.

على سبيل المثال، لعرض مقاييس إجمالي وقت الاستجابة في الشريحة المئوية التسعون لفترة زمنية مدتها دقيقة واحدة:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/latency?percentile=90&select=totalLatency&from=-1h&to=now&interval=5m&windowsize=1m&groupBy=org,env,region&org=myorg" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

للحصول على خيارات إضافية، يُرجى الاطّلاع على Metrics API.

تسجيل المقاييس للتنبيهات

تعرِض Metrics API مقاييس لجميع التنبيهات أو تنبيه معيّن أو ملخّص تنبيه. على سبيل المثال، للحصول على سجلّ التنبيهات لمؤسسة خلال آخر ساعة:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/alerthistory?org=myorg&from=-1h&to=now" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

اضبط $ACCESS_TOKEN على رمز الوصول عبر OAuth 2.0، كما هو موضّح في مقالة الحصول على رمز وصول عبر OAuth 2.0.

يعرض طلب البيانات من واجهة برمجة التطبيقات هذا استجابة بالشكل التالي:

[
  {
"id":"983c4c7a-c301-4697-95cc-9a7c53e05fac",
"organization":"myorg",
"environment":"prod",
"name":"Public Api 5xx error rate",
"type":"Alert",
"source":"https://www.apigee.net/sonar",
"raw_payload":"
{
    \"reportUUID\":\"\",
    \"reportEnabled\":false,
    \"organization\":\"myorg\",
    \"name\":\"Public Api 5xx error rate\",
    \"self\":\"/alerts/95cc9ef4-345f-11e8-9fd3-12774584e062\",
    \"description\":\"\",
    \"conditions\":[
    {
        \"comparator\":\"\u003e\",
        \"metric\":\"rate\",
        \"durationSeconds\":3600,
        \"name\":\"\",
        \"description\":\"\",
        \"threshold\":0.01,
        \"dimensions\":
        {
            \"proxy\":\"myAPI\",
            \"org\":\"myorg\",
            \"env\":\"prod\",
            \"region\":\"myRegion\",
            \"statusCode\":\"5xx\"
            }
        }],
        \"uuid\":\"95cc9ef4-345f-11e8-9fd3-12774584e062\",
    \"playbook\":\"This is a test alert.\"
    }",
"time":"2018-08-14T12:45:28Z"
 },
 …
]

يمكنك بعد ذلك استخدام id في الصفيف الذي تم إرجاعه للحصول على معلومات عن تنبيه معيّن:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/metrics/alertinstance/983c4c7a-c301-4697-95cc-9a7c53e05fac" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

للاطّلاع على خيارات إضافية، يُرجى الاطّلاع على Metrics API.