64 lines
1.6 KiB
TypeScript
64 lines
1.6 KiB
TypeScript
|
import { Service } from '@n8n/di';
|
||
|
|
import type { ErrorEvent, Exception } from '@sentry/core';
|
||
|
|
import { ErrorReporter } from 'n8n-core';
|
||
|
|
|
||
|
|
import { SentryConfig } from './config/sentry-config';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sentry service for the task runner.
|
||
|
|
*/
|
||
|
|
@Service()
|
||
|
|
export class TaskRunnerSentry {
|
||
|
|
constructor(
|
||
|
|
private readonly config: SentryConfig,
|
||
|
|
private readonly errorReporter: ErrorReporter,
|
||
|
|
) {}
|
||
|
|
|
||
|
|
async initIfEnabled() {
|
||
|
|
const { dsn, n8nVersion, environment, deploymentName } = this.config;
|
||
|
|
|
||
|
|
if (!dsn) return;
|
||
|
|
|
||
|
|
await this.errorReporter.init({
|
||
|
|
serverType: 'task_runner',
|
||
|
|
dsn,
|
||
|
|
release: `n8n@${n8nVersion}`,
|
||
|
|
environment,
|
||
|
|
serverName: deploymentName,
|
||
|
|
beforeSendFilter: this.filterOutUserCodeErrors,
|
||
|
|
withEventLoopBlockDetection: false,
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
async shutdown() {
|
||
|
|
if (!this.config.dsn) return;
|
||
|
|
|
||
|
|
await this.errorReporter.shutdown();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filter out errors originating from user provided code.
|
||
|
|
* It is possible for users to create code that causes unhandledrejections
|
||
|
|
* that end up in the sentry error reporting.
|
||
|
|
*/
|
||
|
|
filterOutUserCodeErrors = (event: ErrorEvent) => {
|
||
|
|
const error = event?.exception?.values?.[0];
|
||
|
|
|
||
|
|
return error ? this.isUserCodeError(error) : false;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if the error is originating from user provided code.
|
||
|
|
* It is possible for users to create code that causes unhandledrejections
|
||
|
|
* that end up in the sentry error reporting.
|
||
|
|
*/
|
||
|
|
private isUserCodeError(error: Exception) {
|
||
|
|
const frames = error.stacktrace?.frames;
|
||
|
|
if (!frames) return false;
|
||
|
|
|
||
|
|
return frames.some(
|
||
|
|
(frame) => frame.filename === 'node:vm' && frame.function === 'runInContext',
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|