seas-computing / course-planner

SEAS Course Planning Application. JSDoc Docs at: https://seas-computing.github.io/course-planner/
0 stars 1 forks source link

Format production logs in syslog format #658

Closed rmainwork closed 1 year ago

rmainwork commented 1 year ago

This PR updates the log service date format to produce logs in the format expected by splunk(sylog format).

This means, that instead of logs like this:

2023-03-15T20:59:41.518Z [INFO]    (NestJS#RoutesResolver) UserController {/api/api/users}:
2023-03-15T20:59:41.519Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/api/users/current, GET} route
2023-03-15T20:59:41.519Z [INFO]    (NestJS#RoutesResolver) HealthCheckController {/api/health-check}:
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/health-check, GET} route
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RoutesResolver) AuthController {/api}:
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/login, GET} route
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/validate, GET} route
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/logout, GET} route
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RoutesResolver) CourseController {/api/api/courses}:
2023-03-15T20:59:41.520Z [INFO]    (NestJS#RouterExplorer) Mapped {/api/api/courses, GET} route

The app will now generate logs like this:

Mar 15 21:00:18 INFO NestJS#RoutesResolver UserController {/api/api/users}:
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/api/users/current, GET} route
Mar 15 21:00:18 INFO NestJS#RoutesResolver HealthCheckController {/api/health-check}:
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/health-check, GET} route
Mar 15 21:00:18 INFO NestJS#RoutesResolver AuthController {/api}:
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/login, GET} route
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/validate, GET} route
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/logout, GET} route
Mar 15 21:00:18 INFO NestJS#RoutesResolver CourseController {/api/api/courses}:
Mar 15 21:00:18 INFO NestJS#RouterExplorer Mapped {/api/api/courses, GET} route

Types of changes

Checklist:

Priority:

Related Issues:

Fixes #384

codecov[bot] commented 1 year ago

Codecov Report

Merging #658 (85a9ba2) into develop (9eedd5f) will decrease coverage by 0.01%. The diff coverage is 100.00%.

:exclamation: Current head 85a9ba2 differs from pull request most recent head 5891273. Consider uploading reports for the commit 5891273 to get more accurate results

@@             Coverage Diff             @@
##           develop     #658      +/-   ##
===========================================
- Coverage    94.13%   94.13%   -0.01%     
===========================================
  Files          194      194              
  Lines         4587     4585       -2     
  Branches       561      561              
===========================================
- Hits          4318     4316       -2     
  Misses         149      149              
  Partials       120      120              
Impacted Files Coverage Δ
src/client/components/pages/CourseAdmin.tsx 100.00% <ø> (ø)
...t/components/pages/Courses/CourseInstanceTable.tsx 100.00% <ø> (ø)
.../components/pages/Faculty/FacultyScheduleTable.tsx 100.00% <ø> (ø)
src/client/components/pages/FacultyAdmin.tsx 100.00% <ø> (ø)
src/client/components/pages/MultiYearPlan.tsx 100.00% <ø> (ø)
...rc/client/components/pages/RoomAdmin/RoomAdmin.tsx 100.00% <ø> (ø)
src/server/log/log.service.ts 100.00% <100.00%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more