Navy.gif/logger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: Navy.gif:4e6b3418df9c3530c46480abdcfef4a5a3d7df80
Branches Tags
Navy.gif:master
..
compare: Navy.gif:23d880e96d9dc3c0fd7b32ee7f158a7ddc4e44d9
Branches Tags
Navy.gif:master

No commits in common. "4e6b3418df9c3530c46480abdcfef4a5a3d7df80" and "23d880e96d9dc3c0fd7b32ee7f158a7ddc4e44d9" have entirely different histories.
4e6b3418df ... 23d880e96d

8 changed files with 46 additions and 124 deletions
Show Stats Expand all files Collapse all files

2
.eslintrc.json
View File

@ -161,7 +161,7 @@
"no-var": "warn",
"no-void": "warn",
"no-whitespace-before-property": "error",
"nonblock-statement-body-position": ["warn", "below"],
"nonblock-statement-body-position": "warn",
"object-curly-spacing": [
"warn",
"always"

8
README.md
View File

@ -3,6 +3,7 @@
Simple logger I wrote to have a unified system for logging throughout my projects.
## TODO
- Automatic file rotation, currently only rotates files on startup
- Discord webhook, need to write a separate package for that, don't want to add the entirety of d.js as a dep just for a webhook
## Features
@ -18,15 +19,10 @@ The child processes are expected to be attached with the attach() method found i
## Logger Options
```
{
//////// SHARED BETWEEN CLIENT & MASTER
guard: '_logger', // Message guard, e.g this property has to be true in the IPC message for the logger to read it
debug: false, // On the master logger this determines whether the output is written to console (i.e. will always be written to file), on the client this determines whether it is sent to the master at all
customTypes: [], // Log types, defaults are 'error', 'warn', 'info', 'debug', 'status'. Each one of these has an associated shorthand function, the custom ones will receive one too, e.g. adding 'access' to the custom types will add a logger.access() function
/////// MASTER EXCLUSIVE
customStreams: [], // File streams, by default there are streams for error and default
customTypeMapping: {}, // This maps a type to a stream, e.g. adding "warn": "error" will pipe any warnings to the error log file
customColors: {}, // Supports any colours chalk.js supports, e.g. "warn": "green" will turn warning outputs green
fileRotationFreq: 1, // How frequently to roate files in days - will not work with anything less than 1 day currently
directory: './logs', // Directory in which to write log files
debug: false
}
```

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "@navy.gif/logger",
"version": "1.2.0",
"version": "1.1.9",
"description": "Logging thing",
"main": "index.js",
"author": "Navy.gif",

15
src/Defaults.js
View File

@ -22,20 +22,5 @@ module.exports = {
info: 0x76a9d8,
debug: 0xd8abd7,
status: 0x72d4d7
},
MasterOptions: {
fileRotationFreq: 1,
directory: './logs',
customTypes: [],
customStreams: [],
customTypeMapping: {},
customColors: {},
debug: false,
guard: '_logger'
},
ClientOptions: {
debug: true,
guard: '_logger',
customStreams: []
}
};

20
src/LoggerClient.js
View File

@ -4,15 +4,13 @@ class LoggerClient {
static MaxChars = 0;
constructor (opts = Defaults.ClientOptions) {
constructor (opts) {
this.name = opts.name || opts.constructor.name;
if (this.name === 'Object')
this.name = 'unknown';
if (this.name === 'Object') this.name = 'unknown';
this.name = this.name.toUpperCase();
if (this.name.length > LoggerClient.MaxChars)
LoggerClient.MaxChars = this.name.length;
if (this.name.length > LoggerClient.MaxChars) LoggerClient.MaxChars = this.name.length;
const { customTypes = [] } = opts;
this.types = [ ...customTypes, ...Defaults.Types ];
@ -22,23 +20,17 @@ class LoggerClient {
});
}
this.guard = opts.guard || Defaults.ClientOptions.guard;
}
transport (message, opts) {
if (typeof message !== 'string')
message = inspect(message);
if (typeof message !== 'string') message = inspect(message);
const spacer = ' '.repeat(LoggerClient.MaxChars - this.name.length);
const header = `${`[${this.name.substring(0, LoggerClient.MaxChars)}]${spacer}`} `;
// eslint-disable-next-line no-console
if (!process.send || !process.connected)
// eslint-disable-next-line no-console
console.log(`${header} ${message}`);
else
process.send({ [this.guard]: true, header, message, ...opts });
if (!process.send || !process.connected) console.log(`${header} ${message}`);
else process.send({ _logger: true, header, message, ...opts });
}

88
src/MasterLogger.js
View File

@ -8,67 +8,41 @@ const { inspect } = require('node:util');
const Defaults = require('./Defaults');
const DAY = 1000 * 60 * 60 * 24;
const DefaultOpts = {
fileRotationFreq: 1,
directory: './logs',
customTypes: [],
customStreams: [],
customTypeMapping: {},
customColors: {},
debug: false,
guard: '_logger'
};
// TODO:
// - File rotation
// - Discord webhook, need to write a separate package for that, don't want to add the entirety of d.js as a dep just for a webhook
class MasterLogger {
constructor ({
directory = './logs',
customTypes = [],
customStreams = [],
customTypeMapping = {},
customColors = {},
debug = false,
guard = '_logger',
fileRotationFreq = 1
} = DefaultOpts) {
constructor (options = {}) {
this.directory = path.resolve(directory);
if (!fs.existsSync(this.directory))
fs.mkdirSync(this.directory, { recursive: true });
this.directory = path.resolve(options.directory || './logs');
if (!fs.existsSync(this.directory)) fs.mkdirSync(this.directory, { recursive: true });
const { customTypes = [], customStreams = [], customTypeMapping = {}, customColors = {}, debug = false } = options;
this._debug = debug;
this.types = [ ...customTypes, ...Defaults.Types ];
for (const type of this.types) {
Object.defineProperty(this, type, {
value: (msg, opts) => this.write(type, msg, opts)
// Only write debug outputs if debug mode is enabled
value: (msg, opts) => msg.type === 'debug' && debug || msg.type !== 'debug'
? this.write(type, msg, opts) : null
});
}
this.colours = { ...Defaults.Colours, ...customColors };
this.streamTypes = [ ...customStreams, 'error', 'default' ];
this.streamTypeMapping = { ...Defaults.TypeStream, ...customTypeMapping };
// eslint-disable-next-line no-return-assign
this.writeStreams = this.streamTypes.reduce((acc, type) => {
acc[type] = this.loadFile(type);
return acc;
}, {});
// Startup day, used to keep track of file rotation
this.rotationFreq = fileRotationFreq * DAY;
this.startDay = Math.floor(Date.now() / this.rotationFreq) * this.rotationFreq;
this.rotateTO = setTimeout(this.rotateLogFiles.bind(this), this.startDay + this.rotationFreq - Date.now());
this.guard = guard;
}
attach (shard) {
shard.on('message', (msg) => {
if (!msg[this.guard])
return;
if (!msg._logger) return;
const { message, type, header, broadcast } = msg;
this[type](message, { subheader: header, shard, broadcast });
});
@ -78,62 +52,42 @@ class MasterLogger {
type = type.toLowerCase();
let colour = this.colours[type];
if (!colour)
colour = this.colours.info;
if (!colour) colour = this.colours.info;
if (typeof text !== 'string')
text = inspect(text);
if (typeof text !== 'string') text = inspect(text);
const header = `[${this.date}] [${this._shard(shard)}]`;
const maxChars = Math.max(...this.types.map(t => t.length));
const spacer = ' '.repeat(maxChars - type.length);
if (type === 'debug' && this._debug || type !== 'debug')
console.log(`${chalk[colour](type)}${spacer} ${chalk[colour](header)}: ${chalk.bold(subheader)}${text}`); // eslint-disable-line no-console
console.log(`${chalk[colour](type)}${spacer} ${chalk[colour](header)}: ${chalk.bold(subheader)}${text}`); // eslint-disable-line no-console
if (broadcast) {
// Send to webhook - TODO
}
const streamType = this.streamTypeMapping[type] || 'default';
if (this.writeStreams[streamType])
this.writeStreams[streamType].write(`\n${type}${spacer} ${header}: ${subheader}${text}`);
else
console.log(`${chalk.red(`[LOGGER] Missing file stream for ${streamType}`)}`); // eslint-disable-line no-console
if (this.writeStreams[streamType]) this.writeStreams[streamType].write(`\n${type}${spacer} ${header}: ${subheader}${text}`);
else console.log(`${chalk.red(`[LOGGER] Missing file stream for ${streamType}`)}`); // eslint-disable-line no-console
}
rotateLogFiles () {
const streams = Object.keys(this.writeStreams);
for (const type of streams) {
this.writeStreams[type].write('\nRotating log file');
this.writeStreams[type].end();
this.writeStreams[type] = this.loadFile(type);
}
const nextTime = Math.floor(Date.now() / this.rotationFreq) * this.rotationFreq + this.rotationFreq;
this.rotateTO = setTimeout(this.rotateLogFiles.bind(this), nextTime - Date.now());
}
loadFile (type) {
if (!type) throw new Error('Missing file type');
loadFile (type, date = Date.now()) {
if (!type)
throw new Error('Missing file type');
const fileName = `${moment(date).format('YYYY-MM-DD')}-${type}-${date}.log`;
const fileName = `${moment().format('YYYY-MM-DD')}-${type}.log`;
const filePath = path.join(this.directory, fileName);
if (!fs.existsSync(filePath))
fs.writeFileSync(filePath, '');
if (!fs.existsSync(filePath)) fs.writeFileSync(filePath, '');
return fs.createWriteStream(filePath, { flags: 'a' });
}
_shard (shard) {
if (!shard)
return 'controller';
if (!shard) return 'controller';
let id = '??';
if ('id' in shard)
id = `${shard.id < 10 ? `0${shard.id}` : shard.id}`;
if ('id' in shard) id = `${shard.id < 10 ? `0${shard.id}` : shard.id}`;
return `shard-${id}`;
}

20
test/otherProcess.js
View File

@ -8,17 +8,9 @@ const logger = new LoggerClient({
customColors: { access: 'green' }
});
const main = async () => {
for (let i = 0; i < 10000; i++) {
if (i % 500 === 0)
await new Promise(resolve => setTimeout(resolve, 1000));
logger.info('Info test');
logger.status('Status test');
logger.debug('Debug test');
logger.warn('Warn test');
logger.error('Error test');
logger.access('Access test');
}
};
main();
logger.info('Info test');
logger.status('Status test');
logger.debug('Debug test');
logger.warn('Warn test');
logger.error('Error test');
logger.access('Access test');

15
test/test.js
View File

@ -15,8 +15,7 @@ const main = async () => {
customTypes: [ 'access' ],
customStreams: [ 'access' ],
customTypeMapping: { access: 'access', warn: 'error' },
customColors: { access: 'green' },
fileRotationFreq: 0.0001
customColors: { access: 'green' }
});
const child = ChildProcess.fork('./test/otherProcess.js');
logger.attach(child);
@ -26,9 +25,13 @@ const main = async () => {
const { types, colours, streamTypes, streamTypeMapping } = logger; // , writeStreams
console.log(types, colours, streamTypes, streamTypeMapping); // , writeStreams
for (let i = 0; i < 10; i++) {
await new Promise((resolve) => setTimeout(resolve, 1000));
logger.info(`Iteration ${i}`);
}
logger.info('Info test');
logger.status('Status test');
logger.debug('Debug test');
logger.warn('Warn test');
logger.error('Error test');
logger.access('Access test');
for (let i = 0; i < 10; i++) await new Promise((resolve) => setTimeout(resolve, 1000));
};
main();