mirror of
https://github.com/strapi/strapi.git
synced 2025-07-22 16:37:13 +00:00
80 lines
2.1 KiB
JavaScript
80 lines
2.1 KiB
JavaScript
![]() |
'use strict';
|
||
|
|
||
|
const Sentry = require('@sentry/node');
|
||
|
const defaultSettings = require('../config/settings.json');
|
||
|
|
||
|
module.exports = {
|
||
|
isReady: false,
|
||
|
_instance: null,
|
||
|
|
||
|
/**
|
||
|
* Initialize Sentry service
|
||
|
*/
|
||
|
init() {
|
||
|
// Make sure there isn't a Sentry instance already running
|
||
|
if (this._instance != null) {
|
||
|
strapi.log.warn('Sentry has already been initialized');
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
// Retrieve user settings and merge them with the default ones
|
||
|
const settings = {
|
||
|
...defaultSettings,
|
||
|
...strapi.plugins.sentry.config,
|
||
|
};
|
||
|
|
||
|
// Try to initialize Sentry using the config's DSN
|
||
|
try {
|
||
|
// Don't init Sentry if the user has disabled it
|
||
|
if (!settings.disabled) {
|
||
|
Sentry.init({
|
||
|
dsn: settings.config.dsn,
|
||
|
environment: strapi.config.environment,
|
||
|
});
|
||
|
// Store the successfully initialized Sentry instance
|
||
|
this._instance = Sentry;
|
||
|
this.isReady = true;
|
||
|
}
|
||
|
} catch (error) {
|
||
|
strapi.log.warn('Could not set up Sentry, make sure you entered a valid DSN');
|
||
|
}
|
||
|
},
|
||
|
|
||
|
/**
|
||
|
* Expose Sentry instance through a getter
|
||
|
* @returns {Sentry}
|
||
|
*/
|
||
|
getInstance() {
|
||
|
return this._instance;
|
||
|
},
|
||
|
|
||
|
/**
|
||
|
* Callback to [configure an instance of Sentry's scope]{@link https://docs.sentry.io/platforms/node/enriching-events/scopes/#configuring-the-scope}
|
||
|
* @callback configureScope
|
||
|
* @param {Sentry.scope} scope
|
||
|
* @param {Sentry=} instance An initialized Sentry instance
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* Higher level method to send exception events to Sentry
|
||
|
* @param {Error} error An error object
|
||
|
* @param {configureScope=} configureScope
|
||
|
*/
|
||
|
sendError(error, configureScope) {
|
||
|
// Make sure Sentry is ready
|
||
|
if (!this.isReady) {
|
||
|
strapi.log.warn("Sentry wasn't properly initialized, cannot send event");
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
this._instance.withScope(scope => {
|
||
|
// Configure the Sentry scope using the provided callback
|
||
|
configureScope(scope, this._instance);
|
||
|
// Actually send the Error to Sentry
|
||
|
this._instance.captureException(error);
|
||
|
});
|
||
|
|
||
|
strapi.log.info('An error was sent to Sentry');
|
||
|
},
|
||
|
};
|