feature: control log level via env vars

.env.example

@@ -4,6 +4,12 @@
 # Remove all line-comments and save this as .env to enable
 # Do not commit the filled-out file to GitHub
 
+# possible values: all, trace, debug, info, warn, error, fatal, off (default: info)
+LOG_LEVEL=all
+
+# possible values: [unset], json, breif, verbose (default: unset)
+LOG_FORMAT=
+
 # Wix API key for import 
 API_KEY=
 
@@ -76,4 +82,4 @@ GAMIFICATION_ACTIVE=
 REQUIRE_PUPIL_SCREENING=
 
 # Credential for the OpenAI API to use their LLMs
-OPENAI_API_KEY=
+OPENAI_API_KEY=

README.md

@@ -97,6 +97,13 @@ The following configuration can be done via ENV variables:
 
 | Name       | Value   | Description                                                               |
 | ---------- | ------- | ------------------------------------------------------------------------- |
+| LOG_LEVEL  | all     | Log levels are used to categorize log events by severity and control the  |
+|            | trace   | verbosity of the logs. Using levels, you can filter out less important    |
+|            | debug   | logs and focus on the most critical ones.                                 |
+|            | info    |                                                                           |
+|            | warn    |                                                                           |
+|            | error   |                                                                           |
+| ---------- | ------- | ------------------------------------------------------------------------- |
 | LOG_FORMAT | (unset) | Every log prefixed by session and transaction id, also log HTTP requests  |
 |            | json    | Log as JSON, used in deployed environments to pass rich info to Datadog   |
 |            | brief   | Only log category and message (omitting session prefix and HTTP requests) |
@@ -105,9 +112,9 @@ The following configuration can be done via ENV variables:
 
 The following command line arguments are available (i.e. run `npm run web -- --debug`):
 
-| Argument | Description                                                      |
-| -------- | ---------------------------------------------------------------- |
-| \--debug | Sets the log level to debug which prints out tons of information |
+| Argument | Description                          |
+| -------- | ------------------------------------ |
+| None     | There are no cli arguments right now |
 
 ### Changes to the Data-Model
 

common/logger/logger.ts

@@ -1,9 +1,8 @@
 import tracer from './tracing';
 import formats from 'dd-trace/ext/formats';
-import { isCommandArg } from '../util/basic';
 import { configure, addLayout, getLogger as getlog4jsLogger, Logger as Log4jsLogger } from 'log4js';
 import { getCurrentTransaction } from '../session';
-import { getServiceName, getHostname } from '../../utils/environment';
+import { getServiceName, getHostname, getLogLevel, getLogFormat } from '../../utils/environment';
 
 addLayout('json', function () {
     return function (logEvent) {
@@ -25,12 +24,13 @@ addLayout('json', function () {
     };
 });
 
+const logFormat = getLogFormat();
 let appenders = ['out'];
-if (process.env.LOG_FORMAT === 'json') {
+if (logFormat === 'json') {
     appenders = ['outJson'];
-} else if (process.env.LOG_FORMAT === 'brief') {
+} else if (logFormat === 'brief') {
     appenders = ['outBrief'];
-} else if (process.env.LOG_FORMAT === 'verbose') {
+} else if (logFormat === 'verbose') {
     appenders = ['outBrief', 'fileVerbose'];
 }
 
@@ -83,7 +83,7 @@ configure({
     categories: {
         default: {
             appenders,
-            level: isCommandArg('--debug') ? 'debug' : 'info',
+            level: getLogLevel('info'),
         },
     },
 

utils/environment.ts

@@ -25,3 +25,11 @@ export function isGamificationFeatureActive(): boolean {
 export function isWebflowSyncDryRun(): boolean {
     return JSON.parse(process.env.WEBFLOW_SYNC_DRY_RUN || 'true');
 }
+
+export function getLogLevel(defaultLevel: string): string {
+    return process.env.LOG_LEVEL || defaultLevel;
+}
+
+export function getLogFormat(): string | null {
+    return process.env.LOG_FORMAT;
+}