-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.js
264 lines (246 loc) · 11.5 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
const { PluginBase } = require('@iobroker/plugin-base');
class SentryPlugin extends PluginBase {
/**
* Register and initialize Sentry
*
* @param {Record<string, any>} pluginConfig plugin configuration from config files
* @param {import('@iobroker/plugin-base').InitCallback} callback Will be called when done
*/
async init(pluginConfig, callback) {
this.reallyEnabled = false;
if (!pluginConfig.enabled) {
this.log.info('Sentry Plugin disabled by user');
return callback && callback(null, false);
}
if (!pluginConfig.dsn) {
return (
callback &&
callback(new Error('Invalid Sentry definition, no dsn provided. Disable error reporting'), false)
);
}
// turn off on Travis, Appveyor or GitHub actions or other Systems that set "CI=true"
if (process.env.TRAVIS || process.env.APPVEYOR || process.env.CI) {
this.log.info('Sentry Plugin disabled for this process because CI system detected');
return callback && callback(null, true);
}
// turn off is parent Package contains disableDataReporting flag
if (this.parentIoPackage && this.parentIoPackage.common && this.parentIoPackage.common.disableDataReporting) {
this.log.info('Sentry Plugin disabled for this process because data reporting is disabled on instance');
return callback && callback(null, true);
}
// for Adapter also check host disableDataReporting flag
if (
this.pluginScope === this.SCOPES.ADAPTER &&
this.parentIoPackage &&
this.parentIoPackage.common &&
this.parentIoPackage.common.host
) {
let hostObj;
try {
hostObj = await this.getObjectAsync(`system.host.${this.parentIoPackage.common.host}`);
} catch {
// ignore
}
if (hostObj && hostObj.common && hostObj.common.disableDataReporting) {
this.log.info('Sentry Plugin disabled for this process because data reporting is disabled on host');
return callback && callback(null, true);
}
} else if (this.pluginScope === this.SCOPES.CONTROLLER) {
let hostObjName = this.parentNamespace;
if (!hostObjName) {
const posPluginInNamespace = this.pluginNamespace.indexOf('.plugins.sentry');
if (posPluginInNamespace !== -1) {
hostObjName = this.pluginNamespace.substr(0, posPluginInNamespace);
}
}
if (hostObjName) {
let hostObj;
try {
hostObj = await this.getObjectAsync(hostObjName);
} catch {
// ignore
}
if (hostObj && hostObj.common && hostObj.common.disableDataReporting) {
this.log.info('Sentry Plugin disabled for this process because data reporting is disabled on host');
return callback && callback(null, true);
}
}
}
let systemConfig;
try {
systemConfig = await this.getObjectAsync('system.config');
} catch {
// ignore
}
if (!systemConfig || !systemConfig.common || systemConfig.common.diag === 'none') {
this.log.info(
'Sentry Plugin disabled for this process because sending of statistic data is disabled for the system'
);
return callback && callback(null, true);
}
let uuidObj;
try {
uuidObj = await this.getObjectAsync('system.meta.uuid');
} catch {
// ignore
}
let uuid = uuidObj && uuidObj.native ? uuidObj.native.uuid : null;
this._registerSentry(pluginConfig, uuid, callback);
}
_registerSentry(pluginConfig, uuid, callback) {
this.reallyEnabled = true;
// Require needed tooling
this.Sentry = require('@sentry/node');
const SentryIntegrations = require('@sentry/integrations');
// By installing source map support, we get the original source
// locations in error messages
require('source-map-support').install();
let sentryPathWhitelist = [];
if (pluginConfig.pathWhitelist && Array.isArray(pluginConfig.pathWhitelist)) {
sentryPathWhitelist = pluginConfig.pathWhitelist;
}
if (this.parentPackage.name && !sentryPathWhitelist.includes(this.parentPackage.name)) {
sentryPathWhitelist.push(this.parentPackage.name);
}
let sentryPathBlacklist = [];
if (pluginConfig.pathBlacklist && Array.isArray(pluginConfig.pathBlacklist)) {
sentryPathBlacklist = pluginConfig.pathBlacklist;
}
let sentryErrorBlacklist = [];
if (pluginConfig.errorBlacklist && Array.isArray(pluginConfig.errorBlacklist)) {
sentryErrorBlacklist = pluginConfig.errorBlacklist;
}
if (!sentryErrorBlacklist.includes('SyntaxError')) {
sentryErrorBlacklist.push('SyntaxError');
}
this.Sentry.init({
release: this.parentPackage.name + '@' + this.parentPackage.version,
dsn: pluginConfig.dsn,
integrations: [new SentryIntegrations.Dedupe()]
});
this.Sentry.configureScope(scope => {
if (this.parentIoPackage && this.parentIoPackage.common) {
scope.setTag(
'version',
this.parentIoPackage.common.installedVersion || this.parentIoPackage.common.version
);
if (this.parentIoPackage.common.installedFrom) {
scope.setTag('installedFrom', this.parentIoPackage.common.installedFrom);
} else {
scope.setTag(
'installedFrom',
this.parentIoPackage.common.installedVersion || this.parentIoPackage.common.version
);
}
if (this.settings && this.settings.controllerVersion) {
scope.setTag('jsControllerVersion', this.settings.controllerVersion);
}
scope.setTag('osPlatform', process.platform);
scope.setTag('nodejsVersion', process.version);
try {
scope.setTag('plugin-sentry', require('./package.json').version);
} catch {
// ignore
}
if (this.iobrokerConfig) {
if (this.iobrokerConfig.objects && this.iobrokerConfig.objects.type) {
scope.setTag('objectDBType', this.iobrokerConfig.objects.type);
}
if (this.iobrokerConfig.states && this.iobrokerConfig.states.type) {
scope.setTag('statesDBType', this.iobrokerConfig.states.type);
}
}
}
if (uuid) {
scope.setUser({
id: uuid
});
}
scope.addEventProcessor((event, hint) => {
if (!this.isActive) return;
// Try to filter out some events
if (event.exception && event.exception.values && event.exception.values[0]) {
const eventData = event.exception.values[0];
// if error type is one from blacklist we ignore this error
if (eventData.type && sentryErrorBlacklist.includes(eventData.type)) {
return null;
}
// ignore EROFS, ENOSPC and such errors always
let errorText =
hint.originalException && hint.originalException.code
? hint.originalException.code.toString()
: hint.originalException && hint.originalException.message
? hint.originalException.message.toString()
: hint.originalException;
if (
typeof errorText === 'string' &&
(errorText.includes('EROFS') || // Read only FS
errorText.includes('ENOSPC') || // No disk space available
errorText.includes('ENOMEM') || // No memory (RAM) available
errorText.includes('EIO') || // I/O error
errorText.includes('ENXIO') || // I/O error
errorText.includes('EMFILE') || // too many open files
errorText.includes('ENFILE') || // file table overflow
errorText.includes('EBADF')) // Bad file descriptor
) {
return null;
}
if (
eventData.stacktrace &&
eventData.stacktrace.frames &&
Array.isArray(eventData.stacktrace.frames) &&
eventData.stacktrace.frames.length
) {
// if last exception frame is from an nodejs internal method we ignore this error
if (
eventData.stacktrace.frames[eventData.stacktrace.frames.length - 1].filename &&
(eventData.stacktrace.frames[eventData.stacktrace.frames.length - 1].filename.startsWith(
'internal/'
) ||
eventData.stacktrace.frames[eventData.stacktrace.frames.length - 1].filename.startsWith(
'Module.'
))
) {
return null;
}
// Check if any entry is whitelisted from pathWhitelist
const whitelisted = eventData.stacktrace.frames.find(frame => {
if (frame.function && frame.function.startsWith('Module.')) {
return false;
}
if (frame.filename && frame.filename.startsWith('internal/')) {
return false;
}
if (
frame.filename &&
!sentryPathWhitelist.find(path => path && path.length && frame.filename.includes(path))
) {
return false;
}
if (
frame.filename &&
sentryPathBlacklist.find(path => path && path.length && frame.filename.includes(path))
) {
return false;
}
return true;
});
if (!whitelisted) {
return null;
}
}
}
return event;
});
callback && callback(null, true);
});
}
/**
* Return Sentry object. This can be used to send own Messages or such
* @returns {object} Sentry object
*/
getSentryObject() {
return this.Sentry;
}
}
module.exports = SentryPlugin;