winston-sql-transport

Universal winston SQL transport based on Knex.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
winston-sql-transport
3.1.02 years ago6 years agoMinified + gzip package size for winston-sql-transport in KB

Readme

winston-sql-transport
CircleCI NPM version Dependency Status NPM Downloads
Universal winston SQL transport.
Supports:
  • MySQL
  • PostgreSQL
  • SQL Server

via knex library.

Installation

$ npm install winston
$ npm install winston-sql-transport

and then install the appropriate database library: mysql2 for MySQL or MariaDB, pg for PostgreSQL, or tedious for MSSQL.

Add

// CommonJS
const winston = require('winston');
const { SqlTransport } = require('winston-sql-transport');

// ES Modules
import winston from 'winston';
import { SqlTransport } from 'winston-sql-transport';

Transport Options

See the default values used:

`level` = 'info', Level at which to log the message.
`name` = 'SqlTransport', Name for transport
`silent` = false, Suppress logs.
`tableName` = 'winston_logs', Name for database table
`defaultMeta` (optional), Will be added by default to meta for all logs;

Configure transport with the chosen client

const const transportConfig = {
  client: 'mssql',
  connection: {
    user: MSSQL_USER,
    password: MSSQL_PASSWORD,
    server: MSSQL_HOST,
    database: MSSQL_DB,
  },
}

const transportConfig = {
  client: 'mysql2',
  connection: {
    host: MYSQL_HOST,
    port: MYSQL_PORT,
    user: MYSQL_USER,
    password: MYSQL_PASSWORD,
    database: MYSQL_DATABASE,
  },
};

const transportConfig = {
  client: 'pg',
  connection: `postgres://${PGUSER}\
:${PGPASSWORD}\
@${PGHOST}\
:${PGPORT}\
/${PGDATABASE}`,
};

Example

const transportConfig = {
  client: 'mssql',
  connection: {
    user: MSSQL_USER,
    password: MSSQL_PASSWORD,
    server: MSSQL_HOST,
    database: MSSQL_DB,
  },
  defaultMeta: { example_winston_logs: true },
  name: 'ExampleSqlTransport',
  tableName: 'winston_logs',
};

Usage

const logger = winston.createLogger({
  format: winston.format.json(),
  transports: [new SqlTransport(transportConfig)],
});

logger.log({
  level: 'info',
  message: 'Hello there.',
});

If you need to create table with a transport:

(async () => {
  const transport = new SqlTransport(transportConfig);
  await transport.init();
})();

Querying Logs

This transport supports querying of logs with Loggly-like options.
const options = {
  fields: ['message'],
  from: new Date() - 24 * 60 * 60 * 1000,
  until: new Date(),
  start: 0,
  limit: 10,
  order: 'desc',
};

//
// Find items logged between today and yesterday.
//
logger.query(options, (err, results) => {
  if (err) {
    throw err;
  }

  console.log(results);
});

Run Tests

The tests are written in jest, and designed to be run with npm.
$ npm test

LICENSE

MIT License