سياسة مُحصِّل الإحصاءات

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

الموضوع

تتيح لك هذه الميزة جمع الإحصاءات للبيانات في الرسالة، مثل معرِّف المنتج والسعر وإجراء REST وعنوان URL للعميل وعنوان URL المستهدف وطول الرسالة. ويمكن أن تأتي البيانات من متغيّرات التدفق المحدّدة مسبقًا من خلال Apigee أو المتغيرات المخصّصة التي تحدّدها.

يتم تمرير بيانات الإحصاءات إلى خادم الإحصاءات، الذي يحلّل الإحصاءات وينشئ التقارير. يمكنك عرض التقارير باستخدام واجهة مستخدم إدارة Edge أو واجهة برمجة تطبيقات Edge.

عيّنات

مثال أساسي

<StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="productID" ref="product.id" type="string">999999</Statistic>
    <Statistic name="price" ref="product.price" type="string">0</Statistic>
  </Statistics>
</StatisticsCollector>

في هذا المثال، يتم جمع معلومات إحصائية حول متغيّرَين مخصّصَين: product.id وproduct.price. في كل طلب، تكتب سياسة جامع الإحصاءات قيمة هذين المتغيّرين في خادم الإحصاءات.

يحدّد هذا المثال أيضًا قيمة تلقائية اختيارية لكل متغيّر، حيث تكون القيمة التلقائية للسمة product.id هي 999999 وتكون قيمة product.price التلقائية 0. إذا كان المتغيّر غير محدّد ولم تحدّد قيمة تلقائية، لن يتم تسجيل أي بيانات للمتغيّر. إذا حدّدت قيمة تلقائية، سيتم تسجيل القيمة التلقائية عندما يكون المتغيّر غير محدّد.

بعد جمع البيانات الإحصائية، يمكنك استخدام واجهة مستخدم إدارة Edge أو واجهة برمجة التطبيقات لاسترداد الإحصاءات. عند استرداد الإحصاءات، تشير إلى البيانات التي تم جمعها لهذه المتغيّرات مثل productID وprice على التوالي.

الوصول إلى الإحصاءات

في هذا المثال، يتم استخدام واجهة برمجة تطبيقات إدارة Edge لعرض البيانات الإحصائية للمجموعة التي تحمل اسم productID. ينشئ هذا الطلب تقريرًا مخصّصًا لمعرّفات المنتجات استنادًا إلى مجموع عدد الرسائل المُرسَلة لكل معرّف منتج في كل يوم. استبدِل اسم مؤسستك بالمتغيّر {org_name}، واستبدِل عنوان البريد الإلكتروني وكلمة المرور لحسابك على Apigee Edge في email:password.

يمكنك ضبط المعلَمة timeRange لتضمين الفاصل الزمني الذي تم فيه جمع البيانات. يتعذّر تلقائيًا الوصول إلى البيانات التي مرّ عليها أكثر من ستة أشهر من التاريخ الحالي. إذا كنت تريد الوصول إلى البيانات الأقدم من ستة أشهر، يُرجى التواصل مع فريق دعم Apigee Edge.

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/environments/test/stats/productID?"select=sum(message_count)&timeRange=1/19/2015%2000:00~6/21/2015%2000:00&timeUnit=day"
-u email:password

وفي الردّ، يتضمّن حقل name معرّف المنتج وتعرض القيمة عدد الطلبات لكلّ يوم:

{
  "environments" : [ {
    "dimensions" : [ {
      "metrics" : [ {
        "name" : "sum(message_count)",
        "values" : [ {
          "timestamp" : 1353369600000,
          "value" : "4.0"
        } ]
      } ],
      "name" : "52"
    }, {
      "metrics" : [ {
        "name" : "sum(message_count)",
        "values" : [ {
          "timestamp" : 1353369600000,
          "value" : "19.0"
        } ]
      } ],
      "name" : "14"
    }, ...
  } ],
  "metaData" : {
    "samplingRate" : "100"
  }
}

استخراج البيانات للمجموعة

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ExtractVariables async="false" continueOnError="false" enabled="true" name="GetWeatherData">
    <VariablePrefix>weather</VariablePrefix>
    <XMLPayload>
       <Namespaces>
          <Namespace prefix="yweather">http://xml.weather.yahoo.com/ns/rss/1.0</Namespace>
       </Namespaces>
       <Variable name="location" type="string">
          <XPath>/rss/channel/yweather:location/@city</XPath>
       </Variable>
       <Variable name="condition" type="string">
          <XPath>/rss/channel/item/yweather:condition/@text</XPath>
       </Variable>
    </XMLPayload>
</ExtractVariables>

تتطلب سياسة جامع الإحصاءات تخزين البيانات التي تم جمعها في متغيرات. يمكن تحديد هذه المتغيرات مسبقًا من خلال Apigee، أو المتغيرات المخصصة التي تحددها.

في هذا المثال، يتم استخدام سياسة "استخراج المتغيّرات" لاستخراج البيانات من حمولة بيانات XML تتضمّن معلومات عن الطقس. تساعد هذه السياسة في تحقيق ما يلي:

  • لاستخراج اسم المدينة وكتابتها إلى متغير يُسمّى weather.location
  • تستخرج الظروف الحالية وتكتبها إلى متغير باسم weather.condition

يمكنك بعد ذلك استخدام سياسة جامع الإحصاءات لجمع معلومات عن المتغيّرات، كما هو موضّح أدناه:

<StatisticsCollector name="publishPurchaseDetails">
  <Statistics>
    <Statistic name="weatherLocation" ref="weather.location" type="string"></Statistic>
    <Statistic name="weatherCondition" ref="weather.condition" type="string"></Statistic>
  </Statistics>
</StatisticsCollector>

للاطّلاع على برنامج تعليمي كامل يوضّح طريقة استخراج البيانات من حمولة XML لسياسة أداة الحصول على الإحصاءات، يُرجى الاطّلاع على مقالة تحليل محتوى رسالة واجهة برمجة التطبيقات باستخدام الإحصاءات المخصّصة.


لمحة عن سياسة جهة جمع الإحصاءات

عند تنفيذها، تسجِّل سياسة جامع الإحصاءات القيمة الحالية لمتغيّر أو أكثر. يمكن أن تكون هذه المتغيّرات متغيّرات تدفقًا تم تحديدها مسبقًا من خلال Apigee أو متغيّرات مخصّصة تحدّدها. وتتم كتابة هذه البيانات في خادم تحليلات Edge.

للوصول إلى البيانات الإحصائية التي تم جمعها من خلال السياسة، يمكنك استخدام واجهة برمجة تطبيقات Edge أو واجهة مستخدم إدارة Edge. على سبيل المثال، يمكنك استخدام واجهة مستخدم إدارة Edge لإنشاء تقرير مخصّص يعرض البيانات المجمّعة بتنسيقات متنوعة.

للاطّلاع على برنامج تعليمي كامل عن استخدام سياسة جامع الإحصاءات، يُرجى الاطّلاع على مقالة تحليل محتوى رسالة واجهة برمجة التطبيقات باستخدام الإحصاءات المخصّصة.

مواضع وضع السياسة

يمكنك وضع سياسة جامع الإحصاءات في مسار الطلب أو الاستجابة لخادم وكيل لواجهة برمجة التطبيقات. ومع ذلك، إذا وضعت عدة سياسات لـ "جامع الإحصاءات" في خادم وكيل، ستحدد آخر سياسة يتم تنفيذها البيانات المكتوبة إلى خادم الإحصاءات وسيتم فقدان البيانات المكتوبة من قِبل أي من سياسات "جامع الإحصاءات" السابقة.

من السيناريوهات التي قد يكون لديك فيها عدة سياسات لأداة جمع الإحصاءات في خادم وكيل لواجهة برمجة التطبيقات، عندما يكون لديك واحدة في مسار الطلب أو الاستجابة، والأخرى في معالج الأخطاء. وفي حال حدوث خطأ في الخادم الوكيل لواجهة برمجة التطبيقات، ستحدِّد أداة تجميع الإحصاءات في معالج الأخطاء البيانات التي تم جمعها. ويمكنك استخدام أداة تجميع الإحصاءات هذه لتسجيل معلومات عن الخطأ أو لتسجيل أي معلومات أخرى تعتقد أنها ضرورية. يحدد جامع الإحصاءات في معالج الخطأ البيانات التي يتم جمعها بغض النظر عما إذا كان جامع الإحصاءات في الطلب/الاستجابة قد تم تنفيذه من قبل أم لا.

لمزيد من المعلومات، يمكنك الاطّلاع على أخطاء المناولة.

مرجع العنصر

يصف مرجع العناصر عناصر وسمات سياسة جامع الإحصاءات.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatisticsCollector async="false" continueOnError="false" enabled="true" name="Statistics-Collector-1">
    <DisplayName>Statistics Collector 1</DisplayName>
    <Statistics>
        <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
    </Statistics>
</StatisticsCollector>

سمات <StatisticsCollector>

<StatisticsCollector async="false" continueOnError="false" enabled="true" name="Stats-1">

يوضِّح الجدول التالي السمات الشائعة لجميع العناصر الرئيسية للسياسة:

السمة الوصف تلقائي التواجد في المنزل
name

الاسم الداخلي للسياسة وقد تحتوي قيمة السمة name على أحرف وأرقام ومسافات وواصلات وشرطات سفلية ونقاط. لا يمكن أن تتجاوز هذه القيمة 255 حرفًا.

ويمكنك اختياريًا استخدام العنصر <DisplayName> لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الإدارية باستخدام اسم مختلف للغة طبيعية.

لا ينطبق مطلوبة
continueOnError

اضبط القيمة على false لعرض رسالة خطأ عند تعذُّر تنفيذ السياسة. وهو سلوك متوقّع لمعظم السياسات.

اضبط القيمة على true لمواصلة تنفيذ التدفق حتى بعد تعذُّر تنفيذ السياسة.

false إجراء اختياري
enabled

اضبط القيمة على true لفرض السياسة.

اضبط القيمة على false من أجل إيقاف السياسة. ولن يتم فرض السياسة حتى إذا ظلت مرتبطة بمسار.

صحيح إجراء اختياري
async

تم إيقاف هذه السمة نهائيًا.

false منهي العمل به

العنصر <DisplayName>

استخدِم هذه السمة بالإضافة إلى السمة name لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الإدارية باستخدام اسم مختلف بلغة طبيعية.

<DisplayName>Policy Display Name</DisplayName>
تلقائي

لا ينطبق

إذا لم تستخدم هذا العنصر، سيتم استخدام قيمة السمة name الخاصة بالسياسة.

التواجد في المنزل إجراء اختياري
Type سلسلة

عنصر <Statistics>/<Statistic>

<Statistics>
    <Statistic name="statName" ref="varName" type="refDataType">defaultStatValue</Statistic>
</Statistics>
السمة الوصف تلقائي التواجد في المنزل
اسم

الاسم المستخدَم للإشارة إلى البيانات التي تم جمعها للمتغير المحدّد. عند عرض بيانات الإحصاءات، استخدِم هذا الاسم للإشارة إلى البيانات التي تم جمعها حول المتغيّر الذي حدّدته السمة ref.

إذا كان المتغيّر المحدّد من خلال ref غير معرَّف في الطلب أو الاستجابة، تحدّد السمة defaultStatValue القيمة التي تم جمعها للمتغيّر. في حال حذف القيمة التلقائية، لن يتم جمع أي بيانات للمتغيّر عندما يكون المتغيّر غير محدّد.

قيود التسمية

تنطبق قيود التسمية التالية على متغيرات الإحصاءات المخصّصة:

لا ينطبق مطلوبة
المرجع

متغير التدفق الذي تجمع الإحصاءات له. يمكن أن يكون هذا المتغيّر متغيّرًا للتدفق تم تحديده مسبقًا من خلال Apigee أو متغيّرًا مخصّصًا تحدّدها أنت في الخادم الوكيل لواجهة برمجة التطبيقات.

غالبًا ما تشير السمة ref إلى متغيّر مخصّص تم تحديده من خلال سياسة استخراج المتغيرات. اطّلِع على سياسة استخراج المتغيّرات لمزيد من المعلومات.

لا ينطبق مطلوبة
كتابة

تحدد هذه السمة نوع بيانات المتغيّر الذي تحدّده السمة ref. والقيم الصالحة هي: string/integer/float/long/double/boolean.

بالنسبة إلى بيانات نوع السلسلة، يُرجى الإشارة إلى البيانات الإحصائية على أنّها سمة في تقرير مخصّص. بالنسبة إلى أنواع البيانات الرقمية (عدد صحيح/عدد عائم/طويل/مزدوج)، ارجع إلى البيانات الإحصائية في تقرير مخصّص إما على أنّها سمة أو مقياس. الاطّلاع على إدارة التقارير المخصّصة لمزيد من المعلومات

لا يمكن حذف قيمة type إلا إذا كان ref يشير إلى متغيّر تدفق Apigee محدّد مسبقًا أو تم تعريف النوع في حمولة XML لسياسة استخراج المتغيّرات.

سلسلة إجراء اختياري

مرجع الخطأ

يوضِّح هذا القسم رسائل الخطأ ومتغيّرات التدفق التي يتم تحديدها عندما تؤدي هذه السياسة إلى ظهور خطأ. هذه المعلومات مهمة لمعرفة ما إذا كنت تعمل على تطوير قواعد خطأ لخادم وكيل. لمزيد من المعلومات، يمكنك الاطّلاع على المعلومات التي يجب معرفتها عن الأخطاء المتعلقة بالسياسات وأخطاء المعالجة.

أخطاء في وقت التشغيل

بلا عُري

أخطاء النشر

اسم الخطأ السبب إصلاح
UnsupportedDatatype إذا كان نوع المتغيّر الذي حدّدته السمة ref في العنصر <Statistic> ضِمن سياسة جامع الإحصاءات غير متوافق، سيتعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات. وتشمل أنواع البيانات المتوافقة string وinteger وfloat وlong وdouble وboolean.
InvalidName إذا كان الاسم المستخدَم للإشارة إلى البيانات التي تم جمعها للمتغيّر المحدّد والمحدّد ضمن العنصر <Statistic> ضِمن سياسة أداة جمع الإحصاءات يتعارض مع متغيّر من تحديد النظام، سيتعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات. ومن المتغيّرات المعروفة التي يحدّدها النظام organization وenvironment.
DatatypeMissing في حال عدم توفُّر نوع المتغيّر الذي حدّدته السمة ref في العنصر <Statistic> لسياسة أداة جمع الإحصاءات، سيتعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات.

متغيرات الخطأ

بلا عُري

المخطّط

ويتم تحديد كل نوع من أنواع السياسات من خلال مخطّط XML (.xsd). وتتوفّر مخطّطات السياسات كمرجع على GitHub.

مواضيع ذات صلة

يمكنك الاطّلاع على ما يلي للحصول على مزيد من المعلومات: