feat: sentry.io error reporting

RTByte · Aug 18, 2020 · 9253b36 · 9253b36
1 parent db4608f
commit 9253b36
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 0 deletions.
diff --git a/src/events/rtbyteCommandError.js b/src/events/rtbyteCommandError.js
@@ -1,5 +1,6 @@
 const { Event } = require('klasa');
 const { MessageEmbed } = require('discord.js');
+const Sentry = require('@sentry/node');
 
 module.exports = class extends Event {
 
@@ -8,6 +9,14 @@ module.exports = class extends Event {
 	}
 
 	async run(message, command, params, error) {
+		Sentry.withScope(scope => {
+			scope.setTag('error-type', 'command');
+			scope.setLevel(this.client.options.production ? 'error' : 'debug');
+			scope.setContext('Message', message);
+
+			Sentry.captureException(error);
+		});
+
 		if (this.client.settings.get('logs.commandError')) await this.commandErrorLog(message, command, params, error);
 		return message.reject(message.language.get('COMMAND_ERROR'));
 	}

diff --git a/src/events/rtbyteEventError.js b/src/events/rtbyteEventError.js
@@ -1,5 +1,6 @@
 const { Event } = require('klasa');
 const { MessageEmbed } = require('discord.js');
+const Sentry = require('@sentry/node');
 const errorEvents = ['rtbyteCommandError', 'rtbyteEventError', 'rtbyteFinalizerError', 'rtbyteMonitorError', 'rtbyteTaskError'];
 
 module.exports = class extends Event {
@@ -9,6 +10,13 @@ module.exports = class extends Event {
 	}
 
 	async run(event, args, error) {
+		Sentry.withScope(scope => {
+			scope.setTag('error-type', 'event');
+			scope.setLevel(this.client.options.production ? 'error' : 'debug');
+
+			Sentry.captureException(error);
+		});
+
 		const guild = args[0].guild ? args[0].guild : args[0].message ? args[0].message.guild : args[0];
 		if (this.client.settings.get('logs.eventError') && !errorEvents.includes(event.name)) await this.eventErrorLog(event, args, error, guild);
 	}

diff --git a/src/events/rtbyteFinalizerError.js b/src/events/rtbyteFinalizerError.js
@@ -1,5 +1,6 @@
 const { Event } = require('klasa');
 const { MessageEmbed } = require('discord.js');
+const Sentry = require('@sentry/node');
 
 module.exports = class extends Event {
 
@@ -8,6 +9,14 @@ module.exports = class extends Event {
 	}
 
 	async run(message, command, response, timer, finalizer, error) {
+		Sentry.withScope(scope => {
+			scope.setTag('error-type', 'finalizer');
+			scope.setLevel(this.client.options.production ? 'error' : 'debug');
+			scope.setContext('Message', message);
+
+			Sentry.captureException(error);
+		});
+
 		if (this.client.settings.get('logs.finalizerError')) await this.finalizerErrorLog(message, command, response, timer, finalizer, error);
 	}
 

diff --git a/src/events/rtbyteMonitorError.js b/src/events/rtbyteMonitorError.js
@@ -1,5 +1,6 @@
 const { Event } = require('klasa');
 const { MessageEmbed } = require('discord.js');
+const Sentry = require('@sentry/node');
 
 module.exports = class extends Event {
 
@@ -8,6 +9,14 @@ module.exports = class extends Event {
 	}
 
 	async run(message, monitor, error) {
+		Sentry.withScope(scope => {
+			scope.setTag('error-type', 'monitor');
+			scope.setLevel(this.client.options.production ? 'error' : 'debug');
+			scope.setContext('Message', message);
+
+			Sentry.captureException(error);
+		});
+
 		if (this.client.settings.get('logs.monitorError')) await this.monitorErrorLog(message, monitor, error);
 	}
 

diff --git a/src/events/rtbyteTaskError.js b/src/events/rtbyteTaskError.js
@@ -1,5 +1,6 @@
 const { Event } = require('klasa');
 const { MessageEmbed } = require('discord.js');
+const Sentry = require('@sentry/node');
 
 module.exports = class extends Event {
 
@@ -8,6 +9,14 @@ module.exports = class extends Event {
 	}
 
 	async run(scheduledTask, task, error) {
+		Sentry.withScope(scope => {
+			scope.setTag('error-type', 'task');
+			scope.setLevel(this.client.options.production ? 'error' : 'debug');
+			scope.setContext(scheduledTask);
+
+			Sentry.captureException(error);
+		});
+
 		if (this.client.settings.get('logs.taskError')) await this.eventErrorLog(scheduledTask, task, error);
 	}
 

diff --git a/src/index.js b/src/index.js
@@ -1,6 +1,7 @@
 module.exports = {
 	Client: require('./lib/RTByteClient'),
 	RTByteClient: require('./lib/RTByteClient'),
+	RTByteSentry: require('./lib/RTByteSentry'),
 	ModCase: require('./lib/structures/ModCase'),
 	ModEmbed: require('./lib/structures/ModEmbed'),
 	Util: require('./lib/util/Util')

diff --git a/src/lib/RTByteSentry.js b/src/lib/RTByteSentry.js
@@ -0,0 +1,21 @@
+const { version: klasaVersion } = require('klasa');
+const { version: discordVersion } = require('discord.js');
+const { sentryIngestURL } = require('../config');
+const Sentry = require('@sentry/node');
+const os = require('os');
+
+Sentry.init({
+	dsn: sentryIngestURL,
+	// eslint-disable-next-line no-process-env
+	release: `rtbyte@${process.env.npm_package_version}`
+});
+
+Sentry.configureScope(scope => {
+	scope.setTags({
+		host: `${os.hostname}`,
+		'klasa-version': klasaVersion,
+		'd.js-version': discordVersion
+	});
+});
+
+if (sentryIngestURL) console.log('Sentry.io error reporting is active.');