#pkg: '@nocobase/plugin-logger'

#יומנים

#מבוא

יומנים הם כלי חשוב שעוזר לנו לאתר בעיות במערכת. יומני השרת של NocoBase כוללים בעיקר יומני בקשות ממשק ויומני פעולות מערכת, ותומכים בהגדרת רמת יומן, אסטרטגיית גלגול (rolling strategy), גודל, פורמט הדפסה ועוד. מסמך זה מציג בעיקר את התוכן הקשור ליומני השרת של NocoBase, וכן כיצד להשתמש בתוסף הרישום כדי לארוז ולהוריד יומני שרת.

#הגדרות יומן

פרמטרים הקשורים ליומן, כגון רמת יומן, שיטת פלט ופורמט הדפסה, ניתנים להגדרה באמצעות משתני סביבה.

#פורמטי יומן

NocoBase תומכת בהגדרת ארבעה פורמטים שונים של יומנים.

#console

פורמט ברירת המחדל בסביבת פיתוח, הודעות מוצגות בצבעים מודגשים.

2023-12-30 22:40:06 [info]  response                                     method=GET path=/api/uiSchemas:getJsonSchema/nocobase-admin-menu res={"status":200} action={"actionName":"getJsonSchema","resourceName":"uiSchemas","params":{"filterByTk":"nocobase-admin-menu","resourceName":"uiSchemas","resourceIndex":"nocobase-admin-menu","actionName":"getJsonSchema"}} userId=1 status=200 cost=5 app=main reqId=ccf4e3bd-beb0-4350-af6e-b1fc1d9b6c3f
2023-12-30 22:43:12 [debug] Database dialect: mysql                      module=application method=install app=main reqId=31ffa8b5-f377-456b-a295-0c8a28938228
2023-12-30 22:43:12 [warn]  app is installed                             module=application method=install app=main reqId=31ffa8b5-f377-456b-a295-0c8a28938228

#json

פורמט ברירת המחדל בסביבת ייצור.

{
  "level": "info",
  "timestamp": "2023-12-26 22:04:56",
  "reqId": "7612ef42-58e8-4c35-bac2-2e6c9d8ec96e",
  "message": "response",
  "method": "POST",
  "path": "/api/authenticators:publicList",
  "res": { "status": 200 },
  "action": {
    "actionName": "publicList",
    "resourceName": "authenticators",
    "params": { "resourceName": "authenticators", "actionName": "publicList" }
  },
  "status": 200,
  "cost": 16
}

#logfmt

https://brandur.org/logfmt.

level=info timestamp=2023-12-21 14:18:02 reqId=8b59a40d-68ee-4c97-8001-71a47a92805a
message=response method=POST path=/api/authenticators:publicList res={"status":200}
action={"actionName":"publicList","resourceName":"authenticators","params":{"resourceName":"authenticators","actionName":"publicList"}}
userId=undefined status=200 cost=14

#delimiter

מופרד באמצעות מפריד |.

info|2023-12-26 22:07:09|13cd16f0-1568-418d-ac37-6771ee650e14|response|POST|/api/authenticators:publicList|{"status":200}|{"actionName":"publicList","resourceName":"authenticators","params":{"resourceName":"authenticators","actionName":"publicList"}}||200|25

#ספריית יומנים

מבנה הספריות הראשי של קבצי היומן ב-NocoBase הוא:

• storage/logs - ספריית פלט יומנים
  • main - שם היישום הראשי
    • request_YYYY-MM-DD.log - יומן בקשות
    • system_YYYY-MM-DD.log - יומן מערכת
    • system_error_YYYY-MM-DD.log - יומן שגיאות מערכת
    • sql_YYYY-MM-DD.log - יומן ביצוע SQL
    • ...
  • sub-app - שם יישום משנה
    • request_YYYY-MM-DD.log
    • ...

#קבצי יומן

#יומן בקשות

request_YYYY-MM-DD.log, יומני בקשות ותגובות ממשק.

#יומן מערכת

system_YYYY-MM-DD.log, יומני פעולות מערכת של יישומים, Middleware, תוספים ועוד. יומני ברמת error יודפסו בנפרד לקובץ system_error_YYYY-MM-DD.log.

#יומן ביצוע SQL

sql_YYYY-MM-DD.log, יומני ביצוע SQL של מסד הנתונים. הצהרות INSERT INTO מוגבלות ל-2000 התווים הראשונים בלבד.

#אריזה והורדה של יומנים

1. עברו לדף ניהול היומנים.
2. בחרו את קבצי היומן שברצונכם להוריד.
3. לחצו על כפתור ההורדה (Download).

#מסמכים קשורים

• פיתוח תוספים - צד שרת - רישום יומן
• תיעוד API - @nocobase/logger