Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

- Added logs throttling and better redis logging. #696

Merged
merged 3 commits into from
May 23, 2024
Merged

- Added logs throttling and better redis logging. #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9eefe4c
- Added logs throttling and better redis logging.
etiennenoel May 23, 2024
87a3f4a
Start with 50 logs per second.
etiennenoel May 23, 2024
39319c5
- Fix test.
etiennenoel May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions packages/logging/src/loggers/console.logger.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down Expand Up @@ -84,7 +85,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down Expand Up @@ -112,7 +114,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down Expand Up @@ -140,7 +143,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down Expand Up @@ -169,7 +173,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down Expand Up @@ -197,7 +202,8 @@ describe("Console writer", () => {
3,
3,
true,
OutputModeEnum.Json
OutputModeEnum.Json,
50
);

consoleWriter.readableStream.push(logInfo);
Expand Down
29 changes: 29 additions & 0 deletions packages/logging/src/loggers/console.logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ export class ConsoleLogger extends BaseLogger implements LoggerInterface {
*/
public readableStream?: Readable;

private currentSecond = -1;

private numberOfLogsInThisSecond = 0;

private currentlyThrottlingLogs = false;

/**
* The ConsoleLogger outputs the logs in the console.
* @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
Expand All @@ -41,6 +47,7 @@ export class ConsoleLogger extends BaseLogger implements LoggerInterface {
* We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
* @param isActivated Whether or not this particular logger is activated and should output logs.
* @param outputMode The output mode, that the logger should use.
* @param maximumLogsPerSecond The maximum numner of logs per second that can be outputted
*/
public constructor(@inject("%pristine.logging.numberOfStackedLogs%") numberOfStackedLogs: number,
@inject("%pristine.logging.logSeverityLevelConfiguration%") logSeverityLevelConfiguration: number,
Expand All @@ -51,6 +58,7 @@ export class ConsoleLogger extends BaseLogger implements LoggerInterface {
@inject("%pristine.logging.logCriticalDepthConfiguration%") logCriticalDepthConfiguration: number,
@inject("%pristine.logging.consoleLoggerActivated%") isActivated: boolean,
@inject("%pristine.logging.consoleLoggerOutputMode%") outputMode: OutputModeEnum,
@inject("%pristine.logging.maximumLogsPerSecond%") private readonly maximumLogsPerSecond: number,
) {
super(numberOfStackedLogs,
logSeverityLevelConfiguration,
Expand Down Expand Up @@ -90,6 +98,23 @@ export class ConsoleLogger extends BaseLogger implements LoggerInterface {
}
}

private shouldThrottleLogs() {
const now = new Date().getSeconds();
if (this.currentSecond !== now) {
this.currentSecond = now;
this.numberOfLogsInThisSecond = 1;
this.currentlyThrottlingLogs = false;
} else {
this.numberOfLogsInThisSecond++;
if (this.numberOfLogsInThisSecond > this.maximumLogsPerSecond) {
this.currentlyThrottlingLogs = true;
console.error(`Throttling the logs as we are outputting too many logs (${this.maximumLogsPerSecond}) per second.`);
}
}

return this.currentlyThrottlingLogs;
}

/**
* Outputs the log in the console.
* @param log The log to be outputted
Expand All @@ -98,6 +123,10 @@ export class ConsoleLogger extends BaseLogger implements LoggerInterface {
protected log(log: LogModel): void {
const outputLog = this.getFormattedOutputLog(log);

if(this.shouldThrottleLogs()) {
return;
}

switch (log.severity) {
case SeverityEnum.Debug:
console.debug(outputLog);
Expand Down
13 changes: 13 additions & 0 deletions packages/logging/src/logging.module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,19 @@ export const LoggingModule: ModuleInterface = {
new BooleanResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_ACTIVATE_DIAGNOSTICS")),
]
},
/**
* Whether or not the diagnostic should be activated.
* When activated, the stack trace and other diagnostic information will be added to the logs.
* This is an intensive process and can dramatically reduce the performance of the code.
*/
{
parameterName: LoggingModuleKeyname + ".maximumLogsPerSecond",
defaultValue: 50,
isRequired: false,
defaultResolvers: [
new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_MAXIMUM_LOGS_PER_SECOND")),
]
},
],
importModules: [
CommonModule,
Expand Down
12 changes: 6 additions & 6 deletions packages/redis/src/clients/redis.client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export class RedisClient implements RedisClientInterface {
response = client.SET(redisKey, value);
}

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis - `set` response", {response, table, key, value, ttl}, RedisModuleKeyname)
} catch (error) {
throw new RedisError("Error setting in redis", error as Error, table, key, redisKey);
}
Expand All @@ -86,7 +86,7 @@ export class RedisClient implements RedisClientInterface {
try {
const response = await client.RPUSH(redisKey, ...value);

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis - `setList` response", {response, table, key, value, ttl}, RedisModuleKeyname)
} catch (error) {
throw new RedisError("Error setting in redis", error as Error, table, key, redisKey);
}
Expand All @@ -104,7 +104,7 @@ export class RedisClient implements RedisClientInterface {
try {
const response = await client.GET(redisKey);

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis - `get` response", {response, table, key}, RedisModuleKeyname)

return response;
} catch (error) {
Expand All @@ -126,7 +126,7 @@ export class RedisClient implements RedisClientInterface {
try {
const response = await client.LRANGE(redisKey, start, stop);

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis `getList` response", {response, table, key, start, stop}, RedisModuleKeyname)

return response;
} catch (error) {
Expand All @@ -146,7 +146,7 @@ export class RedisClient implements RedisClientInterface {
try {
const response = await client.DEL(redisKey);

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis - `remove` response", {response, table, key}, RedisModuleKeyname)

} catch (error) {
throw new RedisError("Error removing in redis", error as Error, table, key, redisKey);
Expand All @@ -162,7 +162,7 @@ export class RedisClient implements RedisClientInterface {
try {
const response = await client.FLUSHALL();

this.logHandler.debug("Redis response", {response}, RedisModuleKeyname)
this.logHandler.debug("Redis - `clearAll` response", {response}, RedisModuleKeyname)

} catch (error) {
throw new RedisError("Error clearing redis", error as Error);
Expand Down
Loading