Allow to configure logging per service with BALENA_LOGS_LEVEL env var

Services `core-next` and `service-relay` are configured by default
with `BALENA_LOGS_LEVEL: error`.

Change-type: patch

Author: pipex

docker-compose.yml

@@ -43,6 +43,8 @@ services:
       # Needed for locks and balenahup. This needs to match the device
       # used for the `runtime` volume
       - BALENA_HOST_RUNTIME_DIR=/tmp/balena-supervisor
+      # Only send error logs to dashboard
+      - BALENA_LOGS_LEVEL=error
     volumes:
       # Critical configurations
       - config:/config/helios
@@ -67,6 +69,9 @@ services:
       - core
     volumes:
       - runtime:/tmp/run
+    environment:
+      # Only send error logs to dashboard
+      - BALENA_LOGS_LEVEL=error
     healthcheck:
       test: ['CMD', 'wget', '-O', '-', '-q', 'http://127.0.0.1:48484/ping']
 

src/compose/service-manager.ts

@@ -372,7 +372,7 @@ export async function start(service: Service) {
 			);
 		}
 
-		logger.attach(container.id, { serviceId });
+		logger.attach(container.id, { serviceId, logLevel: service.logLevel() });
 
 		if (!alreadyStarted) {
 			logger.logSystemEvent(LogTypes.startServiceSuccess, { service });
@@ -433,8 +433,10 @@ export function listenToEvents() {
 										`serviceId not defined for service: ${service.serviceName} in ServiceManager.listenToEvents`,
 									);
 								}
+
 								logger.attach(data.id, {
 									serviceId,
+									logLevel: service.logLevel(),
 								});
 							} else if (status === 'destroy') {
 								logMonitor.detach(data.id);
@@ -489,8 +491,10 @@ export async function attachToRunning() {
 					`containerId not defined for service: ${service.serviceName} in ServiceManager.attachToRunning`,
 				);
 			}
+
 			logger.attach(service.containerId, {
 				serviceId,
+				logLevel: service.logLevel(),
 			});
 		}
 	}

src/compose/service.ts

@@ -14,6 +14,7 @@ import log from '../lib/supervisor-console';
 import * as conversions from '../lib/conversions';
 import { checkInt } from '../lib/validation';
 import { InternalInconsistencyError } from '../lib/errors';
+import { LogLevel } from '../logging/types';
 
 import type { EnvVarObject } from '../types';
 import type {
@@ -1185,6 +1186,18 @@ class ServiceImpl implements Service {
 			`${updateLock.lockPath(appId, serviceName)}:/tmp/balena`,
 		];
 	}
+
+	public logLevel(): LogLevel {
+		switch (this.config.environment['BALENA_LOGS_LEVEL']) {
+			case 'none':
+				return LogLevel.None;
+			case 'err':
+			case 'error':
+				return LogLevel.Err;
+			default:
+				return LogLevel.Info;
+		}
+	}
 }
 
 export const Service = ServiceImpl;

src/compose/types/service.ts

@@ -3,6 +3,7 @@ import type Dockerode from 'dockerode';
 import { isAbsolute } from 'path';
 
 import type { PortMap } from '../ports';
+import type { LogLevel } from '../../logging/types';
 
 export interface ComposeHealthcheck {
 	test: string | string[];
@@ -392,4 +393,5 @@ export interface Service {
 		containerIds: Dictionary<string>;
 	}): Dockerode.ContainerCreateOptions;
 	handoverCompleteFullPathsOnHost(): string[];
+	logLevel(): LogLevel;
 }

src/logging/index.ts

@@ -6,7 +6,7 @@ import type { LogType } from '../lib/log-types';
 import { BalenaLogBackend } from './balena-backend';
 import { LocalLogBackend } from './local-backend';
 import type { LogBackend } from './log-backend';
-import type { LogMessage } from './types';
+import { LogLevel, type LogMessage } from './types';
 import logMonitor from './monitor';
 
 import * as globalEventBus from '../event-bus';
@@ -126,18 +126,31 @@ export function logSystemMessage(
 	}
 }
 
-type ServiceInfo = { serviceId: number };
-export function attach(containerId: string, { serviceId }: ServiceInfo): void {
+type ServiceInfo = { serviceId: number; logLevel: LogLevel };
+export function attach(
+	containerId: string,
+	{ serviceId, logLevel }: ServiceInfo,
+): void {
 	// First detect if we already have an attached log stream
 	// for this container
 	if (logMonitor.isAttached(containerId)) {
 		return;
 	}
 
+	// skip service attach LogLevel is None
+	if (logLevel === LogLevel.None) {
+		return;
+	}
+
 	// We do not grab a container lock here as we are only adding it to the list of container ids to monitor
 	// and not directly affecting the container itself, and grabbing the lock can cause a delay which means
 	// that early messages logged from the container are missed and never sent to the backend.
 	logMonitor.attach(containerId, async (message) => {
+		// ignore non stderr messages for an error only service
+		if (logLevel === LogLevel.Err && !message.isStdErr) {
+			return;
+		}
+
 		await log({ ...message, serviceId });
 	});
 }

src/logging/types.ts

@@ -11,3 +11,9 @@ type ContainerLogMessage = BaseLogMessage & {
 	isSystem?: false;
 };
 export type LogMessage = SystemLogMessage | ContainerLogMessage;
+
+export enum LogLevel {
+	None,
+	Info,
+	Err,
+}