ntlogger 2.5.1 → 2.5.2

package/index.js

@@ -12,29 +12,32 @@
 
 /**
  * Change Log:
+ * 
+ * v2.5.2 - 08/11/2024:
+ * [BUG] Fixed an issue where the /plugins/lib folder was not being pushed to npmjs.com.
  *
  * v2.5.1 - 08/10/2024:
- * [Bug] Fixed a bug where Jest plugin was not working due to a missing config parameter. This rule was not originally enforced until v2.5.0.
+ * [BUG] Fixed a bug where Jest plugin was not working due to a missing config parameter. This rule was not originally enforced until v2.5.0.
  *
  * v2.5.0 - 08/10/2024:
  * [NOTE] Syslog plugin can send logs using TLS but it is not tested. Avoid sensitive data.
- * [Feature] Added a plugin for Discord webhook integration, allowing log messages to be sent directly to a specified Discord channel.
- * [Feature] Added a plugin for Syslog server integration, enabling log messages to be sent to a Syslog server using UDP, TCP, or TLS protocols.
- * [Feature] Implemented clean signal handling for graceful shutdowns (SIGINT, SIGTERM).
+ * [FEATURE] Added a plugin for Discord webhook integration, allowing log messages to be sent directly to a specified Discord channel.
+ * [FEATURE] Added a plugin for Syslog server integration, enabling log messages to be sent to a Syslog server using UDP, TCP, or TLS protocols.
+ * [FEATURE] Implemented clean signal handling for graceful shutdowns (SIGINT, SIGTERM).
  *
- * [Update] @sentry/node            ^8.17.0 --> ^8.25.0
- * [Update] mysql2                  ^3.10.2 --> ^3.11.0
- * [Update] winston                 ^3.13.1 --> ^3.14.1
- * [Update] @sentry/profiling-node  ^8.17.0 --> ^8.25.0
- * [Update] jest                    ^29.0.0 --> ^29.7.0
+ * [UPDATED] @sentry/node            ^8.17.0 --> ^8.25.0
+ * [UPDATED] mysql2                  ^3.10.2 --> ^3.11.0
+ * [UPDATED] winston                 ^3.13.1 --> ^3.14.1
+ * [UPDATED] @sentry/profiling-node  ^8.17.0 --> ^8.25.0
+ * [UPDATED] jest                    ^29.0.0 --> ^29.7.0
  *
  * v2.4.0 - 08/01/2024:
  * [NOTE] Damn its been 4 months.. kinda. forgot to log last changes
  * [CRITICAL] Fixed `includes` in package.json which prevented plugins folder from being pushed to npmjs.com
  * [QA] Added test cases using jest
- * [Feature] Added session ID to logger meta, try `console.log(log.defaultMeta.ID)`
- * [Feature] Created the plugin jest. Added a custom transport for in memory logging and testing
- * [Feature] Created the config var `skipCache` to allow you to create a new logger instance within the same file. (Usual behavior is to return the same instance within the same file)
+ * [FEATURE] Added session ID to logger meta, try `console.log(log.defaultMeta.ID)`
+ * [FEATURE] Created the plugin jest. Added a custom transport for in memory logging and testing
+ * [FEATURE] Created the config var `skipCache` to allow you to create a new logger instance within the same file. (Usual behavior is to return the same instance within the same file)
  *
  * v2.2.3 - 04/01/2024:
  * Reduced GitHub Actions to only NPM publish

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ntlogger",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NightSquawk/NightTimeLogger.git"
@@ -25,7 +25,7 @@
   "files": [
     "index.js",
     "lib/*.js",
-    "plugins/*.js"
+    "plugins/**/*"
   ],
   "license": "GPL-3.0",
   "dependencies": {

package/plugins/README.md

@@ -0,0 +1,163 @@
+# NightTimeLogger Plugins
+
+NightTimeLogger is a powerful and flexible logging utility with various plugins to extend its functionality. This README provides an overview of the available plugins and instructions on how to set them up.
+
+![Discord Plugin Output](https://github.com/NightSquawk/NightTimeLogger/blob/main/images/plugins/pluginDiscordOutput.png)
+
+## Available Plugins
+
+### 1. Discord
+**Description:** Sends logs to a Discord webhook, allowing you to receive log messages directly in a specified Discord channel.
+
+**Setup:**
+```javascript
+{
+    name: 'Discord',
+    config: {
+        webhookUrl: process.env.DISCORD_WEBHOOK_URL || 'https://ptb.discord.com/api/webhooks/1271901134663192658/FmzqFlzbIJ7NunR_4rpBkPLb4QQ5aHSNEbpT311su-QM3ZlGDI6sFuC4Ff0MF_TFrf3k',
+        avatarUrl: process.env.DISCORD_AVATAR_URL || 'https://pbs.twimg.com/profile_images/997535493624508416/V7Ed1k2o_400x400.jpg',
+        username: process.env.DISCORD_USERNAME || 'NTLogger - Info',
+        level: "info",
+        strict: true,
+    },
+}
+```
+
+### 2. Sentry
+Description: Initializes the Sentry SDK for error tracking and defines a custom Winston transport for capturing and sending error logs to Sentry.
+
+Setup:
+
+``` javascript
+{
+    name: 'Sentry',
+    config: {
+        dsn: process.env.SENTRY_DSN || null,
+        release: process.env.SENTRY_RELEASE || null,
+        tracesSampleRate: 1.0,
+        profilesSampleRate: 1.0,
+        environment: process.env.NODE_ENV || 'development',
+        debug: false,
+        attachStacktrace: true,
+        integrations: [
+            nodeProfilingIntegration()
+        ],
+        serverName: null,
+        maxBreadcrumbs: 100,
+        autoSessionTracking: true,
+        sessionTracking: {},
+        tracesSampler: null
+    }
+}
+```
+
+### . MySQL
+Description: Stores logs in a MySQL database, allowing you to persist log messages and analyze them using SQL queries.
+
+Setup:
+
+``` javascript
+{
+    name: 'MySQL',
+    config: {
+        host: process.env.MYSQL_DB_HOST || 'localhost',
+        port: process.env.MYSQL_DB_PORT || 3306,
+        user: process.env.MYSQL_DB_USER || 'root',
+        password: process.env.MYSQL_DB_PASSWORD || '',
+        database: process.env.MYSQL_DB_NAME || 'test',
+        table: process.env.MYSQL_DB_TABLE || 'logs',
+        logLevel: process.env.LOG_LEVEL || 'info',
+    },
+}
+````
+### 4. Jest
+Description: Stores log messages in memory for testing purposes, particularly useful when running tests with Jest.
+
+Setup:
+
+``` javascript
+{
+    name: 'Jest',
+}
+```
+
+### 5. Syslog
+Description: Sends logs to a Syslog server using a custom Syslog client. This allows integration with traditional logging systems that rely on Syslog.
+
+Setup:
+
+``` javascript
+{
+    name: 'Syslog',
+    config: {
+        host: process.env.SYSLOG_HOST || 'localhost',
+        port: process.env.SYSLOG_PORT || 514,
+        protocol: process.env.SYSLOG_PROTOCOL || 'UDP', // Options: 'UDP', 'TCP', 'TLS'
+        rfc: process.env.SYSLOG_RFC || 'RFC-5424', // Options: 'RFC-3164', 'RFC-5424'
+        facility: process.env.SYSLOG_FACILITY || 1, // Local0
+        appName: process.env.SYSLOG_APP_NAME || 'MyApp',
+        level: 'info',
+    },
+}
+```
+
+### Example Logger Configuration
+Here is an example configuration for NightTimeLogger using multiple plugins:
+
+``` javascript
+Copy code
+let config = {
+    level: 'internal',
+    file: false,
+    plugins: [
+        {
+            name: 'Discord',
+            config: {
+                webhookUrl: process.env.DISCORD_WEBHOOK_URL,
+                avatarUrl: process.env.DISCORD_AVATAR_URL,
+                username: process.env.DISCORD_USERNAME || 'MyAppLogger',
+                level: 'info',
+                strict: false,
+            },
+        },
+        {
+            name: 'Sentry',
+            config: {
+                dsn: process.env.SENTRY_DSN,
+                release: process.env.SENTRY_RELEASE,
+                tracesSampleRate: 1.0,
+                environment: process.env.NODE_ENV || 'development',
+            },
+        },
+        {
+            name: 'MySQL',
+            config: {
+                host: process.env.MYSQL_DB_HOST,
+                port: process.env.MYSQL_DB_PORT || 3306,
+                user: process.env.MYSQL_DB_USER || 'root',
+                password: process.env.MYSQL_DB_PASSWORD || '',
+                database: process.env.MYSQL_DB_NAME || 'logs',
+                table: 'log_entries',
+            },
+        },
+        {
+            name: 'Jest',
+        },
+        {
+            name: 'Syslog',
+            config: {
+                host: process.env.SYSLOG_HOST || 'localhost',
+                port: process.env.SYSLOG_PORT || 514,
+                protocol: 'UDP',
+                facility: 1,
+                appName: 'MyAppLogger',
+            },
+        },
+    ],
+};
+```
+
+### Conclusion
+The NightTimeLogger is highly customizable and supports various plugins for different logging requirements. By leveraging these plugins, you can easily integrate logging into your existing infrastructure, whether it be storing logs in databases, sending them to monitoring tools like Sentry, or receiving alerts directly in Discord.
+
+For more details on each plugin, refer to the specific plugin files in the project.

package/plugins/lib/syslogClient.js

@@ -0,0 +1,112 @@
+/**
+ * @file /plugins/lib/syslogClient.js
+ * @description Custom Syslog client supporting UDP, TCP, and TLS transports with RFC-3164 and RFC-5424 formats.
+ */
+
+const net = require('net');
+const tls = require('tls');
+const dgram = require('dgram');
+
+class SyslogClient {
+    constructor(opts = {}) {
+        this.host = opts.host || 'localhost';
+        this.port = opts.port || 514;
+        this.protocol = opts.protocol || 'UDP'; // 'UDP', 'TCP', 'TLS'
+        this.rfc = opts.rfc || 'RFC-5424'; // 'RFC-3164', 'RFC-5424'
+        this.facility = opts.facility || 1; // Default to user-level messages
+        this.appName = opts.appName || 'NTLogger';
+        this.hostname = opts.hostname || require('os').hostname();
+        this.transport = null;
+
+        if (this.protocol === 'UDP') {
+            this.transport = dgram.createSocket('udp4');
+        } else if (this.protocol === 'TCP') {
+            this.transport = new net.Socket();
+        } else if (this.protocol === 'TLS') {
+            this.transport = new tls.TLSSocket();
+        }
+    }
+
+    /**
+     * Connects to the Syslog server if using TCP or TLS.
+     */
+    connect() {
+        if (this.protocol === 'TCP' || this.protocol === 'TLS') {
+            return new Promise((resolve, reject) => {
+                const options = { host: this.host, port: this.port };
+                const connectListener = () => resolve();
+                const errorListener = (err) => reject(err);
+
+                if (this.protocol === 'TCP') {
+                    this.transport.connect(options, connectListener).on('error', errorListener);
+                } else if (this.protocol === 'TLS') {
+                    this.transport.connect(options, connectListener).on('error', errorListener);
+                }
+            });
+        }
+    }
+
+    /**
+     * Sends a log message to the Syslog server.
+     * @param {string} severity - The severity level of the log.
+     * @param {string} message - The log message.
+     * @param {object} [meta] - Additional metadata for RFC-5424 structured data.
+     */
+    send(severity, message, meta = {}) {
+        const formattedMessage = this.formatMessage(severity, message, meta);
+        if (this.protocol === 'UDP') {
+            this.transport.send(Buffer.from(formattedMessage), 0, formattedMessage.length, this.port, this.host);
+        } else {
+            this.transport.write(formattedMessage + '\n');
+        }
+    }
+
+    /**
+     * Formats the Syslog message according to the selected RFC standard.
+     * @param {string} severity - The severity level of the log.
+     * @param {string} message - The log message.
+     * @param {object} [meta] - Additional metadata for RFC-5424 structured data.
+     * @returns {string} - The formatted Syslog message.
+     */
+    formatMessage(severity, message, meta) {
+        const timestamp = new Date().toISOString();
+        const priority = (this.facility * 8) + severity;
+
+        if (this.rfc === 'RFC-3164') {
+            return `<${priority}>${timestamp} ${this.hostname} ${this.appName}: ${message}`;
+        } else if (this.rfc === 'RFC-5424') {
+            const structuredData = this.formatStructuredData(meta.structuredData || {});
+            return `<${priority}>1 ${timestamp} ${this.hostname} ${this.appName} - - ${structuredData} ${message}`;
+        }
+    }
+
+    /**
+     * Formats the structured data for RFC-5424.
+     * @param {object} structuredData - The structured data to include in the log message.
+     * @returns {string} - The formatted structured data string.
+     */
+    formatStructuredData(structuredData) {
+        let sdString = '';
+        for (const [key, value] of Object.entries(structuredData)) {
+            sdString += `[${key}`;
+            for (const [param, val] of Object.entries(value)) {
+                sdString += ` ${param}="${val}"`;
+            }
+            sdString += ']';
+        }
+        return sdString || '-';
+    }
+
+    /**
+     * Closes the transport connection.
+     */
+    close() {
+        if (this.transport && (this.protocol === 'TCP' || this.protocol === 'TLS')) {
+            this.transport.end();
+        } else if (this.protocol === 'UDP') {
+            this.transport.close();
+        }
+    }
+}
+
+module.exports = SyslogClient;