pino-seq 2.1.0 → 3.0.0

package/.github/workflows/node.js.yml

@@ -28,4 +28,3 @@ jobs:
     - run: npm ci
     - run: npm run build --if-present
     - run: npm test
-    - run: ./cli.js --help

package/README.md

@@ -2,48 +2,6 @@
 
 A stream to send [Pino](https://github.com/pinojs/pino) events to [Seq](https://datalust.co/seq). Tested with Node.js versions 18.x and up.
 
-### Out-of-process (transport) usage <sup>recommended</sup>
-
-First, install and use `pino` in your Node.js app, following the instructions in the [Pino documentation](https://getpino.io).
-
-This will look something like:
-
-```js
-const logger = (await import('pino'))();
-logger.info('Hello, World!');
-```
-
-Pino will, by default, write newline-delimited JSON events to `STDOUT`. These events are piped into the `pino-seq` transport.
-
-First, install `pino-seq` as a global tool:
-
-```shell
-npm install -g pino-seq
-```
-
-Then, pipe the output of your Pino-enabled app to it:
-
-```shell
-node your-app.js | pino-seq --serverUrl http://localhost:5341 --apiKey 1234567890 --property applicationName=PinoSeqExampleApp
-```
-
-`pino-seq` accepts the following parameters:
-
-- `serverUrl` - this is the base URL of your Seq server; if omitted, the default value of `http://localhost:5341` will be used
-- `apiKey` - your Seq API key, if one is required; the default does not send an API key
-- `logOtherAs` - log other output (not formatted through pino) to seq at this loglevel. Useful to capture messages if the node process crashes or smilar.
-- `property` - add additional properties to all logs sent to Seq
-
-#### Capturing other output
-
-To enable capture of output not formatted through pino use the `logOtherAs` parameter. It's possible to use different settings for STDOUT/STDERR like this, when using bash:
-
-```shell
-node your-app.js 2> >(pino-seq --logOtherAs Error --serverUrl http://localhost:5341 --apiKey 1234567890) > >(pino-seq --logOtherAs Information --serverUrl http://localhost:5341 --apiKey 1234567890)
-```
-
-### In-process (stream) usage
-
 Use the `createStream()` method to create a Pino stream configuration, passing `serverUrl`, `apiKey` and batching parameters.
 
 ```js

package/index.d.ts

@@ -12,7 +12,7 @@ declare namespace PinoSeq {
   }
 
   function createStream(config: PinoSeq.SeqConfig): Writable & {
-    flush: () => Promise<Boolean>;
+    flush: () => Promise<boolean>;
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pino-seq",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "A stream that sends Pino log events to Seq",
   "main": "index.js",
   "types": "index.d.ts",
@@ -10,9 +10,6 @@
     "start": "node ./example/example.js",
     "start:ts": "tsx ./example/example.ts"
   },
-  "bin": {
-    "pino-seq": "./cli.js"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/datalust/pino-seq.git"
@@ -28,17 +25,15 @@
   },
   "homepage": "https://github.com/datalust/pino-seq#readme",
   "devDependencies": {
-    "mocha": "^11.2.2",
-    "tsx": "^4.19.4",
-    "typescript": "^5.8.3"
+    "mocha": "^11.7.4",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "commander": "^13.1.0",
-    "seq-logging": "^3.0.0",
-    "split2": "^4.2.0"
+    "seq-logging": "^3.0.0"
   },
   "peerDependencies": {
-    "pino": "9.x"
+    "pino": "10.x"
   },
   "engines": {
     "node": ">=18.0.0"

package/cli.js

@@ -1,60 +0,0 @@
-#!/usr/bin/env node
-
-import { program } from 'commander';
-import split2 from 'split2';
-import pinoSeq from './index.js';
-
-function main() {
-  program
-    .option('-s, --serverUrl <serverUrl>', 'Seq server instance')
-    .option('-k, --apiKey <apiKey>', 'Seq API key')
-    .option(
-      '-o, --logOtherAs <Verbose|Debug|Information|Warning|Error|Fatal>',
-      'Log other output (not formatted through pino) to seq at this loglevel. Useful to capture messages if the node process crashes or smilar.',
-      (string) => {
-        if (['Verbose', 'Debug', 'Information', 'Warning', 'Error', 'Fatal'].includes(string)) {
-          return string;
-        }
-        console.error(`Warning, skipping option "logOtherAs": Invalid value supplied: "${string}"`);
-        return undefined;
-      }
-    )
-    .option('-p, --property <property>', 'Properties to add to all logs', (value, previous) => {
-      const valueSplit = value.split('=')
-      if(valueSplit.length !== 2)
-      {
-        console.error(`Warning, skipping option "property": Invalid value specified: "${value}`)
-        return previous;
-      }
-
-      const current = {
-        [valueSplit[0]]: valueSplit[1]
-      }
-      return Object.assign(previous, current);
-    }, {})
-    .action(({ serverUrl, apiKey, logOtherAs, property }) => {
-      try {
-        const writeStream = pinoSeq.createStream({ serverUrl, apiKey, logOtherAs, additionalProperties: property });
-
-        process.stdin.pipe(split2()).pipe(writeStream).on("error", console.error);
-
-        const handler = (err, name) => {
-          writeStream.end(() => {
-            process.exit(0);
-          });
-        };
-
-        process.on('SIGINT', () => handler(null, 'SIGINT'));
-        process.on('SIGQUIT', () => handler(null, 'SIGQUIT'));
-        process.on('SIGTERM', () => handler(null, 'SIGTERM'));
-        process.on('SIGLOST', () => handler(null, 'SIGLOST'));
-        process.on('SIGABRT', () => handler(null, 'SIGABRT'));
-      } catch (error) {
-        console.error(error);
-      }
-    });
-
-  program.parse(process.argv);
-}
-
-main();