@bsb/syslog 9.0.0

package/lib/plugins/service-syslog-server/index.js

@@ -0,0 +1,148 @@
+"use strict";
+/**
+ * BSB (Better-Service-Base) is an event-bus based microservice framework.
+ * Copyright (C) 2016 - 2025 BetterCorp (PTY) Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alternatively, you may obtain a commercial license for this program.
+ * The commercial license allows you to use the Program in a closed-source manner,
+ * including the right to create derivative works that are not subject to the terms
+ * of the AGPL.
+ *
+ * To obtain a commercial license, please contact the copyright holders at
+ * https://www.bettercorp.dev. The terms and conditions of the commercial license
+ * will be provided upon request.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = exports.Plugin = exports.EventSchemas = exports.Config = exports.SyslogServerConfigSchema = exports.SyslogMessageSchema = void 0;
+const SyslogServer = require("syslog-server");
+const base_1 = require("@bsb/base");
+const zod_1 = require("zod");
+const base_2 = require("@bsb/base");
+/**
+ * Syslog message structure
+ */
+exports.SyslogMessageSchema = zod_1.z.object({
+    gatewayTime: zod_1.z.number(),
+    date: zod_1.z.number(),
+    host: zod_1.z.string(),
+    protocol: zod_1.z.string(),
+    message: zod_1.z.string(),
+});
+/**
+ * Configuration schema for syslog server
+ */
+exports.SyslogServerConfigSchema = zod_1.z.object({
+    port: zod_1.z.number().int().min(1).max(65535).default(514),
+    address: zod_1.z.string().default("0.0.0.0"),
+    exclusive: zod_1.z.boolean().default(false),
+});
+exports.Config = (0, base_1.createConfigSchema)({
+    name: 'service-syslog-server',
+    description: 'Syslog server service plugin that receives messages and emits events',
+    version: '9.0.0',
+    image: './assets/syslog-icon.png',
+    tags: ['syslog', 'server', 'service', 'events'],
+}, exports.SyslogServerConfigSchema);
+/**
+ * Event schemas for syslog server
+ */
+exports.EventSchemas = {
+    emitEvents: {
+        onMessage: (0, base_2.createFireAndForgetEvent)(base_1.bsb.object({
+            gatewayTime: base_1.bsb.number({ description: "Gateway timestamp (epoch ms)" }),
+            date: base_1.bsb.number({ description: "Original syslog timestamp (epoch ms)" }),
+            host: base_1.bsb.string({ description: "Source host" }),
+            protocol: base_1.bsb.string({ description: "Transport protocol" }),
+            message: base_1.bsb.string({ description: "Syslog message content" }),
+        }, "Syslog message payload"), "Syslog message received from client"),
+    },
+    onEvents: {},
+    emitReturnableEvents: {},
+    onReturnableEvents: {},
+    emitBroadcast: {},
+    onBroadcast: {},
+};
+/**
+ * Syslog server service plugin - receives syslog messages
+ */
+class Plugin extends base_1.BSBService {
+    static Config = exports.Config;
+    static EventSchemas = exports.EventSchemas;
+    initBeforePlugins;
+    initAfterPlugins;
+    runBeforePlugins;
+    runAfterPlugins;
+    _server;
+    constructor(config) {
+        super({
+            ...config,
+            eventSchemas: exports.EventSchemas,
+        });
+    }
+    async init() {
+        // No initialization needed
+    }
+    async run(obs) {
+        this._server = new SyslogServer();
+        this._server.on("message", (value) => {
+            obs.log.info("Syslog message from {host}: {message}", {
+                host: value.host,
+                message: value.message,
+            });
+            this.events.emitEvent("onMessage", obs, {
+                gatewayTime: Date.now(),
+                date: new Date(value.date).getTime(),
+                host: value.host,
+                protocol: value.protocol,
+                message: value.message,
+            });
+        });
+        this._server.start({
+            port: this.config.port,
+            address: this.config.address,
+            exclusive: this.config.exclusive,
+        });
+        obs.log.info("Syslog server listening on {address}:{port}", {
+            address: this.config.address,
+            port: this.config.port.toString(),
+        });
+    }
+    dispose() {
+        if (this._server) {
+            this._server.stop();
+            this._server = null;
+        }
+    }
+}
+exports.Plugin = Plugin;
+/**
+ * Syslog server client - allows other services to subscribe to syslog messages
+ */
+class Client extends base_1.BSBServiceClient {
+    initBeforePlugins;
+    initAfterPlugins;
+    runBeforePlugins;
+    runAfterPlugins;
+    pluginName = "service-syslog-server";
+    async init(obs) {
+        // Clients can subscribe to onMessage event to receive syslog messages
+        // Example:
+        // this.events.onEvent("onMessage", obs, async (obs, message) => {
+        //   obs.log.info("Received syslog: {message}", { message: message.message });
+        // });
+    }
+}
+exports.Client = Client;

package/lib/schemas/observable-syslog.json

@@ -0,0 +1,133 @@
+{
+  "pluginName": "observable-syslog",
+  "version": "9.0.0",
+  "events": {},
+  "configSchema": {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+      "host": {
+        "default": "localhost",
+        "type": "string"
+      },
+      "port": {
+        "default": 514,
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 65535
+      },
+      "protocol": {
+        "default": "udp",
+        "type": "string",
+        "enum": [
+          "udp",
+          "tcp",
+          "tls"
+        ]
+      },
+      "tls": {
+        "type": "object",
+        "properties": {
+          "rejectUnauthorized": {
+            "default": true,
+            "type": "boolean"
+          },
+          "ca": {
+            "type": "string"
+          },
+          "cert": {
+            "type": "string"
+          },
+          "key": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "rejectUnauthorized"
+        ],
+        "additionalProperties": false
+      },
+      "facility": {
+        "default": 16,
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 23
+      },
+      "hostname": {
+        "type": "string"
+      },
+      "appName": {
+        "default": "bsb-app",
+        "type": "string"
+      },
+      "rfc": {
+        "default": "5424",
+        "type": "string",
+        "enum": [
+          "3164",
+          "5424"
+        ]
+      },
+      "levels": {
+        "type": "object",
+        "properties": {
+          "debug": {
+            "default": true,
+            "type": "boolean"
+          },
+          "info": {
+            "default": true,
+            "type": "boolean"
+          },
+          "warn": {
+            "default": true,
+            "type": "boolean"
+          },
+          "error": {
+            "default": true,
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "debug",
+          "info",
+          "warn",
+          "error"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "required": [
+      "host",
+      "port",
+      "protocol",
+      "facility",
+      "appName",
+      "rfc",
+      "levels"
+    ],
+    "additionalProperties": false
+  },
+  "pluginType": "observable",
+  "capabilities": {
+    "logging": {
+      "debug": true,
+      "info": true,
+      "warn": true,
+      "error": true
+    },
+    "metrics": {
+      "createCounter": false,
+      "createGauge": false,
+      "createHistogram": false,
+      "incrementCounter": false,
+      "setGauge": false,
+      "observeHistogram": false
+    },
+    "tracing": {
+      "spanStart": false,
+      "spanEnd": false,
+      "spanError": false
+    }
+  }
+}

package/lib/schemas/observable-syslog.plugin.json

@@ -0,0 +1,122 @@
+{
+  "id": "observable-syslog",
+  "name": "observable-syslog",
+  "version": "9.0.0",
+  "description": "Syslog client observable plugin for forwarding logs to syslog servers",
+  "category": "observable",
+  "tags": [
+    "syslog",
+    "logging",
+    "observable",
+    "network"
+  ],
+  "documentation": [],
+  "dependencies": [],
+  "image": "./assets/syslog-icon.png",
+  "configSchema": {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+      "host": {
+        "default": "localhost",
+        "type": "string"
+      },
+      "port": {
+        "default": 514,
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 65535
+      },
+      "protocol": {
+        "default": "udp",
+        "type": "string",
+        "enum": [
+          "udp",
+          "tcp",
+          "tls"
+        ]
+      },
+      "tls": {
+        "type": "object",
+        "properties": {
+          "rejectUnauthorized": {
+            "default": true,
+            "type": "boolean"
+          },
+          "ca": {
+            "type": "string"
+          },
+          "cert": {
+            "type": "string"
+          },
+          "key": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "rejectUnauthorized"
+        ],
+        "additionalProperties": false
+      },
+      "facility": {
+        "default": 16,
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 23
+      },
+      "hostname": {
+        "type": "string"
+      },
+      "appName": {
+        "default": "bsb-app",
+        "type": "string"
+      },
+      "rfc": {
+        "default": "5424",
+        "type": "string",
+        "enum": [
+          "3164",
+          "5424"
+        ]
+      },
+      "levels": {
+        "type": "object",
+        "properties": {
+          "debug": {
+            "default": true,
+            "type": "boolean"
+          },
+          "info": {
+            "default": true,
+            "type": "boolean"
+          },
+          "warn": {
+            "default": true,
+            "type": "boolean"
+          },
+          "error": {
+            "default": true,
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "debug",
+          "info",
+          "warn",
+          "error"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "required": [
+      "host",
+      "port",
+      "protocol",
+      "facility",
+      "appName",
+      "rfc",
+      "levels"
+    ],
+    "additionalProperties": false
+  }
+}

package/lib/schemas/service-syslog-server.json

@@ -0,0 +1,74 @@
+{
+  "pluginName": "service-syslog-server",
+  "version": "9.0.0",
+  "events": {
+    "onMessage": {
+      "type": "fire-and-forget",
+      "category": "emitEvents",
+      "description": "Syslog message received from client",
+      "inputSchema": {
+        "description": "Syslog message payload",
+        "type": "object",
+        "properties": {
+          "gatewayTime": {
+            "description": "Gateway timestamp (epoch ms)",
+            "type": "number",
+            "format": "double"
+          },
+          "date": {
+            "description": "Original syslog timestamp (epoch ms)",
+            "type": "number",
+            "format": "double"
+          },
+          "host": {
+            "description": "Source host",
+            "type": "string"
+          },
+          "protocol": {
+            "description": "Transport protocol",
+            "type": "string"
+          },
+          "message": {
+            "description": "Syslog message content",
+            "type": "string"
+          }
+        },
+        "required": [
+          "gatewayTime",
+          "date",
+          "host",
+          "protocol",
+          "message"
+        ]
+      },
+      "outputSchema": null
+    }
+  },
+  "configSchema": {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+      "port": {
+        "default": 514,
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 65535
+      },
+      "address": {
+        "default": "0.0.0.0",
+        "type": "string"
+      },
+      "exclusive": {
+        "default": false,
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "port",
+      "address",
+      "exclusive"
+    ],
+    "additionalProperties": false
+  },
+  "pluginType": "service"
+}

package/lib/schemas/service-syslog-server.plugin.json

@@ -0,0 +1,42 @@
+{
+  "id": "service-syslog-server",
+  "name": "service-syslog-server",
+  "version": "9.0.0",
+  "description": "Syslog server service plugin that receives messages and emits events",
+  "category": "service",
+  "tags": [
+    "syslog",
+    "server",
+    "service",
+    "events"
+  ],
+  "documentation": [],
+  "dependencies": [],
+  "image": "./assets/syslog-icon.png",
+  "configSchema": {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+      "port": {
+        "default": 514,
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 65535
+      },
+      "address": {
+        "default": "0.0.0.0",
+        "type": "string"
+      },
+      "exclusive": {
+        "default": false,
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "port",
+      "address",
+      "exclusive"
+    ],
+    "additionalProperties": false
+  }
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@bsb/syslog",
+  "version": "9.0.0",
+  "license": "(AGPL-3.0-only OR Commercial)",
+  "author": {
+    "name": "BetterCorp (PTY) Ltd",
+    "email": "nick@bettercorp.dev",
+    "url": "https://bettercorp.dev/"
+  },
+  "description": "Syslog server and client for BSB - receive syslog messages and send logs to syslog servers",
+  "keywords": [
+    "bsb",
+    "syslog",
+    "server",
+    "client",
+    "observable",
+    "rfc5424"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BetterCorp/better-service-base.git",
+    "directory": "plugins/nodejs/syslog"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "clean": "bsb-plugin-cli clean",
+    "build": "bsb-plugin-cli build",
+    "start": "bsb-plugin-cli start",
+    "dev": "bsb-plugin-cli dev",
+    "test": "bsb-plugin-cli test",
+    "publish:client": "bsb client publish",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@bsb/base": "^9.0.0"
+  },
+  "dependencies": {
+    "syslog-client": "^1.1.1",
+    "syslog-server": "^1.0.1",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@bsb/base": "file:../../../nodejs",
+    "@types/node": "^25.0.0",
+    "mocha": "^11.0.0",
+    "typescript": "^5.9.0"
+  },
+  "engines": {
+    "node": ">=23.0.0",
+    "npm": ">=11.0.0"
+  },
+  "homepage": "https://io.bsbcode.dev/plugins/bsb/syslog"
+}
+