משתני סביבה - רפרנס
הערה
בכל פעם שמוסיפים או משנים משתני סביבה בקוד/Infra חייבים לעדכן עמוד זה (רפרנס משתני הסביבה) וכן לציין זאת ב-PR. בכך אנו מבטיחים שהמידע הופך ל-Single Source of Truth גם למפתחים וגם לאנשי DevOps.
טבלה מרכזית
משתנה |
תיאור |
חובה |
ברירת מחדל |
דוגמה |
רכיב |
|---|---|---|---|---|---|
|
טוקן הבוט מ-BotFather |
כן |
|
Bot |
|
|
חיבור ל-MongoDB |
כן |
|
Bot/WebApp |
|
|
גודל בריכת חיבורים מקסימלי ל‑MongoDB (maxPoolSize) |
לא |
|
|
Bot/WebApp |
|
גודל בריכת חיבורים מינימלי ל‑MongoDB (minPoolSize) |
לא |
|
|
Bot/WebApp |
|
זמן השהייה מקסימלי בחוסר שימוש (maxIdleTimeMS) |
לא |
|
|
Bot/WebApp |
|
זמן המתנה בתור ה‑Pool לפני כישלון (waitQueueTimeoutMS) |
לא |
|
|
Bot/WebApp |
|
זמן בחירת שרת (serverSelectionTimeoutMS) |
לא |
|
|
Bot/WebApp |
|
זמן קצוב לקריאת/כתיבת שקע (socketTimeoutMS) |
לא |
|
|
Bot/WebApp |
|
זמן קצוב להתחברות (connectTimeoutMS) |
לא |
|
|
Bot/WebApp |
|
הפעלת Retry לכתיבות (retryWrites) |
לא |
|
|
Bot/WebApp |
|
הפעלת Retry לקריאות (retryReads) |
לא |
|
|
Bot/WebApp |
|
שם אפליקציה לצורך Telemetry/Metadata ב‑MongoDB |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
שם בסיס נתונים |
לא |
|
|
Bot/WebApp |
|
מפתח הצפנה ל-Flask/WebApp |
כן (WebApp) |
|
WebApp |
|
|
שם משתמש הבוט |
לא |
|
|
Bot/WebApp |
|
טיימאאוט התחברות ל‑Telegram Bot API (שניות). מעלה סבילות לבעיות רשת קצרות. |
לא |
|
|
Bot |
|
טיימאאוט המתנה ל‑connection מה‑pool (שניות) בעת קריאות ל‑Telegram Bot API. |
לא |
|
|
Bot |
|
טיימאאוט קריאה ל‑Telegram Bot API (שניות). מומלץ שיהיה גבוה מ‑ |
לא |
|
|
Bot |
|
טיימאאוט כתיבה ל‑Telegram Bot API (שניות). |
לא |
|
|
Bot |
|
|
לא |
|
|
Bot |
|
|
לא |
|
|
Bot |
|
זמן המתנה (שניות) לפני retry כאשר מתקבלת שגיאת |
לא |
|
|
Bot |
|
כמה פעמים לנסות שוב (retry) אחרי |
לא |
|
|
Bot |
|
חלון זמן מקסימלי (שניות) לרצף conflicts לפני יציאה מהתהליך (שחרור lock + recovery). |
לא |
|
|
Bot |
|
טוקן GitHub לשימוש בפעולות API וגם לאימות clone/fetch של Repo Sync בריפו פרטי (אם רלוונטי). למינימום הרשאות ראו טבלת Scopes בהמשך. |
לא |
|
Bot/WebApp |
|
|
סוד לאימות GitHub Webhook (HMAC SHA256) עבור |
כן (Repo Sync) |
”“ (ריק) |
|
WebApp |
|
נתיב בסיסי בדיסק לשמירת Bare Mirror של הריפו (Repo Sync Engine) |
לא |
|
|
WebApp |
|
שם ריפו לוגי לשימוש ב-Repo Sync (מפתח ל-mirror בדיסק ול-metadata ב-DB) |
לא |
|
|
WebApp |
|
כתובת ה-WebApp |
לא |
|
WebApp |
|
|
בסיס URL ל-API הפנימי של הבוט (aiohttp) עבור Trigger של Jobs ממסך המוניטור ( |
לא |
|
WebApp |
|
|
Alias/תאימות לאחור ל- |
לא |
|
WebApp |
|
|
הפעלת שלב warmup אוטומטי אחרי עליית Gunicorn ( |
לא |
|
|
WebApp |
|
יעד curl לבדיקת הבריאות הראשונית (ברירת מחדל |
לא |
|
|
WebApp |
|
מספר ניסיונות curl עבור בדיקת הבריאות |
לא |
|
|
WebApp |
|
השהיה בין ניסיונות ה-warmup הראשיים (שניות) |
לא |
|
|
WebApp |
|
בסיס ה-URL לבקשות ה-Frontend Warmup |
לא |
|
|
WebApp |
|
מודול ה-WSGI של Flask עבור Gunicorn (בשימוש |
לא |
|
|
WebApp |
|
מספר ה-workers של Gunicorn ב-WebApp. אם מוגדר, גובר על ברירת המחדל של |
לא |
|
|
WebApp |
|
מספר ה-workers של Gunicorn (חלופה ל- |
לא |
|
|
WebApp |
|
מספר Threads לכל worker כאשר משתמשים ב- |
לא |
|
|
WebApp |
|
Worker class של Gunicorn (ברירת מחדל |
לא |
|
|
WebApp |
|
מספר חיבורים מקסימלי ל-worker כאשר משתמשים ב- |
לא |
|
|
WebApp |
|
Timeout (שניות) לבקשה ב-Gunicorn |
לא |
|
|
WebApp |
|
keep-alive (שניות) לחיבורים ב-Gunicorn |
לא |
|
|
WebApp |
|
הפעלה/כיבוי של Warmup “כבד” לדוחות Observability (למילוי קאש ו‑RAM) ברקע אחרי עליית התהליך |
לא |
|
|
WebApp |
|
השהייה (שניות) לפני תחילת Warmup הדוחות כדי לא להעמיס בזמן העלייה |
לא |
|
|
WebApp |
|
תקציב זמן מקסימלי (שניות) ל‑Warmup הדוחות ברקע; מעבר לתקציב נעצור מוקדם |
לא |
|
|
WebApp |
|
רשימת טווחי זמן (CSV) לחימום |
לא |
|
|
WebApp |
|
ערך |
לא |
|
|
WebApp |
|
שם ה-Collection לתגיות התראות (Manual Alert Tagging) ב-Observability. |
לא |
|
|
WebApp/Observability |
|
אם |
לא |
|
|
WebApp/Observability |
|
כתובת בסיס ציבורית ליצירת קישורי שיתוף |
לא |
”“ (ריק) |
|
WebApp |
|
מתג כללי להצגת רכיב ההכרזות (on/off) |
לא |
|
|
WebApp |
|
הפעלת הרצת קוד (Playground) ב-WebApp ( |
לא |
|
|
WebApp |
|
האם להריץ קוד בתוך Docker sandbox (מומלץ/חובה בפרודקשן) |
לא |
|
|
WebApp |
|
האם לאפשר fallback ל-subprocess (לפיתוח בלבד; בפרודקשן מומלץ |
לא |
|
|
WebApp |
|
timeout מקסימלי להרצת קוד (שניות) |
לא |
|
|
WebApp |
|
זיכרון מקסימלי להרצת קוד (MB) |
לא |
|
|
WebApp |
|
כמות מקסימלית של stdout/stderr (bytes) לפני עצירה/קיצוץ |
לא |
|
|
WebApp |
|
אורך קוד מקסימלי (bytes) שמותר לשלוח להרצה |
לא |
|
|
WebApp |
|
Docker image להרצת קוד (למשל |
לא |
|
|
WebApp |
|
תוקף ברירת מחדל לקישורי שיתוף (ימים) |
לא |
|
|
WebApp |
|
מזהי משתמש טלגרם עם הרשאות אדמין (CSV) |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
טוקן להגנה על נתיבים פנימיים רגישים בשרת ה-aiohttp: |
כן (DB Health) |
”“ (ריק) |
|
Bot/WebApp |
|
סף ברירת מחדל לזיהוי slow queries (באלפיות שנייה) עבור |
לא |
|
|
Bot/WebApp |
|
תדירות רענון מומלצת (שניות) לסטטוס ה-pool בדשבורד. (משתנה תיעודי/קונפיגורציה כללית) |
לא |
|
|
WebApp |
|
תדירות רענון מומלצת (שניות) לרשימת slow queries בדשבורד. (משתנה תיעודי/קונפיגורציה כללית) |
לא |
|
|
WebApp |
|
זמן Cooldown (שניות) בין קריאות ל- |
לא |
|
|
WebApp |
|
מזהי משתמש טלגרם לסטטוס פרימיום (CSV) |
לא |
”“ (ריק) |
|
WebApp |
|
ערך SRI עבור ספריית אייקונים (למשל FontAwesome) |
לא |
”“ (ריק) |
|
WebApp |
|
ספק ניטור (למשל |
לא |
”“ (ריק) |
|
WebApp |
|
מפתח API לשירות הניטור (אם רלוונטי) |
לא |
”“ (ריק) |
|
WebApp |
|
מזהה מוניטור |
לא |
”“ (ריק) |
|
WebApp |
|
קישור לעמוד סטטוס ציבורי |
לא |
”“ (ריק) |
|
WebApp |
|
כתובת סקריפט הווידג’ט לעמודי סטטוס |
לא |
|
|
WebApp |
|
מזהה ווידג’ט (data-id) |
לא |
”“ (ריק) |
|
WebApp |
|
TTL למטמון תוצאות Uptime |
לא |
|
|
WebApp |
|
מפתח ציבורי ל‑Web Push (VAPID) |
לא |
”“ (ריק) |
|
WebApp |
|
מפתח פרטי ל‑Web Push (VAPID) |
לא |
”“ (ריק) |
|
WebApp |
|
Subject (דוא“ל) לתביעות VAPID |
לא |
”“ (ריק) |
|
WebApp |
|
הפעלת שליחת Web Push (רקע) |
לא |
|
|
WebApp |
|
שליחה דרך Worker חיצוני (במקום pywebpush) |
לא |
|
|
WebApp |
|
כתובת בסיס ל‑Worker (ללא |
לא |
”“ (ריק) |
|
WebApp |
|
טוקן Bearer לאימות שרת→Worker |
לא |
”“ (ריק) |
|
WebApp/Worker |
|
Timeout לבקשת |
לא |
|
|
WebApp |
|
פורט פנימי ל‑Sidecar Worker (localhost בלבד) |
לא |
|
|
WebApp/Worker |
|
מפתח ציבורי ל‑VAPID עבור ה‑Worker (Sidecar) |
לא |
”“ (ריק) |
|
Worker |
|
מפתח פרטי ל‑VAPID עבור ה‑Worker (Sidecar) |
לא |
”“ (ריק) |
|
Worker |
|
Subject (דוא“ל) לתביעות VAPID עבור ה‑Worker |
לא |
|
|
Worker |
|
תוקף התחברות מתמשכת (ימים) |
לא |
|
|
WebApp |
|
פורט להרצת ה-WebApp |
לא |
|
|
WebApp |
|
מצב דיבאג ל-WebApp |
לא |
|
|
WebApp |
|
חיבור ל-Redis (cache) |
לא |
|
Bot |
|
|
Timeout התחברות ל-Redis (שניות) |
לא |
|
|
Bot/WebApp |
|
Timeout קריאת שקע ל-Redis (שניות) |
לא |
|
|
Bot/WebApp |
|
מצב שמרני: מוריד ברירות מחדל של Timeouts לטובת יציבות בסביבות חלשות |
לא |
|
|
Bot/WebApp |
|
הפעלת קאש פנימי |
לא |
|
|
Bot/WebApp |
|
תקציב זמן לניקוי קאש (מונע תקיעה ב-Redis) |
לא |
|
|
Bot/WebApp |
|
תקציב זמן למחיקת תבנית מפתחות בקאש (SCAN+DEL) כדי למנוע תקיעה ב-Redis גדול |
לא |
|
|
Bot/WebApp |
|
דילוג כולל על עבודות ניקוי רקע (קאש/גיבויים) |
לא |
|
|
Bot |
|
סף (בדקות) לזיהוי הרצות Jobs ”תקועות“ והפקת אירוע |
לא |
|
|
Bot |
|
תדירות הריצה (שניות) של מוניטור Jobs ”תקועות“ שמפיק |
לא |
|
|
Bot |
|
תדירות polling (שניות) של processor בבוט שמטפל בבקשות trigger שנוצרו מה-WebApp ( |
לא |
|
|
Bot |
|
מרווח בין ריצות תחזוקת קאש (שניות) |
לא |
|
|
Bot |
|
דיליי לפני הרצת תחזוקת קאש הראשונה (שניות) |
לא |
|
|
Bot |
|
מספר מפתחות מקסימלי לסריקה ב-clear_stale |
לא |
|
|
Bot |
|
TTL (בשניות) מתחתיו ייחשב ”שבק״ לניקוי עדין |
לא |
|
|
Bot |
|
הפעלת ניקוי גיבויי ZIP ברקע |
לא |
|
|
Bot |
|
מרווח בין ריצות ניקוי גיבויים (שניות) |
לא |
|
|
Bot |
|
דיליי לפני ריצת ניקוי גיבויים הראשונה (שניות) |
לא |
|
|
Bot |
|
ימי שמירת ארכיבי גיבוי בדיסק/GridFS לפני מחיקה |
לא |
|
|
Bot |
|
מספר גיבויים מקסימלי לשמירה לכל משתמש (מעבר יימחקו הוותיקים) |
לא |
|
|
Bot |
|
תקציב זמן לניקוי גיבויים (מונע עומס) |
לא |
|
|
Bot |
|
סף (ב־bytes) להתראת ”דיסק כמעט מלא“ לפני שמירת ZIP |
לא |
|
|
Bot |
|
דילוג על פעולות ניקוי קאש (לוג בלבד) |
לא |
|
|
Bot/WebApp |
|
דילוג על פעולות מנע (PHE) כמו ניקוי קאש |
לא |
|
|
Bot/WebApp |
|
רמת logging ( |
לא |
|
|
Bot/WebApp |
|
פורמט לוגים ( |
לא |
|
|
Bot/WebApp |
|
שיעור דגימה ללוגים ברמת |
לא |
|
|
Bot/WebApp |
|
אירועים שלא נדגמים לעולם (מופרדים בפסיקים) |
לא |
|
|
Bot/WebApp |
|
שם הסביבה לדיווחי Sentry/לוגים ( |
לא |
|
|
Bot/WebApp |
|
גודל קוד מקסימלי לשמירה (בתווים) |
לא |
|
|
Bot |
|
מגבלת כמות קבצים למשתמש |
לא |
|
|
Bot |
|
ערכת צבעים להדגשת תחביר |
לא |
|
|
WebApp |
|
ערכת ברירת מחדל לממשק ה-WebApp. תומך בערכות מובנות (למשל |
לא |
|
|
WebApp |
|
קידומת לשמירת checkpoints |
לא |
|
|
Bot |
|
OAuth Client ID של Google |
לא |
|
Integrations |
|
|
OAuth Client Secret של Google |
לא |
|
Integrations |
|
|
מרחבי OAuth לברירת מחדל |
לא |
|
|
Integrations |
|
מרווח חידוש טוקן בטרם פקיעה (שניות) |
לא |
|
|
Integrations |
|
הפעלת תפריט Drive v2 |
לא |
|
|
WebApp |
|
קישור לאתר התיעוד הרשמי |
לא |
|
|
WebApp |
|
תווית תצוגה לבוט |
לא |
|
|
Bot/WebApp |
|
הוספת hash לקבצים משותפים |
לא |
|
|
Integrations |
|
נרמול קוד בשמירה |
לא |
|
|
Bot |
|
מצב תחזוקה המדכא פעולות משתמשים |
לא |
|
|
Bot/WebApp |
|
הודעה למצב תחזוקה |
לא |
הודעת ברירת מחדל ידידותית |
|
WebApp |
|
חימום אוטומטי לאחר יציאה מתחזוקה (שניות) |
לא |
|
|
WebApp |
|
חלון חסד (שניות) שנוסף ל-warmup כדי לכסות שיהוי איטי בתחילת ריצה |
לא |
|
|
Bot/WebApp |
|
מגבלת קצב בקשות לדקה |
לא |
|
|
WebApp |
|
ימי שמירת פריטים בסל המחזור |
לא |
|
|
Bot/WebApp |
|
URI חלופי ל-reporter (עדיפות על |
לא |
|
Reporter |
|
|
שם חלופי ל-URI של reporter |
לא |
|
Reporter |
|
|
מזהה שירות עבור הדוחות |
לא |
|
|
Reporter |
|
הפעלת שירות שיתוף פנימי |
לא |
|
|
WebApp |
|
פורט להרצת שירותים פנימיים/בדיקות |
לא |
|
|
Bot/WebApp |
|
גודל בריכת חיבורים ל‑aiohttp |
לא |
|
|
Bot/WebApp |
|
Timeout כולל לשיחות aiohttp (שניות) |
לא |
|
|
Bot/WebApp |
|
מגבלה פר‑Host לחיבורים במקביל (aiohttp TCPConnector) |
לא |
|
|
Bot/WebApp |
|
גודל בריכת חיבורים ל‑Redis |
לא |
|
|
Bot/WebApp |
|
מספר Connection Pools גלובליים ל‑requests (per host) |
לא |
|
|
Bot/WebApp |
|
מקס׳ חיבורים בו‑זמנית בכל Pool (requests) |
לא |
|
|
Bot/WebApp |
|
Timeout ברירת מחדל לבקשות סינכרוניות (requests) |
לא |
|
|
Bot/WebApp |
|
מספר ניסיונות Retry על סטטוסים זמניים (5xx) |
לא |
|
|
Bot/WebApp |
|
backoff_factor בין ניסיונות ה‑Retry (שניות) |
לא |
|
|
Bot/WebApp |
|
סף מילישניות ללוג ”בקשה איטית“ ב‑Flask/WebApp |
לא |
|
|
WebApp |
|
סף מילישניות ללוג ”slow_http“ ב‑http_sync (requests) |
לא |
|
|
Bot/WebApp |
|
סף מילישניות ללוג ”slow_mongo“ (MongoDB CommandListener) |
לא |
|
|
Bot/WebApp |
|
הפעלת Query Performance Profiler (ניטור שאילתות MongoDB איטיות + דשבורד). ראו Query Performance Profiler.
שימו לב: כרגע יש נטרול קשיח ברמת הקוד ( |
לא |
|
|
Bot/WebApp |
|
סף זמן (מילישניות) להגדרת ”שאילתה איטית“ עבור הפרופיילר |
לא |
|
|
Bot/WebApp |
|
מספר מקסימלי של רשומות slow queries שנשמרות בזיכרון (Deque) לצורכי UI מהיר |
לא |
|
|
Bot/WebApp |
|
טוקן גישה ל-API של הפרופיילר (נשלח כ-Header |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
Allowlist של כתובות IP מורשות (CSV) ל-API של הפרופיילר. אם ריק, אין הגבלת IP. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
מגבלת בקשות לדקה ל-endpoints של הפרופיילר (Rate Limiting) |
לא |
|
|
Bot/WebApp |
|
הפעלה/כיבוי של מטריקות Prometheus לפרופיילר (Slow Queries / Buffer Size וכו«) |
לא |
|
|
Bot/WebApp |
|
סף מילישניות להתראת |
לא |
|
|
WebApp |
|
סף מילישניות ללוג ביצועים ב-API של |
לא |
|
|
WebApp |
|
גודל דף חיפוש בצד ה‑DB |
לא |
|
|
Bot/WebApp |
|
גודל דף ליסטים ב‑UI |
לא |
|
|
WebApp |
|
מפתח הצפנה לנתונים רגישים |
לא |
|
Bot/WebApp |
|
|
DSN לשילוב עם Sentry (שגיאות ותובנות) |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
דגימת Traces (0.0–1.0) |
לא |
|
|
Bot/WebApp |
|
דגימת Profiles (0.0–1.0) |
לא |
|
|
Bot/WebApp |
התראות וניטור (הרחבה)
משתנה |
תיאור |
חובה |
ברירת מחדל |
דוגמה |
רכיב |
|---|---|---|---|---|---|
|
מפעיל Drill Mode (תרגולים) ב-WebApp/API. כאשר כבוי, |
לא |
|
|
WebApp/Observability |
|
שם ה-Collection לתגיות התראות (Manual Alert Tagging) ב-Observability. |
לא |
|
|
WebApp/Observability |
|
אם |
לא |
|
|
WebApp/Observability |
|
טוקן שצריך להופיע בכותרת |
לא |
”“ (ריק) |
|
WebApp |
|
סוד לאימות קריאות ל־ |
לא |
”“ (ריק) |
|
WebApp |
|
חלון דה-דופליקציה (בשניות) להתראות Sentry שמגיעות ב-Webhook כדי למנוע burst ( |
לא |
|
|
WebApp |
|
רשימת IPs (מופרדים בפסיק) שמורשים לצרוך את ה-webhook; נבדק מול |
לא |
”“ (ריק) |
|
WebApp |
|
Allowlist אופציונלי ליעדי |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
Allowlist אופציונלי ליעדי |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
כתובת Incoming Webhook של Slack לשליחת התראות. |
לא |
”“ (ריק) |
|
Bot |
|
כתובת ציבורית בסיסית של ה-WebApp (משמשת ליצירת קישור יציב ל־Observability Dashboard בהודעות התראה). |
לא |
|
|
Bot/WebApp |
|
טוקן בוט ייעודי לשליחת התראות לטלגרם (נפרד מהבוט הראשי אם רוצים). |
לא |
|
Bot/WebApp |
|
|
Chat ID/Channel שאליו נשלחות התראות (לדוגמה |
לא |
|
Bot/WebApp |
|
|
דרגת החומרה המינימלית שתישלח לטלגרם ( |
לא |
|
|
Bot/WebApp |
|
חלון חסד (שניות) לאחר אתחול התהליך שבו מושתקים רק alerts ”רועשים“ מתוך allowlist (Mongo/Latency/EWMA) כדי למנוע רעשי דיפלוי. |
לא |
|
|
Bot/WebApp |
|
אם |
לא |
|
|
Bot/WebApp |
|
אם |
לא |
|
|
Bot/WebApp |
|
בסיס ה-URL של Grafana לכתיבת annotations על התראות. |
לא |
”“ (ריק) |
|
Bot |
|
אסימון Bearer ל-Grafana כשמוסיפים annotations דרך ה-API. |
לא |
”“ (ריק) |
|
Bot |
|
מפעיל כתיבה/קריאה ל-MongoDB עבור לוג התראות וסיילנסים. |
לא |
|
|
Bot/Observability |
|
מפעיל שמירת היסטוריית Drill ב-MongoDB (ברירת מחדל נסמכת על |
לא |
”“ (ריק = יורש מ-ALERTS_DB_ENABLED/METRICS_DB_ENABLED) |
|
WebApp/Observability |
|
שם הקולקשן שבו נשמרות התראות מנורמלות. |
לא |
|
|
Bot/Observability |
|
שם הקולקשן שבו נשמר Catalog (Registry) של כל |
לא |
|
|
Bot/Observability |
|
שם הקולקשן שבו נשמרת היסטוריית Drill Mode (תרגולים). |
לא |
|
|
WebApp/Observability |
|
שם הקולקשן לסיילנסים (pattern + TTL). |
לא |
|
|
Bot/Observability |
|
כמה ימים נשמרת התראה לפני מחיקה אוטומטית (TTL index). |
לא |
|
|
Bot/Observability |
|
כמה ימים נשמרת היסטוריית Drill לפני מחיקה אוטומטית (TTL index). |
לא |
|
|
WebApp/Observability |
|
נתיב ל־YAML שמגדיר איך לאגד אירועים לקטגוריות התראה (log aggregator). |
לא |
|
|
Bot/Observability |
|
כאשר ערכו |
לא |
|
|
Bot |
|
חלון זמן (שניות) לאיגוד התראות anomaly דומות לפני הודעה מרוכזת. |
לא |
|
|
Bot |
|
סף כמות שגיאות לדקה שמעורר |
לא |
|
|
Bot |
|
רף ה-EWMA של זמן תגובה (שניות) שמעורר התראת latency ( |
לא |
|
|
Bot |
|
רשימת נתיבי URL (CSV/JSON list) שמוחרגים מעדכון EWMA ומדגימת |
לא |
|
|
WebApp/Observability |
|
רף חלופי לאותה התראה בזמן חלון חסד לאחר Deploy. |
לא |
|
|
Bot |
|
אורך חלון החסד (שניות) שבו משתמשים ברף Deploy. |
לא |
|
|
Bot |
|
קירור מינימלי בין שתי התראות מאותו סוג. |
לא |
|
|
Bot |
|
מספר הרשומות שנשמרות בזיכרון עבור מעקב שליחות. |
לא |
|
|
Bot |
|
מפעיל fallback שמוציא התראה נפרדת עבור כל שגיאה (עם קירור קשיח). |
לא |
|
|
Bot |
|
קירור בין התראות fallback מאותה חתימת שגיאה. |
לא |
|
|
Bot |
|
TTL לחתימות במאגר הדה-דופליקציה (ברירת המחדל: שעה או פי 10 מהקירור). |
לא |
|
|
Bot |
|
כמות החתימות שנשמרות במקביל לפני שמסירים את הוותיקות. |
לא |
|
|
Bot |
|
קובץ JSON עם פתרונות/צעדים קצרים שמוצמדים להתראות בצ’אט. |
לא |
|
|
Bot/WebApp |
|
נתיב חלופי ל- |
לא |
|
|
WebApp/Observability |
|
משך (בשניות) לשמירת סטטוס הצעדים שסומנו כ“בוצעו“ ב-Runbook. |
לא |
|
|
WebApp/Observability |
|
זמן שמירת אירועי ה-Replay במטמון צד שרת לצורך שליפות Runbook (שניות). |
לא |
|
|
WebApp/Observability |
|
רשימת מחרוזות (CSV) של שירותים חיצוניים שיזוהו כ- |
לא |
|
|
WebApp/Observability |
|
Endpoint לשירות ההסבר החכם של הדשבורד (מקבל |
לא |
”“ (ריק) |
|
WebApp/Observability |
|
פורט פנימי כאשר מריצים את שירות ה-AI Explain באותו קונטיינר עם ה-WebApp (למשל דרך |
לא |
|
|
WebApp/Observability |
|
אסימון Bearer שנשלח ב-Header |
לא |
”“ (ריק) |
|
WebApp/Observability |
|
Timeout (שניות) לפנייה לשירות ה-AI לפני נפילה לניתוח היוריסטי. |
לא |
|
|
WebApp/Observability |
|
חיי המטמון (שניות) לתוצאות AI לפי |
לא |
|
|
WebApp/Observability |
|
מגבלת ימים לסיילנס יחיד שנוצר דרך ChatOps. |
לא |
|
|
Bot |
|
מספר הסיילנסים הפעילים המקסימלי לפני שיצירת חדשים נחסמת. |
לא |
|
|
Bot |
|
קירור ברירת מחדל (שניות) לפקודות אדמין רגישות בצ’אט. |
לא |
|
|
Bot/ChatOps |
|
CSV של Chats/Channels שמורשים להשתמש ביכולות אדמין (לדוגמה ערוצי ניהול). |
לא |
”“ (ריק = אין הגבלה) |
|
Bot/ChatOps |
|
כמות ההתראות הפנימיות שנשמרות בזיכרון לבקרה. |
לא |
|
|
Bot |
|
בסיס ה-API של Sentry (אם משתמשים ב-self-hosted). |
לא |
|
|
Bot/ChatOps |
|
אסימון Bearer לקריאות API (נדרש ל-ChatOps / integrations). |
לא |
”“ (ריק) |
|
Bot/ChatOps |
|
URL מלא לאזור ה-Issues בסקופ ארגוני; גובר על לינקים שנבנים מה-DSN. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
ה-slug של הארגון ב-Sentry (משמש לבניית URLs וקריאות API). |
לא |
”“ (ריק) |
|
Bot/ChatOps |
|
פרויקט ברירת מחדל לסינון Issues/Events. |
לא |
”“ (ריק) |
|
Bot/ChatOps |
|
URL ישיר לפרויקט ספציפי במקרה שאין Dashboard ארגוני. |
לא |
”“ (ריק) |
|
Bot/ChatOps |
|
מפעיל Polling תקופתי ל-Sentry (חלופה כאשר אין אפשרות Webhook ב-Sentry). הבוט ימשוך Issues אחרונים וייצר |
לא |
|
|
Bot |
|
כל כמה שניות לבצע Polling ל-Sentry (מינימום 30). |
לא |
|
|
Bot |
|
דיליי לפני ריצת ה-Poll הראשונה לאחר עלייה (שניות). |
לא |
|
|
Bot |
|
כמה Issues למשוך בכל Poll (מינימום 1, מקסימום 100). |
לא |
|
|
Bot |
|
דרגת החומרה שתישלח כ- |
לא |
|
|
Bot |
|
אם |
לא |
|
|
Bot |
|
חלון דה-דופליקציה (בשניות) לכל Issue כדי למנוע הצפה ( |
לא |
|
|
Bot |
|
1/ |
לא |
|
|
Bot/ChatOps |
מדדים, OTEL וחיזוי
משתנה |
תיאור |
חובה |
ברירת מחדל |
דוגמה |
רכיב |
|---|---|---|---|---|---|
|
מפעיל/מכבה יצוא Metrics דרך OTLP (OpenTelemetry Metrics). כדי לא להרעיש, יצוא OTLP דורש גם |
לא |
|
|
Bot/WebApp |
|
מפעיל OpenTelemetry Prometheus exporter (pull/scrape). כשהוא פעיל, מדדים של OTEL נחשפים דרך ה- |
לא |
|
|
Bot/WebApp |
|
Legacy: מפעיל כתיבה של metrics ל-MongoDB ( |
לא |
|
|
Bot/Observability |
|
שם הקולקשן לכתיבת metrics כש-DB מופעל. |
לא |
|
|
Bot/Observability |
|
גודל הבאצ« (מספר דגימות) שנשלחות בכל flush. |
לא |
|
|
Bot/Observability |
|
כל כמה שניות לרוקן את הבאפר של metrics. |
לא |
|
|
Bot/Observability |
|
מקדם EWMA (0-1) לחישוב אנומליות latency/error-rate. |
לא |
|
|
Bot |
|
מספר הדגימות המקסימלי שנשמר בזיכרון לפני שמתחילים לדלג. |
לא |
|
|
Bot |
|
חלון זמן (בשניות) לשמירת errors לצורך תרשימי חום. |
לא |
|
|
Bot |
|
מספר מקסימלי של רשומות שגיאה שנשמרות בחלון. |
לא |
|
|
Bot |
|
נתיב לקובץ החתימות (YAML) שמשמש את log aggregator לסיווג שגיאות. |
לא |
|
|
Bot |
|
כמות דגימות HTTP שנשמרות ב־deque לצורך סטטיסטיקות. |
לא |
|
|
Bot/WebApp |
|
זמן שמירת הדגימות (שניות) לפני שמנקים אותן. |
לא |
|
|
Bot/WebApp |
|
מספר השגיאות האחרונות שמוצגות ב-ChatOps (Deque). |
לא |
|
|
Bot/ChatOps |
|
אחוז שימוש בזיכרון שמפעיל התראות חיזוי (למשל 85%). |
לא |
|
|
Bot |
|
כאשר |
לא |
|
|
Bot/WebApp |
|
כתובת OTLP כללית (gRPC/HTTP) לייצוא traces/metrics אם אין חלוקה. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
כתובת ייעודית למטריקות OTLP (אם שונה מה-endpoint הראשי). |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
כתובת ייעודית ל-traces OTLP. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
בסיס URL ל-Prometheus HTTP API. אם מוגדר, דשבורד ה-Observability ישתמש ב-Prometheus ל-timeseries במקום קריאה מ-MongoDB. |
לא |
”“ (ריק) |
|
WebApp/Observability |
|
חלון ברירת מחדל ל- |
לא |
|
|
WebApp/Observability |
|
כמה זמן לשמור קבצי חיזוי/תקריות לפני ניקוי (ברירת מחדל 24 שעות). |
לא |
|
|
Bot |
|
סוג המודל לחיזוי ( |
לא |
|
|
Bot |
|
זמן מחצית החיים בדקות ל-weighting של EW regression. |
לא |
|
|
Bot |
|
טווח החיזוי (שניות קדימה) לפני שמכריזים על סכנה קרובה. |
לא |
|
|
Bot |
|
כל כמה שניות נמדדת דיוק ההחיזוי (feedback loop). |
לא |
|
|
Bot |
|
כל כמה זמן לנקות חיזויים ו-incidents ישנים. |
לא |
|
|
Bot |
|
מפעיל את ה-sampler שרץ ברקע ואוסף מדידות לטובת החיזוי. |
לא |
|
|
Bot |
|
בסיס ה-URL שממנו הסמפולר קורא סטטיסטיקות (ברירת מחדל: |
לא |
”“ (auto) |
|
Bot |
|
תדירות ריצה של הסמפולר (שניות). |
לא |
|
|
Bot |
|
דילי לפני ריצת הסמפולר הראשונה. |
לא |
|
|
Bot |
|
כאשר |
לא |
|
|
Bot |
תפעול, אינטגרציות ופיצ’רים
משתנה |
תיאור |
חובה |
ברירת מחדל |
דוגמה |
רכיב |
|---|---|---|---|---|---|
|
בחירת מנגנון גיבוי: |
לא |
|
|
Bot/WebApp |
|
נתיב גיבויים בלוקאל (אם |
לא |
נתיב ברירת מחדל ( |
|
Bot/WebApp |
|
כאשר |
לא |
|
|
Bot |
|
מפעיל חימום קאש מתוזמן לאחר אתחול. |
לא |
|
|
Bot |
|
תקציב הזמן המרבי ללופ החימום (מונע עיכובים ארוכים). |
לא |
|
|
Bot |
|
כל כמה זמן (שניות) להריץ warming job. |
לא |
|
|
Bot |
|
דילי לפני ריצת ה-warming הראשונה אחרי עלייה. |
לא |
|
|
Bot |
|
1/ |
לא |
|
|
Bot |
|
עוקף כל אינטראקציה עם MongoDB (בדרך כלל לטסטים). |
לא |
|
|
Bot/WebApp |
|
מדליק/מכבה שליחת דו“חות שבועיים (reminders). |
לא |
|
|
Bot |
|
טוקן בדיקה שמשמש סביבות שבהן אין צורך להתחבר לטלגרם (למשל docs build). |
לא |
|
|
Bot/WebApp |
|
כמה שניות להמתין לפני תחילת משימות ה-Drive rescheduler. |
לא |
|
|
Bot |
|
דילי לכל משימת שמירה/Keepalive הראשונה. |
לא |
|
|
Bot |
|
הפרש זמנים בין הריצות הבאות של ה-Drive rescheduler. |
לא |
|
|
Bot |
|
שם קולקשן ברירת המחדל עבור משימות APScheduler כאשר נשמרות ב-MongoDB. |
לא |
|
|
Bot |
|
כמה זמן להמתין אחרי עלייה לפני הפעלת job הדו“חות השבועיים. |
לא |
|
|
Bot |
|
במצב |
לא |
|
|
Bot/WebApp |
|
מאפשר לסקריפט ה-seed לרוץ גם כשכתובת ה-Mongo אינה לוקאלית (לברירת מחדל אסור). |
לא |
|
|
Scripts |
|
כאשר |
לא |
|
|
Bot/ChatOps |
|
מפעיל את מסלול השמירה המחודש (ניסיוני) בהנדלרים של save. |
לא |
|
|
Bot |
|
1/ |
לא |
|
|
Bot |
|
מפתח API עבור Pastebin ליצירת לינקים שיתופיים. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
סוד משותף בין הבוט לוובאפ לטובת אימות single-sign-on. |
לא |
”“ (ריק) |
|
WebApp/Bot |
|
כתובת דוא“ל שמוצגת בהודעות ומספקת fallback ל- |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
מפתח Fernet (Base64) להצפנת טוקנים רגישים במסד (ראה |
לא |
”“ (ריק) |
|
Bot |
|
משך הזמן שבו claim של תזכורת push נחשב בתוקף לפני שמשחררים אותו. |
לא |
|
|
Bot/WebApp |
|
Urgency header לברירת מחדל ב-Web Push ( |
לא |
|
|
WebApp |
|
מרווח ההמתנה בין סריקות מתוזמנות של תזכורות push. |
לא |
|
|
WebApp |
|
דילי בסיסי בין בקשות GitHub כדי להישאר מתחת לרף rate-limit. |
לא |
|
|
Bot/ChatOps |
|
מקדם backoff (שניות) שמתווסף בכל ניסיון כושל לקריאות GitHub. |
לא |
|
|
Bot/ChatOps |
|
קירור (דקות) בין שליחת התראות PR באותו ערוץ כדי למנוע הצפה. |
לא |
|
|
Bot/ChatOps |
|
כאשר |
לא |
|
|
Scripts |
|
כל כמה שניות סקריפט הלוג-אגגרטור יטען מחדש את קבצי החתימות. |
לא |
|
|
Scripts |
|
(Legacy) כמה זמן לחכות ללוק לפני שמתייאשים ( |
לא |
|
|
Bot |
|
זמן המתנה בין ניסיונות נעילה חוזרים (בעיקר במצב המתנה אקטיבית). נשמר לתאימות. |
לא |
|
|
Bot |
|
מזהה ייחודי לשירות/סביבה עבור נעילה מבוזרת (משמש כ־ |
לא |
|
|
Bot |
|
מזהה אינסטנס בפלטפורמת Render (נשמר במסמך הנעילה לצורכי תחקור). ה- |
לא |
|
|
Bot |
|
תווית host/service לתחקור במסמך הלוק. אם לא מוגדר, נופל ל־ |
לא |
ערך מערכת (fallback) |
|
Bot |
|
משך ה־lease (שניות) של נעילה מבוזרת ב־MongoDB. |
לא |
|
|
Bot |
|
תדירות heartbeat (שניות) לרענון ה־lease. ברירת מחדל: |
לא |
|
|
Bot |
|
אם |
לא |
|
|
Bot |
|
מגבלת זמן (שניות) במצב המתנה אקטיבית. |
לא |
|
|
Bot |
|
מינימום זמן המתנה (שניות) במצב המתנה פסיבית עם jitter. |
לא |
|
|
Bot |
|
מקסימום זמן המתנה (שניות) במצב המתנה פסיבית עם jitter. |
לא |
|
|
Bot |
|
אם |
לא |
|
|
Bot |
|
אם |
לא |
|
|
Bot |
|
אם |
לא |
|
|
Bot |
|
פורט לוקאלי לשמירה על בלעדיות תהליך (נדרש רק אם |
לא |
|
|
Bot |
|
שם קולקציית ה־locks ב־MongoDB (ברירת מחדל legacy: |
לא |
|
|
Bot |
|
מחרוזת גרסה שמוזנת מהפלטפורמה (Render/Heroku) לצורכי Telemetry. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
מזהה לצורך cache-busting של קבצי סטטיק (נוסף ל-query param). |
לא |
”“ (ריק) |
|
WebApp |
|
מחרוזת תיאור (למשל |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
שם סביבת הריצה (fallback כאשר |
לא |
|
|
Bot/WebApp |
|
מזהי הקומיט כפי שמוזנים ע“י הפלטפורמה; מופיעים בדוחות גרסה. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
שם המכונה המדווח בלוגים / ב-claim של push (לרוב מוזן ע“י התשתית, אבל ניתן לעקוף). |
לא |
ערך מערכת |
|
Bot/WebApp |
|
רשימת הקומפרסורים שהקליינט יבקש מ-Mongo (למשל |
לא |
”“ (Auto) |
|
Bot/WebApp |
|
אליאסים המשמשים סקריפטי עזר (כמו setup_bookmarks) כאשר אין |
לא |
|
|
Scripts |
דגלי בדיקות ופיתוח
משתנה |
תיאור |
חובה |
ברירת מחדל |
דוגמה |
רכיב |
|---|---|---|---|---|---|
|
כאשר |
לא |
|
|
Tests |
|
אחוזון שמפריד בין טסטים ”כבדים“ ל“קלים“ (ברירת מחדל 90). |
לא |
|
|
Tests |
|
דגלים שמאותתים לקוד שאנו בתוך Pytest (למשל כדי לנטרל Jobs). Pytest מגדיר אותם אוטומטית. |
לא |
”“ (ריק) |
|
Bot/WebApp |
|
1/ |
לא |
|
|
Docs |
|
מזהה משתמש לדגימת בדיקת latency בסקריפט |
לא |
|
|
Scripts |
|
דגלים של סקריפט |
לא |
”“ (ריק) |
|
Tooling |
דוגמאות קונפיגורציה
Development:
BOT_TOKEN=your_bot_token_here
MONGODB_URL=mongodb://localhost:27017
DATABASE_NAME=code_keeper_dev
LOG_LEVEL=DEBUG
Staging:
BOT_TOKEN=staging_bot_token
MONGODB_URL=mongodb+srv://user:pass@cluster.mongodb.net
DATABASE_NAME=code_keeper_staging
LOG_LEVEL=INFO
REDIS_URL=redis://staging-redis:6379
Production:
BOT_TOKEN=prod_bot_token
MONGODB_URL=mongodb+srv://user:pass@prod-cluster.mongodb.net
DATABASE_NAME=code_keeper_prod
LOG_LEVEL=WARNING
REDIS_URL=redis://prod-redis:6379
ENCRYPTION_KEY=your-32-byte-encryption-key
קישורים
SECURITY_TOKENS (מסמך ריפו) <https://github.com/amirbiron/CodeBot/blob/main/docs/SECURITY_TOKENS.md>`_
טבלת Scopes לפיצ’רים של GitHub
Feature |
Required Scopes |
|---|---|
Create Pull Request |
|
Write files (Trees/Contents API) |
|
Read repository metadata (branches, commits, PRs) |
|
Trigger workflows / read checks status |
|
הערה: הקפידו להעניק הרשאות מינימליות בלבד. לפרטים נוספים ראו Integrations.