راه‌اندازی و ارسال هشدارهای سفارشی به کانال‌های اعلان سفارشی

Firebase هشدارهای پیش‌فرض Crashlytics را ارائه می‌دهد (به صفحه نمای کلی هشدار مراجعه کنید). بااین‌حال، این هشدارهای پیش‌فرض و کانال‌های اعلان آن‌ها ممکن است برای نیازهای شما کافی نباشد.

در این موارد، می‌توانید از Cloud Monitoring برای ارسال هشدارهای سفارشی به کانال‌های اعلان سفارشی براساس داده‌های Crashlytics در Cloud Logging استفاده کنید که به‌طور خودکار به سطل firebase-telemetry برای برنامه‌های وب هدایت می‌شود یا به Cloud Logging برای برنامه‌های تلفن همراه (همراه با داده‌های اختیاری جلسه‌های Firebase) صادر می‌شود.

برای استفاده از Cloud Monitoring برای هشدارهای سفارشی، خط‌مشی هشدار راه‌اندازی می‌کنید، که شرایطی را که می‌خواهید هشدار دریافت کنید و نحوه اطلاع‌رسانی به شما را شرح می‌دهد.

برای مثال، اگر نرخ بدون خرابی شما به زیر آستانه خاصی برسد یا نرخ خطای برنامه وب شما افزایش یابد، Cloud Monitoring می‌تواند پیام هشدار سفارشی‌شده‌ای را به نشانی ایمیل خاصی ارسال کند یا آن را در سرویس شخص ثالثی مانند Discord،‏ Slack،‏ PagerDuty، یا Jira پست کند. همچنین می‌توانید اطلاعات ارسال‌شده در هشدار را کاملاً سفارشی‌سازی کنید، مثلاً پیوندهای عمیق مفید را در کنسول Firebase یا اطلاعات عیب‌یابی مختص شرکت بگنجانید.

در سند Google Cloud، درباره Cloud Monitoring و هشدارها، ازجمله قیمت‌گذاری بیشتر بدانید.

پیش‌نیازها

1. مطمئن شوید پروژه Firebase شما در طرح قیمت‌گذاری Blaze پرداخت به اندازه استفاده باشد.

2. مطمئن شوید گزارش‌های Crashlytics در Cloud Logging دردسترس باشد:

   • برای برنامه‌های تلفن همراه: صادر کردن به Cloud Logging از داده‌های Crashlytics و (اختیاری) داده‌های جلسه‌های Firebase را راه‌اندازی کنید.
   • برای برنامه‌های وب: وقتی Crashlytics را در برنامه وب خود راه‌اندازی می‌کنید، گزارش‌ها به‌طور خودکار به firebase-telemetry (firebasetelemetry.googleapis.com/events) ارسال می‌شوند.

3. کانال‌های اعلان را راه‌اندازی کنید.

راه‌اندازی خط‌مشی هشداردهی

دستورالعمل‌های زیر دستورالعمل‌های سطح بالا هستند؛ برای دستورالعمل‌های دقیق، به Google Cloud اسناد (برای مثال: ایجاد خط‌مشی‌های هشدار آستانه سنجه یا استفاده از PromQL برای ایجاد خط‌مشی‌های هشدار) مراجعه کنید.

به‌عنوان بخشی از اجرای پُرسمان‌ها، می‌توانید هشدار مبتنی بر گزارش یا هشدار مبتنی بر SQL راه‌اندازی کنید:

• راه‌اندازی هشدار مبتنی بر گزارش:

  1. پُرسمانی را در Logs Explorer اجرا کنید.

  2. روی دکمه افزودن هشدار که ظاهر می‌شود کلیک کنید.

  3. برای افزودن هشدار مبتنی بر گزارش، دستورالعمل‌های روی صفحه را دنبال کنید.

• راه‌اندازی هشدار مبتنی بر SQL:

  1. اجرای پُرسمان در تجزیه‌وتحلیل گزارش‌ها.

  2. روی دکمه افزودن هشدار که ظاهر می‌شود کلیک کنید.

  3. برای افزودن هشدار مبتنی بر SQL، دستورالعمل‌های روی صفحه را دنبال کنید.

یا می‌توانید بااستفاده از ابزار پیکربندی خط‌مشی در کنسول Google Cloud، برای سنجه‌های مبتنی بر گزارش خود هشدار تنظیم کنید و یکی از گزینه‌های زیر را انتخاب کنید:

• سازنده: رابط کاربری کنسول گردش کار راهنمایی‌شده‌ای برای ساختن خط‌مشی هشداردهی ارائه می‌دهد.

  مثال: هشدار درباره جهش‌های خطای برنامه وب

  برای برنامه‌های وب، می‌توانید سنجه شمارنده مبتنی بر گزارش را در firebase-telemetry Cloud Logging bucket ایجاد کنید و هشدار آستانه را بااستفاده از Builder پیکربندی کنید:

  1. در کنسول Google Cloud، به ثبت کردن > سنجه‌های مبتنی بر ثبت بروید، و سپس روی ایجاد سنجه کلیک کنید.
  2. شمارنده را به‌عنوان نوع سنجه انتخاب کنید و نامی برای سنجه‌تان انتخاب کنید (برای مثال، web_crashlytics_errors).

  3. در چارگوش ساختن فیلتر، پُرسمان LQL زیر را برای شمارش سوابق خطای وب ورودی وارد کنید:

     logName="projects/PROJECT_ID/logs/firebasetelemetry.googleapis.com%2Fevents"
     severity=ERROR
     

  4. روی ایجاد سنجه کلیک کنید.

  5. از منوِ کنش‌ها (سه نقطه عمودی) سنجه جدیداً ایجادشده، ایجاد هشدار از سنجه را انتخاب کنید.

  6. پنجره غلتان (برای مثال، 5 min) و تابع پنجره غلتان (rate یا count) را تنظیم کنید، بالاتر از آستانه را به‌عنوان نوع شرط انتخاب کنید، و کانال‌های اعلان خود را (مانند ایمیل، Slack،‏ PagerDuty، یا وب‌قلاب‌ها) انتخاب کنید.

• PromQL: پُرسمان PromQL را برای خط‌مشی هشداردهی‌تان ارائه می‌دهید

  نمونه پُرسمان PromQL

  برای مثال، فرض کنید دو سنجه مبتنی بر گزارش برای داده‌های صادرشده Crashlytics و جلسات Firebase ایجاد کرده‌اید:

  • یک سنجه به‌نام firebase/crashlytics_events با برچسب errorType، و به‌صورت زیر تعریف شده است:

    logName="projects/PROJECT_ID/logs/firebasecrashlytics.googleapis.com%2Fevents"

  • سنجه دیگری به‌نام firebase/session_events با برچسب eventType، و به‌صورت زیر تعریف شده است:

    logName="projects/PROJECT_ID/logs/firebasecrashlytics.googleapis.com%2Fsession_events"

  در اینجا نمونه‌ای از پُرسمان PromQL بااستفاده از این سنجه‌های مبتنی بر گزارش برای هشدار دادن در زمانی که نرخ بدون خرابی شما به زیر ۷۰٪ می‌رسد آورده شده است:

  1 - (sum by (project_id) (rate({__name__="logging.googleapis.com/user/firebase/crashlytics_events", errorType="FATAL"}[5m])) /
  sum by (project_id) (rate({__name__="logging.googleapis.com/user/firebase/session_events", eventType="SESSION_START"}[5m]))
  ) < 0.7