استخدام Stackdriver Logging وStackdriver Trace مع دوال السحابة

1. مقدمة

في هذا الدرس التطبيقي حول الترميز، ستتعرّف على كيفية الاستفادة من أدوات تسجيل البيانات والمراقبة المتاحة لجميع المطوّرين الذين يعملون باستخدام Cloud Functions. تتوفّر الأدوات مع كل Cloud Function تنشرها في جميع اللغات المتوافقة، ومن المفترض أن تتيح لك زيادة إنتاجيتك عند كتابة وتشغيل الرمز البرمجي بدون خادم.

ستستخدم Cloud Function يتم تشغيلها بواسطة HTTP، ولكن كل ما ستغطّيه ينطبق أيضًا على اللغات الأخرى وعلى Cloud Functions التي يتم تشغيلها بواسطة أحداث أخرى.

2. الإعداد والمتطلبات

إعداد البيئة بالسرعة التي تناسبك

1. سجِّل الدخول إلى Cloud Console وأنشِئ مشروعًا جديدًا أو أعِد استخدام مشروع حالي. (إذا لم يكن لديك حساب على Gmail أو G Suite، عليك إنشاء حساب).

ملاحظة: يمكنك الوصول بسهولة إلى Cloud Console من خلال تذكُّر عنوان URL الخاص بها، وهو console.cloud.google.com.

تذكَّر رقم تعريف المشروع، وهو اسم فريد في جميع مشاريع Google Cloud (الاسم أعلاه مستخدَم حاليًا ولن يكون متاحًا لك، نأسف لذلك). سيتم الإشارة إليه لاحقًا في هذا الدرس التطبيقي حول الترميز باسم PROJECT_ID.

ملاحظة: إذا كنت تستخدم حساب Gmail، يمكنك ترك الموقع الجغرافي التلقائي مضبوطًا على بدون مؤسسة. إذا كنت تستخدم حساب G Suite، اختَر موقعًا جغرافيًا مناسبًا لمؤسستك.

2. بعد ذلك، عليك تفعيل الفوترة في Cloud Console من أجل استخدام موارد Google Cloud.

لن تكلفك تجربة هذا الدرس البرمجي الكثير من المال، إن وُجدت تكلفة على الإطلاق. احرص على اتّباع أي تعليمات في قسم "التنظيف" الذي ينصحك بكيفية إيقاف الموارد حتى لا يتم تحصيل رسوم منك بعد هذا البرنامج التعليمي. يمكن لمستخدمي Google Cloud الجدد الاستفادة من برنامج الفترة التجريبية المجانية بقيمة 300 دولار أمريكي.

Cloud Shell

على الرغم من إمكانية استخدام Cloud Functions وإمكانات تسجيل البيانات والرصد عن بُعد من الكمبيوتر المحمول، ستستخدم Cloud Shell، وهي بيئة سطر أوامر تعمل في Google Cloud.

يتم تحميل هذا الجهاز الظاهري المستند إلى Debian بجميع أدوات التطوير التي تحتاج إليها. توفّر هذه الخدمة دليلًا منزليًا دائمًا بسعة 5 غيغابايت وتعمل في Google Cloud، ما يؤدي إلى تحسين أداء الشبكة والمصادقة بشكل كبير. يعني ذلك أنّ كل ما تحتاج إليه لهذا الدرس التطبيقي حول الترميز هو متصفّح (نعم، يمكن استخدامه على جهاز Chromebook).

1. لتفعيل Cloud Shell من Cloud Console، ما عليك سوى النقر على تفعيل Cloud Shell (يستغرق توفير البيئة والاتصال بها بضع لحظات فقط).

بعد الاتصال بـ Cloud Shell، من المفترض أن يظهر لك أنّه تم إثبات هويتك وأنّ المشروع تم ضبطه على PROJECT_ID.

gcloud auth list

ناتج الأمر

Credentialed accounts:
 - <myaccount>@<mydomain>.com (active)

ملاحظة: تأتي أداة سطر الأوامر gcloud مثبَّتة مسبقًا في Cloud Shell، ومن المؤكّد أنّك ستستفيد من إمكانية إكمال علامات التبويب. لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على أداة سطر أوامر gcloud.

gcloud config list project

ناتج الأمر

[core]
project = <PROJECT_ID>

إذا لم يتم ضبط المشروع لسبب ما، ما عليك سوى تنفيذ الأمر التالي:

gcloud config set project <PROJECT_ID>

هل تبحث عن PROJECT_ID؟ يمكنك الاطّلاع على المعرّف الذي استخدمته في خطوات الإعداد أو البحث عنه في لوحة بيانات Cloud Console:

يضبط Cloud Shell أيضًا بعض متغيرات البيئة تلقائيًا، ما قد يكون مفيدًا عند تنفيذ الأوامر المستقبلية.

echo $GOOGLE_CLOUD_PROJECT

ناتج الأمر

<PROJECT_ID>

2. أخيرًا، اضبط المنطقة التلقائية وإعدادات المشروع.

gcloud config set compute/zone us-central1-f

يمكنك اختيار مجموعة متنوعة من المناطق المختلفة. لمزيد من المعلومات، يُرجى الاطّلاع على المناطق والأقاليم.

ملاحظة: عند تشغيل gcloud على جهازك، يتم الاحتفاظ بإعدادات الضبط في جميع الجلسات. ولكن في Cloud Shell، عليك ضبط ذلك لكل جلسة جديدة أو إعادة اتصال.

3- نشر دالة Cloud بسيطة

للحصول على شيء يمكن مراقبته، أنشئ Cloud Function باسم "Hello, World". في القائمة اليمنى من Google Cloud Console، انقر على Cloud Functions، ثم انقر على إنشاء دالة.

أدخِل "hello-monitor" كاسم لوظيفة Cloud الجديدة.

احتفِظ بجميع الإعدادات التلقائية للرمز المصدر. (ومع ذلك، يمكنك اختيار لغة/وقت تشغيل مختلفَين إذا أردت ذلك).

أخيرًا، انقر على إنشاء.

يجب أن تظهر Cloud Function مع علامة اختيار خضراء بجانبها، ما يعني أنّها جاهزة للاستدعاء.

4. اختبار Cloud Function وإرسال عدد الزيارات باستخدام أداة إنشاء تحميل

بعد نشر Cloud Function بنجاح، اختبِرها من سطر الأوامر.

أولاً، باستخدام Cloud Shell، أصدِر الأمر التالي:

$ gcloud functions describe hello-monitor

من المفترض أن يعرض ذلك وصفًا لوظيفة Cloud، بما في ذلك عنوان URL لـ httpsTrigger، وهو نقطة نهاية HTTP(S) لاستدعاء وظيفة Cloud. يجب أن يبدو على النحو التالي: https://<region>-<project-id>.cloudfunctions.net/hello-monitor.

يجب أن يكون تشغيل Cloud Function الآن بسيطًا مثل استخدام الأمر curl على عنوان URL هذا.

$ curl https://<region>-<project-id>.cloudfunctions.net/hello-monitor
Hello World!

الآن، استخدِم Vegeta، وهي أداة بسيطة لاختبار تحميل HTTP. لتثبيته، ما عليك سوى كتابة الأمر التالي من Cloud Shell :

$ go get -u github.com/tsenart/vegeta

لإرسال بعض الزيارات إلى Cloud Function (خمس طلبات في الثانية لمدّة دقيقتَين)، استخدِم الأمر التالي:

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

5- التنقّل بين السجلّات

من عرض تفاصيل Cloud Function، انقر على عرض السجلات.

من المفترض أن ينقلك ذلك إلى قسم Stackdriver Logging في مشروعك، حيث ستظهر لك سجلات Cloud Function فقط.

يجب أن تعرض جميع الطلبات إلى Cloud Function رمز الحالة 200.

عند عرض السجلات، يمكنك إجراء ما يلي:

• فلترة السجلّ حسب المستوى (في حالتك، جميع السجلّات هي من المستوى debug).
• اختَر إطارًا زمنيًا محدّدًا (نسبيًا أو مطلقًا).
• فعِّل ميزة بث السجلّ (من خلال النقر على تشغيل في أعلى الشاشة).
• انسخ رابطًا إلى إدخال في السجلّ (لمشاركته مع أعضاء الفريق).
• عرض إدخال في السجلّ في سياق المورد
• تثبيت إدخال في السجلّ (كإشارة مرئية)
• تصدير السجلات إلى BigQuery أو Cloud Storage أو Pub/Sub (أو تنزيلها ببساطة كملفات JSON أو CSV)

ملاحظة: في رمز Cloud Functions، ستظهر السجلات في الناتج العادي بمستوى سجلّ __INFO__، وستظهر السجلات في الخطأ العادي بمستوى سجلّ __ERROR__. تحتوي رسائل النظام الداخلية على مستوى السجلّ __DEBUG__.

ملاحظة: باستخدام أداة الاختيار في أعلى يمين الصفحة، يمكنك فلترة السجلات حسب الدالة. يمكنك أيضًا البحث عن التصنيفات أو إجراء بحث عن نص كامل في شريط البحث في أعلى النافذة. في حالتك، تكون التصنيفات hello-monitor (اسم الدالة) ومعرّف التنفيذ لكل طلب.

يمكن أيضًا نسخ الفلاتر لمشاركتها (راجِع القائمة المنسدلة في مربّع البحث).

ملاحظة: بالإضافة إلى هذه الأدوات الرسومية، يمكن أيضًا الوصول إلى سجلات Cloud Function باستخدام gcloud functions logs read، وكذلك من خلال واجهات برمجة التطبيقات الموضّحة هنا.

6. تعديل الدالة

باستخدام Cloud Console، انتقِل إلى عرض تفاصيل الدالة ولاحظ الارتفاع الذي أنشأته باستخدام أداة اختبار التحميل في عدد عمليات الاستدعاء في الثانية ومدة تنفيذها.

هناك أداة أخرى أكثر تفصيلاً لمراقبة وقت الاستجابة وطلبات الإجراءات البعيدة (RPC) وهي Stackdriver Trace، ولكن قبل استخدامها، عليك إجراء بعض التغييرات على Cloud Functions. فعليك إجراء ما يلي:

1. أضِف حزمة node-emoji المنقذة للحياة كعنصر تابع.
2. عدِّل رمز الدالة لاستخدام وحدة node-emoji وإضافة بعض وقت الاستجابة.
3. أضِف متغيّرًا للبيئة لتفعيل Stackdriver Trace في Cloud Functions.

من تفاصيل الدالة، انقر على تعديل لتعديل الدالة.

عدِّل الملف package.json لإضافة تبعية لحزمة node-emoji.

{
  "name": "sample-http",
  "version": "0.0.1",
  "dependencies": {
    "node-emoji": "^1.8.1"
  }
}

عدِّل الدالة الفعلية من خلال تغيير محتوى index.js إلى ما يلي:

const emoji = require('node-emoji');

exports.helloWorld = (req, res) => {
  let message = req.query.message || req.body.message || 'Hello World!';

  // add some latency, functions are too quick!
  setTimeout(function() {
     message += emoji.random().emoji;  
     res.status(200).send(message);
  }, (3 * 100));  // 300ms
  
};

يؤدي ذلك إلى إضافة رمز إيموجي عشوائي إلى الرسالة التي تعرضها "الدالة السحابية" بعد التوقف مؤقتًا لمدة 300 ملي ثانية.

أخيرًا، أضِف متغيّر بيئة Cloud Functions باسم GOOGLE_CLOUD_TRACE_ENABLED وعيّنه على true على النحو التالي:

انقر على حفظ.

ارجع إلى Cloud Shell واسترجِع الأمر لإنشاء بعض الأحمال على Cloud Function التي تم نشرها حديثًا:

$ echo "GET https://<region>-<project-id>.cloudfunctions.net/hello-monitor" \
   | vegeta attack -rate=5 -duration=120s \
   > results.bin

أنت الآن على استعداد لمراقبة قائمة عمليات التتبُّع التي تم إنشاؤها بدون أي متطلبات إعداد أخرى وبدون مكتبة تتبُّع محدّدة في الرمز البرمجي.

7. تتبُّع وظيفة Cloud Function المعدَّلة

باستخدام القائمة اليمنى، انتقِل إلى قائمة عمليات التتبُّع (ضمن Stackdriver Trace).

من المفترض أن يظهر لك شيء مشابه للقطة الشاشة التالية:

من المفترض أن يوضّح ذلك أنّ وقت الاستجابة الذي تم إدخاله في Cloud Function يبلغ 300 ملي ثانية.

تمثّل كل نقطة في الرسم البياني طلبًا يمكنك الاطّلاع على معلومات تفصيلية عنه، مثل الطابع الزمني وطريقة HTTP وحالتها وتصنيفاتها ورابط يؤدي إلى إدخال في السجلّ ذي الصلة وأي استدعاء إجراء عن بُعد (RPC) لاحق تنفّذه "الدالة السحابية".

إذا أردت التكبير، ما عليك سوى النقر والسحب على الرسم البياني.

للتصغير، انقر على التراجع عن التكبير في أعلى الصفحة.

بما أنّك نشرت دالة Cloud واحدة، لا يعرض الرسم البياني سوى GET طلبات على معرّف الموارد المنتظم hello-monitor، ولكن يمكنك فلترة عمليات التتبُّع حسب طريقة HTTP‏ (GET وPOST وDELETE) أو حالة HTTP‏ (2XX و3XX) أو باستخدام فلتر الطلبات.

انتقِل إلى نظرة عامة في القائمة اليمنى:

من صفحة النظرة العامة هذه، يمكنك العثور على عمليات التتبُّع الأخيرة وإحصاءات أخرى.

يمكنك أيضًا العثور على إمكانية إنشاء تقارير مخصّصة استنادًا إلى مجموعة من فلتر طلب معرّف الموارد المنتظم (URI) وطريقة HTTP وحالة HTTP والنطاق الزمني. تتيح لك هذه الميزة أيضًا مقارنة القيم التي تم إنشاؤها بالقيمة الأساسية للوقت.

إذا تمكّنت من إعداد النطاقات الزمنية الصحيحة مع نقاط بيانات كافية، يمكنك إنشاء تقرير يعرض تغييرات مهمة في وقت الاستجابة بين Cloud Function الأول والجديد.

يمكن استخدام تقرير مخصّص من هذا النوع للعثور على وقت حدوث مشكلة في الأداء وتتبُّع مؤشر مستوى الخدمة (SLI)، مثل وقت استجابة طلب المستخدم النهائي.

8. حان وقت تنظيف الموارد

بهذا نكون قد أنهينا الدرس التطبيقي حول الترميز.

على الرغم من أنّ Cloud Functions وأدوات Stackdriver هي منصات للحوسبة بدون خادم لا تتكبّد تكاليف عند عدم استخدامها، ننصحك بحذف Cloud Function. ما عليك سوى النقر على hello-monitor في نظرة عامة ضمن Cloud Functions ثم النقر على حذف.

9. ما هي الخطوات التالية؟

في ما يلي بعض المراجع الإضافية:

• مقاييس مستندة إلى السجلّ في Stackdriver Monitoring
• الإبلاغ عن الأخطاء في Stackdriver

/