Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Feature/expose log levels as env variable (#3704)

Thomas Kaulbc51f106e9c3
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 30dc3b6e7a..9d28fedda8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Reworked the portfolio calculator
+- Exposed the log levels as an environment variable (`LOG_LEVELS`)
- Exposed the maximum of chart data items as an environment variable (`MAX_CHART_ITEMS`)
### Fixed
diff --git a/README.md b/README.md
index 47316881f6..d4353351ff 100644
--- a/README.md
+++ b/README.md
@@ -85,23 +85,24 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c
### Supported Environment Variables
-| Name | Type | Default Value | Description |
-| ------------------------ | ------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
-| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
-| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
-| `DATABASE_URL` | `string` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer` |
-| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
-| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
-| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
-| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
-| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
-| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
-| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
-| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
-| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
-| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
-| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
+| Name | Type | Default Value | Description |
+| ------------------------ | --------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
+| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
+| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
+| `DATABASE_URL` | `string` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}?sslmode=prefer` |
+| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
+| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
+| `LOG_LEVELS` | `string[]` (optional) | | The logging levels for the Ghostfolio application, e.g. `["debug","error","log","warn"]` |
+| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
+| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
+| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
+| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
+| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
+| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
+| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
+| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
+| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
### Run with Docker Compose
diff --git a/apps/api/src/main.ts b/apps/api/src/main.ts
index abb27b7cdf..9335e8d18d 100644
--- a/apps/api/src/main.ts
+++ b/apps/api/src/main.ts
@@ -1,4 +1,9 @@
-import { Logger, ValidationPipe, VersioningType } from '@nestjs/common';
+import {
+ Logger,
+ LogLevel,
+ ValidationPipe,
+ VersioningType
+} from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { NestFactory } from '@nestjs/core';
import type { NestExpressApplication } from '@nestjs/platform-express';
@@ -12,11 +17,20 @@ import { HtmlTemplateMiddleware } from './middlewares/html-template.middleware';
async function bootstrap() {
const configApp = await NestFactory.create(AppModule);
const configService = configApp.get<ConfigService>(ConfigService);
+ let customLogLevels: LogLevel[];
+
+ try {
+ customLogLevels = JSON.parse(
+ configService.get<string>('LOG_LEVELS')
+ ) as LogLevel[];
+ } catch {}
const app = await NestFactory.create<NestExpressApplication>(AppModule, {
- logger: environment.production
- ? ['error', 'log', 'warn']
- : ['debug', 'error', 'log', 'verbose', 'warn']
+ logger:
+ customLogLevels ??
+ (environment.production
+ ? ['error', 'log', 'warn']
+ : ['debug', 'error', 'log', 'verbose', 'warn'])
});
app.enableCors();