Winston-logger-mysql NPM

winston-logger-mysql

MySQL transport plugin for winston@3.x logger

https://github.com/mehdi-developer/winston-logger-mysql

introduction

This MySQL transport module is a plugin for winston@3.x logger running in node.js.

Current version plugin supports Winston@3.x.

synopsis

Please check test/test.js for demo usage

import MySQLTransport from "winston-logger-mysql";

const options_default = {
  host: "localhost",
  user: "logger",
  password: "logger*test",
  database: "WinstonTest",
  table: "sys_logs_default",
};

//custom log table fields
const options_custom = {
  host: "localhost",
  user: "logger",
  password: "logger*test",
  database: "WinstonTest",
  table: "sys_logs_custom",
  fields: {
    level: "mylevel",
    message: "source",
    timestamp: "addDate",
  },
};

//json log table fields
const options_json = {
  host: "localhost",
  user: "logger",
  password: "logger*test",
  database: "WinstonTest",
  table: "sys_logs_json",
};

const logger = winston.createLogger({
  level: "debug",
  format: winston.format.json(),
  transports: [
    new winston.transports.Console({
      format: winston.format.simple(),
    }),
    // or use: options_custom / options_json
    new MySQLTransport(options_default),
  ],
});

const rnd = Math.floor(Math.random() * 1000);
const msg = `test message ${rnd}`;

logger.debug("Debug");
logger.error("Error");
logger.info("Info");
logger.warn("Warning");

installation

You should create a table in the database first.

Demos:

 CREATE TABLE `WinstonTest`.`sys_logs_default` (
 `id` INT NOT NULL AUTO_INCREMENT,
 `level` VARCHAR(16) NOT NULL,
 `message` VARCHAR(2048) NOT NULL,
 `timestamp` DATETIME NOT NULL,
 PRIMARY KEY (`id`));

 # or
 CREATE TABLE `WinstonTest`.`sys_logs_custom` (
 `id` INT NOT NULL AUTO_INCREMENT,
 `mylevel` VARCHAR(16) NOT NULL,
 `source` VARCHAR(1024) NOT NULL,
 `addDate` DATETIME NOT NULL,
 PRIMARY KEY (`id`));

If you already have the log table, you can set custom fields for this module.

//custom log table fields
const options_custom = {
  host: "localhost",
  user: "logger",
  password: "logger*test",
  database: "WinstonTest",
  table: "sys_logs_custom",
  fields: {
    level: "mylevel",
    message: "source",
    timestamp: "addDate",
  },
};

You can use the JSON format field in MySQL database table. That is great for searching & parsing, but it only supports MySQL 5.7+.

 CREATE TABLE `WinstonTest`.`sys_logs_json` (
 `id` INT NOT NULL AUTO_INCREMENT,
 `level` VARCHAR(16) NOT NULL,
 `message` VARCHAR(2048) NOT NULL,
 `timestamp` DATETIME NOT NULL,
 PRIMARY KEY (`id`));

Install via npm: