يساعد هذا القسم مطوري البرامج الذين يرغبون في تطوير التطبيقات باستخدام أدوات مراقبة Dotcom-Monitor.
هناك عدة طرق لعرض بيانات المراقبة والتفاعل معها خارج واجهة موقع Dotcom-Monitor على الويب، بما في ذلك استخدام موجز XML لاستهلاك البيانات والتفاعل مع واجهة برمجة تطبيقات Dotcom-Monitor لمراقبة وتحديث عوامل المراقبة المثبتة.
باستخدام موجز XML ، يمكن للمطورين الاشتراك في البيانات المطلوبة وتقديمها بتنسيقهم الخاص باستخدام تقاريرهم المخصصة. راجع استخدام أداة خدمة تقارير XML (XRS) للحصول على التفاصيل.
يمكن لمستخدمي واجهة برمجة تطبيقات Dotcom-Monitor إنشاء برامج نصية أو تطبيقات مخصصة خاصة بهم للتفاعل مع الإعدادات وعرض البيانات التي تتم مراقبتها في بيئتهم المخصصة. يستخدم نظامنا واجهة برمجة تطبيقات REST التي تتيح التفاعل مع موقع Dotcom-Monitor على الويب برمجيا باستخدام الطرق الأكثر شيوعا للعمل مع البيانات عبر طلبات HTTP (S) (GET ، POST ، PUT ، DELETE). يمكن الوصول إلى جميع كائنات Dotcom-Monitor تقريبا عبر واجهة برمجة تطبيقات REST ويمكن إدارة كل جانب من جوانب وظائف خدمة Dotcom-Monitor تقريبا. باستخدام مكالمات API ، يمكن للمطورين إنشاء الأجهزة والمهام وإزالتها وتأجيلها وتشغيلها وإنشاء وإدارة مجموعات التنبيه والقوالب والفلاتر والمجدولين والحصول على معلومات حالة الجهاز بالإضافة إلى العديد من الخيارات الأخرى.
بشكل عام ، يمكن استخدام واجهة برمجة تطبيقات Dotcom-Monitor في المهام التالية:
- تكامل الطرف الثالث مع حل مراقبة Dotcom-Monitor.
- تنزيل البيانات وتحميلها.
- تعديل البيانات.
الإجراءات الأكثر شيوعا التي يتم تنفيذها عبر واجهة برمجة تطبيقات REST:
- الوصول إلى قوائم منصات المراقبة والأجهزة والأهداف وأجهزة الجدولة والمواقع ومجموعات التنبيه والفلاتر وقوالب التنبيه.
- الوصول إلى معلومات مفصلة عن المنصات والأجهزة والأهداف.
- تحرير الأجهزة والأهداف وأجهزة الجدولة ومجموعات التنبيه والقوالب والفلاتر.
- إنشاء كائن dotcom-Monitor جديد (الأجهزة والأهداف وأجهزة الجدولة وما إلى ذلك).
- إدارة كائنات التدقيق.
واجهة برمجة تطبيقات المجمع المخصص
واجهة برمجة تطبيقات MetricsView المنفصلة هي مجموعة من الطرق لتحميل أي مقاييس من أي مصدر بغض النظر عن النظام الأساسي إلى Dotcom-Monitor inc. لمزيد من المعالجة والتحليل.
يتم تقسيم واجهة برمجة تطبيقات Dotcom-Monitor إلى 10 أنواع من الموارد:
- رصيف: تقع جميع مهام المراقبة في واحدة من خمس منصات مختلفة.
- الاجهزه: الجهاز الخاضع للمراقبة هو “مجموعة” منظمة من مهام المراقبة التي تحتوي إما على مهمة مراقبة واحدة ، أو سلسلة من مهام المراقبة ، أو برنامج نصي للمراقبة يتضمن المهام ، أو مزيج من الثلاثة.
- المهام: المهمة هي أي نشاط مراقبة واحد ، مثل مراقبة هدف (عنوان URL ، خادم البريد ، خادم FTP ، إلخ).
- تردد: يحدد عدد المرات التي سيتم فيها تنفيذ جلسات المراقبة.
- جدوله: يوضح المجدول بالتفصيل متى سيتم تشغيل المهمة أو عدم تشغيلها.
- مكان: موقع مراقبة متاح داخل شبكة المراقبة العالمية Dotcom-Monitor.
- مجموعة التنبيه: يؤدي إعداد مجموعة إلى وضع مستلمي تقرير و/أو تنبيه في مجموعة. يمكن أن يكون لكل مستلم في المجموعة قالب تنبيه فريد.
- قالب التنبيه: يحدد القالب تنسيق التنبيهات.
- راووق: عامل التصفية عبارة عن مجموعة من القواعد، والتي تحدد كيفية معالجة استجابات المراقبة وعرضها.
- مراجعه الحسابات: يوفر معلومات تاريخية عن كل تعديل للحساب.
يجب أن تتم مصادقتك في Dotcom-Monitor قبل أي طلب واجهة برمجة تطبيقات. تنتهي صلاحية المصادقة بعد 60 ثانية من عدم النشاط.
يوضح الجدول أدناه نوع الطلب والإجراء اللذين يدعمهما كل نوع من أنواع الموارد. راجع قسم طرق المراقبة للحصول على أوصاف مفصلة.
| نوع المورد | طريقة الطلب | URI (ق) | وصف |
|---|---|---|---|
| رصيف | حصل | /المنصات | قائمة عودة المنصات المتاحة |
| جهاز | حصل | /الأجهزة/{platform} | احصل على قائمة الأجهزة حسب النظام الأساسي. |
| حصل | /جهاز/{deviceId} | الحصول على معلومات الجهاز | |
| منصب | /الأجهزة?الفعل=PUT | إنشاء جهاز جديد | |
| ضع | /الأجهزة | ||
| منصب | /device//{deviceId}DisableAlert/ | تعطيل التنبيهات | |
| منصب | /جهاز/{deviceId} | تحرير الجهاز | |
| منصب | /device/{deviceId}?verb=delete | حذف الجهاز | |
| حذف | /جهاز/{deviceId} | ||
| مهمة | حصل | /جهاز//{deviceid}مهام | الحصول على قائمة بالمهام ضمن جهاز |
| منصب | /المهام؟الفعل=PUT | إنشاء مهمة جديدة | |
| ضع | /المهام | ||
| حصل | /مهمة/{TaskId} | الحصول على معلومات المهمة | |
| منصب | /مهمة/{TaskId} | تحرير المهمة | |
| منصب | /task/{TaskId}?verb=delete | حذف المهمة | |
| حذف | /مهمة/{TaskId} | ||
| تردد | حصل | /الترددات/{platform_name} | احصل على التردد المتاح. حسب المنصة. |
| جدوله | حصل | /المجدولون | الحصول على قائمة ببرامج الجدولة |
| حصل | /المجدول/{Scheduler_ID} | الحصول على معلومات جدولة محددة | |
| منصب | /المجدولون؟الفعل=PUT | إنشاء جدولة جديدة | |
| ضع | المنظمون | ||
| منصب | /scheduler/{ معرف المجدول} | تحرير المجدول | |
| منصب | /جدول/{Scheduler_Id}?فعل=حذف | حذف المجدول | |
| حذف | /المجدول/{Scheduler_Id} | ||
| مكان | حصل | /المواقع/{platform_name} | الحصول على قائمة بالمواقع المتاحة |
| مجموعة التنبيه | حصل | /المجموعات | الحصول على قائمة بمجموعات التنبيه |
| منصب | /مجموعات?الفعل=PUT/مجموعات | إنشاء مجموعة تنبيه | |
| ضع | مجموعات/مجموعات | ||
| حصل | /المجموعة/{Group_ID} | الحصول على معلومات مجموعة التنبيه | |
| منصب | /المجموعة/{Group_ID} | تحرير مجموعة التنبيه | |
| منصب | /مجموعة/{Group_Id}?فعل=حذف | حذف المجموعة | |
| حذف | المجموعة/{Group_Id} | ||
| قالب التنبيه | حصل | /القوالب | الحصول على قائمة بقوالب التنبيه |
| منصب | /قوالب?الفعل=PUT/قوالب | إنشاء قالب تنبيه جديد | |
| ضع | /قوالب/قوالب | ||
| حصل | /قالب/{Template_ID} | الحصول على معلومات قالب التنبيه | |
| منصب | /قالب/{Template_ID} | تحرير قالب التنبيه | |
| منصب | /قالب/{Template_Id}?فعل=حذف | حذف القالب | |
| حذف | /قالب/{Template_Id} | ||
| راووق | حصل | /الفلاتر | الحصول على قائمة الفلاتر |
| منصب | /المرشحات؟الفعل=PUT | إنشاء فلتر جديد | |
| ضع | /الفلاتر | ||
| حصل | /فلتر/{filter_ID} | الحصول على معلومات فلتر محددة | |
| منصب | /فلتر/{filter_ID} | تعديل الفلتر | |
| منصب | /filter/{filter_ID}?verb=delete | حذف الفلتر | |
| حذف | /فلتر/{filter_ID} | ||
| مراجعه الحسابات | حصل | /التدقيق/القائمة | احصل على قائمة الكائنات التي تم تدقيقها للمستخدم الحالي لآخر 24 ساعة. |
| حصل | /audit/object/{sample ID} | الحصول على محتويات التدقيق للمعرف المحدد | |
| منصب | /التدقيق/القائمة | احصل على قائمة تمت تصفيتها بالكائنات التي تمت مراجعتها. |
-
Web API Monitoring: How to Start and What Approach to Use
قبل أن نبدأ بموضوع مراقبة واجهة برمجة تطبيقات الويب ، دعنا نتحدث بإيجاز عن الأساليب التي تستخدم عادة لتبادل البيانات بين أنواع مختلفة من البرامج.
من الصعب تخيل شركة حديثة حيث تعمل جميع العمليات التجارية على منتج برمجي واحد. بشكل عام ، هناك العديد من تطبيقات سطح المكتب والويب المستخدمة لدعم العمليات التجارية خلال دورة حياتها بأكملها. بعض التطبيقات خارج الصندوق قادرة على التفاعل مع منتجات البرامج ذات الصلة ، في حين أن البعض الآخر يحتاج إلى بعض التكوين الإضافي أو خدمات الجهات الخارجية. على سبيل المثال ، الممارسات الشائعة التي تم إدخالها إلى سوق البرمجيات لدعم تكامل البرامج هي:
- خدمات الويب.
- تبادل الملفات عبر FTP.
- طلبات HTTP غير المنظمة.
- طرق أخرى مثل مقابس الويب والمنافذ المخصصة وما إلى ذلك.
في حين أن جميع أساليب تكامل البرامج الأخرى لا تحتوي على عمليات موحدة لتبادل البيانات ، فإن خدمات الويب توفر طريقة موحدة للتكامل. خدمة الويب هي تقنية تسمح للتطبيقات بالتواصل مع بعضها البعض عبر الشبكة. ببساطة ، خدمة الويب هي عنوان على الإنترنت ، وهو رابط يمكن الوصول إليه للحصول على البيانات أو تنفيذ إجراء. عادة ما تسمى خدمات الويب التي تعمل عبر HTTP واجهة برمجة تطبيقات الويب. ميزة استخدام HTTP كبروتوكول نقل هي أنه يجعل خدمات الويب مستقلة عن لغات البرمجة. في حالة خدمات الويب ، يمكن للعميل الذي يقدم الطلب إلى المورد وخادم API الذي يوفر الاستجابة استخدام أي لغة برمجة أو إطار. بهذه الطريقة لا يهم ما إذا كانت التطبيقات التي نريد توصيلها قد تم تطويرها باستخدام نفس لغات البرمجة أم لا.
عادة ما يتم تنفيذ واجهات برمجة تطبيقات الويب باستخدام التقنيات التالية:
- XML-RPC (استدعاء الإجراء البعيد للغة التوصيف القابلة للتوسعة) – البروتوكول الذي يستخدم HTTP كبروتوكول نقل و XML لترميز المكالمات.
- JSON-RPC (JSON REMOTE PROCEDURE CALL) – تناظرية ل XML-RPC باستثناء الرسائل التي يتم نقلها بتنسيق JSON.
- SOAP (بروتوكول الوصول إلى الكائنات البسيطة) – البروتوكول القياسي الذي يستخدم WSDL (لغة وصف خدمات الويب) استنادا إلى XML لوصف بنية رسالة.
- REST (نقل الحالة التمثيلية) – ليس بروتوكولا ولكنه بنية تفاعل البرامج في شبكة تستند إلى طرق بروتوكول HTTP.
- بروتوكولات متخصصة مصممة للعمل على مهمة محددة، مثل GraphQL الذي يستخدم لإنشاء استعلام إلى خادم واجهة برمجة التطبيقات وتحميل البيانات من واجهة برمجة التطبيقات هذه إلى تطبيق عميل.
ما هي مراقبة واجهة برمجة التطبيقات؟
بمجرد تنفيذ واجهة برمجة تطبيقات الويب لتطبيقك والتفكير في الاستمرار في العمل بشكل عام ، تحتاج إلى التأكد من أن جميع وظائف واجهة برمجة التطبيقات تعمل وفقا لمنطق العمل الخاص بتطبيقك. علاوة على ذلك ، يعد الاحتفاظ بعلامات تبويب على أداء واجهة برمجة تطبيقات الويب أمرا بالغ الأهمية بغض النظر عما إذا كنت مستهلكا لخدمة واجهة برمجة التطبيقات بنفسك أو تقدم الخدمة لتطبيقات الجهات الخارجية. يمكن أن يتسبب أي تدهور في أداء خدمة واجهة برمجة التطبيقات في خسائر كبيرة للشركات ذات الصلة ويؤثر على تجربة المستخدمين.
الغرض الرئيسي من مراقبة واجهة برمجة التطبيقات هو العثور على جميع الأخطاء داخل واجهة برمجة التطبيقات وإصلاحها بشكل استباقي عند حدوثها وحتى قبل أن يلاحظها المستخدمون.
لماذا نحتاج إلى مراقبة واجهة برمجة التطبيقات الخاصة بتطبيق الويب أو موقع الويب الخاص بك؟ لماذا لا يكفي اختبار واجهة المستخدم للتأكد من أن تطبيق الويب الخاص بك يعمل بشكل صحيح؟ اختبار واجهة المستخدم هو حقا أفضل طريقة لمحاكاة سلوك المستخدم الحقيقي (انظر مزايا اختبار تطبيقات الويب في متصفحات حقيقية باستخدام أداة البرمجة النصية Dotcom-Monitor EveryStep). ومع ذلك ، يمكن بالفعل التحقق من وظائف موقع الويب التي نميل إلى مراقبتها من خلال واجهة المستخدم بشكل عام من خلال اختبارات مراقبة واجهة برمجة التطبيقات. على سبيل المثال، تم تغيير استدعاء واجهة برمجة التطبيقات الذي يقوم بتحميل قائمة العناصر الموجودة في المخزون على المتجر عبر الإنترنت على الواجهة الخلفية ولكنه ظل كما هو على واجهة المستخدم وسيفشل النظام في إرجاع القائمة على إجراء المستخدم المقابل على موقع الويب. في هذه الحالة ، ستقوم مراقبة واجهة المستخدم بإرجاع الخطأ ولكن لن يتم اكتشاف المصدر الحقيقي للخطأ (يمكن أن يكون مشكلة في الاتصال ، أو الحمل الزائد للخادم ، أو أخطاء واجهة المستخدم ، أو استدعاء API غير الصحيح ، وما إلى ذلك). على الجانب الآخر ، ستظهر مراقبة واجهة برمجة تطبيقات الويب أن الاستدعاء إلى نقطة نهاية واجهة برمجة التطبيقات المستهدفة لا يعيد الاستجابة. للتحقق من نتيجة استدعاء واجهة برمجة التطبيقات الإضافية ، يمكن استخدام التحقق من صحة محتوى الاستجابة.
كيف تعمل مراقبة واجهة برمجة التطبيقات؟
تركز مراقبة واجهة برمجة تطبيقات الويب على الموارد والوصول إلى هذه الموارد. في واجهة برمجة تطبيقات الويب، تقدم الموارد أنواعا مختلفة من المعلومات. يمكن الوصول إلى الموارد من خلال عناوين URL (مواقع الموارد الموحدة). عند الانتقال إلى عنوان URL معين في متصفحك، يمكنك الاتصال بالمورد الذي يتوافق مع عنوان URL هذا. يحدث الشيء نفسه عند إرسال طلب واجهة برمجة تطبيقات إلى عنوان URL للمورد من تطبيقات مثل Postman أو باستخدام CURL. لتوضيح الإجراء الذي تريد تنفيذه على المورد لخدمة الويب ، يتم استخدام طرق HTTP بما في ذلك GET (قراءة) و POST (إنشاء) و PUT (تحديث) و DELETE (حذف). راجع حمولة REST – كيفية الضغط على واجهة برمجة تطبيقات الويب للحصول على شرح مفصل حول كيفية استخدام Dotcom-Monitor لمراقبة واجهات برمجة تطبيقات RESTful.
سيتبع كل طلب استجابة من خادم واجهة برمجة التطبيقات. الاستجابة هي البيانات التي يتم إرجاعها من واجهة برمجة التطبيقات استجابة للطلب. يمكن للاستجابات إرجاع بيانات مختلفة، بما في ذلك كائن JSON.
يسمى المسار الكامل إلى المورد الذي يتضمن معلمات الطلب ويوفر الوصول إلى المورد نقطة نهاية واجهة برمجة تطبيقات الويب. على سبيل المثال، يمكن أن تبدو نقطة النهاية لإرسال استدعاء واجهة برمجة التطبيقات إليها كما يلي:
http://example.com/wp-json/wp/v2/tests
ببساطة ، نقاط النهاية هي ما نتحقق منه أثناء تنفيذ مكالمات مراقبة واجهة برمجة تطبيقات الويب لمواقعنا وتطبيقاتنا. بشكل عام، تتضمن خطوات مراقبة نقطة نهاية واجهة برمجة التطبيقات ما يلي:
- طلب نقطة نهاية.
- استجابة من خادم واجهة برمجة التطبيقات.
- التحقق من الاستجابة وتحليلها.
فوائد استخدام Dotcom-Monitor كأداة مراقبة واجهة برمجة التطبيقات الخاصة بك
Dotcom-Monitor هو حل شامل يمكن استخدامه لجميع أنواع مراقبة واجهة برمجة تطبيقات الويب (راجع كيفية إعداد مراقبة خدمات ويب SOAP ومراقبة واجهة برمجة تطبيقات الويب REST). إلى جانب مراقبة واجهة برمجة التطبيقات ، يوفر Dotcom-Monitor أدوات مراقبة لتطبيقات الويب ومواقع الويب وصفحات الويب الفردية وخوادم الويب وأنواع أخرى من موارد الويب.
لنقل عملية المراقبة إلى مستوى جديد ، يسمح Dotcom-Monitor للمستخدمين باختبار تطبيقات الويب المستهدفة في نافذة متصفح حقيقية. يضمن الاختبار المستند إلى المتصفح تنفيذ اختبار المراقبة في أقرب وقت ممكن من سيناريو واقعي ويكرر تجربة المستخدم الحقيقية. يمكنك الاختيار من بين عدد من محركات المستعرض لتشغيل تطبيقك أو موقعك على الويب بما في ذلك محركات متصفح سطح المكتب والجوال.
تمنحك تقارير الأداء التفصيلية مع المخططات الانحدارية لكل عنصر على حدة ولقطات الشاشة والفيديو المسجل أثناء جلسات المراقبة فهما كاملا لما يحدث بالضبط خلف مشهد واجهة المستخدم – أي العناصر تبطئ تطبيقك وتسبب الأخطاء والاختناقات في أدائه.
يوفر لك نظام تنبيه Dotcom-Monitor المخصص للغاية خدمة إشعار تنبيه فعالة. يمكن تكوين النظام لإرسال إشعارات تنبيه إلى العناوين المخصصة عند اكتشاف أخطاء أثناء المراقبة. راجع آليات التنبيه المدعومة في مقالة آليات تسليم التنبيه في قاعدة المعارف الخاصة بنا.