https://github.com/datalust/seq-logging
A Node.js client for the Seq HTTP ingestion API
https://github.com/datalust/seq-logging
Last synced: about 1 year ago
JSON representation
A Node.js client for the Seq HTTP ingestion API
- Host: GitHub
- URL: https://github.com/datalust/seq-logging
- Owner: datalust
- License: apache-2.0
- Created: 2016-03-25T07:08:37.000Z (about 10 years ago)
- Default Branch: dev
- Last Pushed: 2025-02-22T06:08:03.000Z (over 1 year ago)
- Last Synced: 2025-04-09T19:16:30.769Z (about 1 year ago)
- Language: JavaScript
- Size: 434 KB
- Stars: 29
- Watchers: 7
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Seq Logging for JavaScript   [](https://www.npmjs.com/package/seq-logging)
> This library makes it easy to support Seq from Node.js logging libraries, including [Winston](https://github.com/winstonjs/winston) via [winston-seq](https://github.com/datalust/winston-seq), [Pino](https://github.com/pinojs/pino) via [`pino-seq`](https://github.com/datalust/pino-seq), [Bunyan](https://github.com/trentm/node-bunyan) via [`bunyan-seq`](https://github.com/continuousit/bunyan-seq), and [Ts.ED logger](https://logger.tsed.io) via [@tsed/logger-seq](https://logger.tsed.io/appenders/seq.html). It is not expected that applications will interact directly with this package.
### Requiring for Node
```js
const seq = require('seq-logging');
```
### Requiring for a browser
Using `seq-logging` in a browser context is the same, except the module to import is `seq-logging/browser`.
```js
const seq = require('seq-logging/browser');
```
### Usage
A `Logger` is configured with `serverUrl`, and optionally `apiKey` as well as event and batch size limits.
`requestTimeout` can be used to adjust timeout for stalled connections, default: 30s.
```js
const process = require('process');
const seq = require('seq-logging');
const logger = new seq.Logger({ serverUrl: 'http://localhost:5341' });
logger.emit({
timestamp: new Date(),
level: 'Information',
messageTemplate: 'Hello for the {n}th time, {user}!',
properties: {
user: process.env.USERNAME,
n: 20
}
});
logger.close();
```
Events are sent using the `emit()` method, that internally performs asynchronous batching based on payload size.
When the application exits, `close()` ensures all buffered events are written. This can be done at any time otherwise using the `flush()` method. Both of these methods return promises indicating completion.
### Implementations
* [bunyan-seq](https://github.com/datalust/bunyan-seq) - collect events from the Buyan logging framework
* [pino-seq](https://github.com/datalust/pino-seq) - A stream to send Pino events to Seq
* [winston-seq](https://github.com/datalust/winston-seq) - A Seq transport for Winston
* [@tsed/logger-seq](https://logger.tsed.io/appenders/seq.html) - A Seq transport for Ts.ED logger