Glossy Syslog Parser and Producer

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require()` in an ES Module context (e.g., in a file with `"type": "module"` in package.json or a `.mjs` file).
  fix Ensure your file is treated as a CommonJS module (e.g., `.js` file without `"type": "module"` in package.json), or use dynamic `import('glossy').then(({ Parse }) => ...)` if you need to use `glossy` within an ESM context.

• TypeError: glossy.Parse.parse is not a function

  cause Incorrectly importing or accessing the `Parse` object, possibly trying to call `parse` on the main `glossy` export instead of the `Parse` object.
  fix Ensure you are correctly destructuring `Parse` from the `require` statement: `const { Parse } = require('glossy');` then call `Parse.parse(...)`.

Warnings

• breaking The `glossy` package is effectively abandoned, with its last release over 11 years ago. This means it is unlikely to receive updates for security vulnerabilities, bug fixes, or compatibility with modern Node.js versions or JavaScript language features. It also lacks official TypeScript types, though community types exist (`@types/glossy`).
  Fix: For new projects, consider using actively maintained syslog libraries or implementing custom parsers/producers. For existing projects, thoroughly audit the code, consider vendoring, and implement extensive testing.
• gotcha When producing syslog messages, `glossy.Produce` defaults to the newer RFC 5424 format unless explicitly configured for BSD/RFC 3164 style. This can lead to compatibility issues with older syslog consumers or relays that are not expecting the RFC 5424 format.
  Fix: When initializing `glossy.Produce`, specify `{ type: 'BSD' }` in the constructor options if you need to generate RFC 3164 compliant messages. Example: `new Produce({ type: 'BSD', ...otherOptions })`.
• gotcha The library primarily uses CommonJS `require()` syntax. Direct `import` statements (ESM) will not work without a build step (like Webpack or Rollup) or specific Node.js configuration (`"type": "module"` with CJS interoperability settings).
  Fix: Use `const { Name } = require('glossy');` for all imports. If you must use ESM in your project, you'll need to configure your build system to handle CommonJS modules or use dynamic imports (`import('glossy')`).
• gotcha Binding to privileged ports (like UDP port 514 for syslog) requires elevated permissions on most operating systems. Running a Node.js application as root introduces security risks.
  Fix: Consider running the syslog server on a non-privileged port (e.g., `5514`) and configure your firewall or a dedicated syslog daemon (like `rsyslog` or `syslog-ng`) to forward messages from port 514 to your application's higher port. Alternatively, use operating system capabilities to grant port binding permission without full root access.

Install

• npm install glossy npm
• yarn add glossy yarn
• pnpm add glossy pnpm

Imports

• Parse
  wrong:

  import { Parse } from 'glossy';

  correct:

  const { Parse } = require('glossy');

  Glossy is a CommonJS module. Direct ESM imports like `import` are not supported without a transpiler or specific Node.js configuration for CJS interoperability.
• Produce
  wrong:

  import Produce from 'glossy';

  correct:

  const { Produce } = require('glossy');

  The `Produce` class is a named export, not a default export. Ensure you destructure it from the `require` call.
• glossy.info
  wrong:

  import { info } from 'glossy';

  correct:

  const glossy = require('glossy');
  const infoMsg = glossy.info({ message: 'Info Message' });

  Utility functions like `info` are exposed directly on the main `glossy` export, not as individual named exports.

Quickstart

Demonstrates setting up a UDP server to listen for incoming syslog messages on port 514 and parse them using `glossy.Parse`. It logs the host and message content of each parsed syslog entry.

const { Parse } = require('glossy');
const dgram = require('dgram');

const server = dgram.createSocket('udp4');

server.on('message', function(rawMessage) {
    // rawMessage is a Buffer, convert it to a UTF-8 string
    Parse.parse(rawMessage.toString('utf8', 0), function(parsedMessage){
        console.log(`Received syslog from ${parsedMessage.host} - Message: ${parsedMessage.message}`);
    });
});

server.on('listening', function() {
    const address = server.address();
    console.log(`Syslog server listening on ${address.address}:${address.port}`);
});

// Note: Binding to ports < 1024 often requires elevated privileges (e.g., sudo/root).
// For non-root operation, use a port >= 1024.
server.bind(514, '0.0.0.0', () => {
    console.log('Attempting to bind UDP server to port 514');
});