@xeplr/logs 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/index.js +10 -0
- package/lib/logger.js +198 -0
- package/package.json +13 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Xeplr
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/index.js
ADDED
package/lib/logger.js
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
var fs = require('fs');
|
|
2
|
+
var path = require('path');
|
|
3
|
+
|
|
4
|
+
var LEVELS = { debug: 1, info: 2, important: 3, error: 4, critical: 5 };
|
|
5
|
+
var LEVEL_NAMES = ['', 'DEBUG', 'INFO', 'IMPORTANT', 'ERROR', 'CRITICAL'];
|
|
6
|
+
|
|
7
|
+
var _config = {
|
|
8
|
+
appName: 'app',
|
|
9
|
+
logDir: './logs',
|
|
10
|
+
fatalThreshold: 4,
|
|
11
|
+
emailThreshold: 5,
|
|
12
|
+
emailTo: null,
|
|
13
|
+
emailService: null,
|
|
14
|
+
isDev: true
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
var _streams = {};
|
|
18
|
+
var _currentDate = null;
|
|
19
|
+
|
|
20
|
+
function configure(config) {
|
|
21
|
+
if (config.appName) _config.appName = config.appName;
|
|
22
|
+
if (config.logDir) _config.logDir = config.logDir;
|
|
23
|
+
if (config.fatalThreshold !== undefined) _config.fatalThreshold = config.fatalThreshold;
|
|
24
|
+
if (config.emailThreshold !== undefined) _config.emailThreshold = config.emailThreshold;
|
|
25
|
+
if (config.emailTo) {
|
|
26
|
+
_config.emailTo = Array.isArray(config.emailTo) ? config.emailTo : [config.emailTo];
|
|
27
|
+
}
|
|
28
|
+
if (config.emailService) _config.emailService = config.emailService;
|
|
29
|
+
if (config.isDev !== undefined) _config.isDev = config.isDev;
|
|
30
|
+
|
|
31
|
+
var dir = path.resolve(_config.logDir);
|
|
32
|
+
if (!fs.existsSync(dir)) {
|
|
33
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function _today() {
|
|
38
|
+
return new Date().toISOString().slice(0, 10);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
function _getStream(sessionId) {
|
|
42
|
+
var today = _today();
|
|
43
|
+
|
|
44
|
+
// Daily rotation — close old streams if date changed
|
|
45
|
+
if (_currentDate && _currentDate !== today) {
|
|
46
|
+
Object.keys(_streams).forEach(function(key) {
|
|
47
|
+
_streams[key].end();
|
|
48
|
+
});
|
|
49
|
+
_streams = {};
|
|
50
|
+
}
|
|
51
|
+
_currentDate = today;
|
|
52
|
+
|
|
53
|
+
var key = sessionId + ':' + today;
|
|
54
|
+
if (!_streams[key]) {
|
|
55
|
+
var dir = path.resolve(_config.logDir);
|
|
56
|
+
if (!fs.existsSync(dir)) {
|
|
57
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
58
|
+
}
|
|
59
|
+
var filename = sessionId + '-' + today + '.log';
|
|
60
|
+
_streams[key] = fs.createWriteStream(path.join(dir, filename), { flags: 'a' });
|
|
61
|
+
}
|
|
62
|
+
return _streams[key];
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function _write(level, sessionId, message, metadata) {
|
|
66
|
+
var levelNum = LEVELS[level] || 2;
|
|
67
|
+
var levelLabel = LEVEL_NAMES[levelNum];
|
|
68
|
+
var ts = new Date().toISOString();
|
|
69
|
+
var sid = sessionId || _config.appName;
|
|
70
|
+
|
|
71
|
+
var line = '[' + ts + '] [' + sid + '] [' + levelLabel + '] ' + message;
|
|
72
|
+
if (metadata) {
|
|
73
|
+
line += ' ' + (typeof metadata === 'string' ? metadata : JSON.stringify(metadata));
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// Always write to file
|
|
77
|
+
var stream = _getStream(_config.appName);
|
|
78
|
+
stream.write(line + '\n');
|
|
79
|
+
|
|
80
|
+
// Console: errors/critical always, rest only in dev or >= fatalThreshold
|
|
81
|
+
if (levelNum >= 4) {
|
|
82
|
+
console.error(line);
|
|
83
|
+
} else if (_config.isDev || levelNum >= _config.fatalThreshold) {
|
|
84
|
+
console.log(line);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
// Email
|
|
88
|
+
if (_config.emailTo && _config.emailService && levelNum >= _config.emailThreshold) {
|
|
89
|
+
_sendAlert(levelLabel, sid, message, metadata);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function _sendAlert(levelLabel, sessionId, message, metadata) {
|
|
94
|
+
var subject = levelLabel + ': [' + _config.appName + '] [' + sessionId + '] ' + message.slice(0, 80);
|
|
95
|
+
var html = '<h2 style="color:red;">' + levelLabel + '</h2>'
|
|
96
|
+
+ '<p><strong>App:</strong> ' + _config.appName + '</p>'
|
|
97
|
+
+ '<p><strong>Session:</strong> ' + sessionId + '</p>'
|
|
98
|
+
+ '<p><strong>Message:</strong> ' + message + '</p>'
|
|
99
|
+
+ (metadata ? '<pre>' + JSON.stringify(metadata, null, 2) + '</pre>' : '');
|
|
100
|
+
|
|
101
|
+
try {
|
|
102
|
+
_config.emailService.send(_config.emailTo, subject, html);
|
|
103
|
+
} catch (e) {
|
|
104
|
+
// Don't let email failure crash the app
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Create a logger bound to a session ID.
|
|
110
|
+
* All methods: debug, info, important, error, critical
|
|
111
|
+
*/
|
|
112
|
+
function createLogger(sessionId) {
|
|
113
|
+
var sid = sessionId || _config.appName;
|
|
114
|
+
return {
|
|
115
|
+
debug: function(msg, meta) { _write('debug', sid, msg, meta); },
|
|
116
|
+
info: function(msg, meta) { _write('info', sid, msg, meta); },
|
|
117
|
+
important: function(msg, meta) { _write('important', sid, msg, meta); },
|
|
118
|
+
error: function(msg, meta) { _write('error', sid, msg, meta); },
|
|
119
|
+
critical: function(msg, meta) { _write('critical', sid, msg, meta); }
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Express middleware — logs request entry/exit.
|
|
125
|
+
* Reads session ID from x-session-id header, or generates one.
|
|
126
|
+
*/
|
|
127
|
+
function requestLogger() {
|
|
128
|
+
return function(req, res, next) {
|
|
129
|
+
var sessionId = req.headers['x-session-id'] || _generateSessionId();
|
|
130
|
+
req.sessionId = sessionId;
|
|
131
|
+
req.log = createLogger(sessionId);
|
|
132
|
+
|
|
133
|
+
var method = req.method;
|
|
134
|
+
var url = req.originalUrl || req.url;
|
|
135
|
+
var entryTime = Date.now();
|
|
136
|
+
|
|
137
|
+
req.log.info('→ ' + method + ' ' + url);
|
|
138
|
+
|
|
139
|
+
var originalEnd = res.end;
|
|
140
|
+
res.end = function() {
|
|
141
|
+
res.end = originalEnd;
|
|
142
|
+
res.end.apply(res, arguments);
|
|
143
|
+
|
|
144
|
+
var duration = Date.now() - entryTime;
|
|
145
|
+
var status = res.statusCode;
|
|
146
|
+
var level = status >= 500 ? 'error' : status >= 400 ? 'important' : 'info';
|
|
147
|
+
_write(level, sessionId, '← ' + method + ' ' + url + ' ' + status + ' ' + duration + 'ms');
|
|
148
|
+
};
|
|
149
|
+
|
|
150
|
+
next();
|
|
151
|
+
};
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
function _generateSessionId() {
|
|
155
|
+
return 'sid-' + Math.random().toString(36).slice(2, 10);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Purge log files older than retentionDays.
|
|
160
|
+
*/
|
|
161
|
+
function purge(retentionDays) {
|
|
162
|
+
var dir = path.resolve(_config.logDir);
|
|
163
|
+
if (!fs.existsSync(dir)) return 0;
|
|
164
|
+
|
|
165
|
+
var cutoff = Date.now() - (retentionDays || 30) * 86400000;
|
|
166
|
+
var files = fs.readdirSync(dir).filter(function(f) { return f.endsWith('.log'); });
|
|
167
|
+
var purged = 0;
|
|
168
|
+
|
|
169
|
+
files.forEach(function(file) {
|
|
170
|
+
var filePath = path.join(dir, file);
|
|
171
|
+
var stat = fs.statSync(filePath);
|
|
172
|
+
if (stat.mtimeMs < cutoff) {
|
|
173
|
+
fs.unlinkSync(filePath);
|
|
174
|
+
purged++;
|
|
175
|
+
}
|
|
176
|
+
});
|
|
177
|
+
|
|
178
|
+
return purged;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Destroy all open streams (for graceful shutdown).
|
|
183
|
+
*/
|
|
184
|
+
function destroy() {
|
|
185
|
+
Object.keys(_streams).forEach(function(key) {
|
|
186
|
+
_streams[key].end();
|
|
187
|
+
});
|
|
188
|
+
_streams = {};
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
module.exports = {
|
|
192
|
+
configure,
|
|
193
|
+
createLogger,
|
|
194
|
+
requestLogger,
|
|
195
|
+
purge,
|
|
196
|
+
destroy,
|
|
197
|
+
LEVELS
|
|
198
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@xeplr/logs",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Text logger with 5 levels, daily rotation, session IDs, and email alerts",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"files": ["index.js", "lib/"],
|
|
7
|
+
"keywords": ["logs", "logging", "session", "text", "rotation"],
|
|
8
|
+
"author": "xeplr",
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"repository": { "type": "git", "url": "https://github.com/Xeplr/xeplr-logs" },
|
|
11
|
+
"publishConfig": { "access": "public" },
|
|
12
|
+
"dependencies": {}
|
|
13
|
+
}
|