feat(backend): add configurable logger #147

Holzchopf · 2025-02-13T10:54:55Z

Changes

Added Logger class that allows

logging messages of different levels (TRACE | DEBUG | INFO | WARN | ERROR | FATAL)
uniformly formatting log messages
configuring log output level (ALL | TRACE | DEBUG | INFO | WARN | ERROR | FATAL | OFF)

Related issues

Closes #53

Request for Comment

Risk: low
Discussion: high
- default log level is INFO
- log pattern is %d %-5p [%c]: %m
- logs go to stdout
- messages are JSON (per log4js default)

2025-02-14T14:11:49.844 WARN  [config]: ["Using defaults for keycloak",{"url":"http://localhost:8081","realm":"netzgrafikeditor"}]
2025-02-14T14:11:49.860 INFO  [migration]: ["Migrating \"TABLE SCHEMA benchmarks v1\" …"]
2025-02-14T14:11:49.868 ERROR [ampq]: [{"errno":-4078,"code":"ECONNREFUSED","syscall":"connect","address":"::1","port":5672}]

Checklist

Tests are included for relevant behavior changes.
Prefix the commits with one of the labels of Conventional Commit messages.

Document changes in this pull request above.
Documentation is added in the docs folder for relevant behavior changes.
Technical guidelines listed in docs/CONTRIBUTING.md are followed.

Holzchopf · 2025-02-13T10:57:02Z

@chenkins Could you have a look and let me know what you think about the defaults? Once settled, I will update the backend README.

ts/backend/src/app/features/logger/logger.mts

ts/backend/src/app/features/config/command-line.mts

Co-authored-by: Serge Croisé <[email protected]>

ts/backend/README.md

ts/backend/package.json

ts/backend/src/app/features/config/command-line.mts

ts/backend/src/app/features/logger/logger.mts

chenkins

Lgtm, some questions.

…ion/flatland-benchmarks into backend-logger

chenkins

lgtm apart from missing test coverage. Open an issue once for once we have unit test setup in place?

Holzchopf added 5 commits February 13, 2025 11:38

feat(backend): add logger class

02eeff4

fix: missing method name fallback

40603a1

fix: default log level

077c811

feat: add split-string-at utility function

34a0fde

feat: add command line parser and logger cli options

84e7a1b

chenkins reviewed Feb 13, 2025

View reviewed changes

ts/backend/src/app/features/logger/logger.mts Show resolved Hide resolved

SergeCroise reviewed Feb 13, 2025

View reviewed changes

ts/backend/src/app/features/logger/logger.mts Outdated Show resolved Hide resolved

SergeCroise reviewed Feb 13, 2025

View reviewed changes

ts/backend/src/app/features/config/command-line.mts Outdated Show resolved Hide resolved

Holzchopf and others added 7 commits February 14, 2025 08:53

Update ts/backend/src/app/features/logger/logger.mts

fe40d1a

Co-authored-by: Serge Croisé <[email protected]>

Update ts/backend/src/app/features/config/command-line.mts

c88074d

Co-authored-by: Serge Croisé <[email protected]>

Merge branch 'main' into backend-logger

ce0ea6f

fix: line wrap with special chars

9fbe3f0

Add ElementType and ElementPropertyType utility types

d1b9d4b

Add log4js in preparation for log to file or other target (future use)

edef99d

Update backend readme

1f6ff13

Holzchopf marked this pull request as ready for review February 14, 2025 13:46

Holzchopf requested a review from a team as a code owner February 14, 2025 13:46