errsole

To use MongoDB as your storage backend for Errsole, install both the core errsole package and the errsole-mongodb adapter using npm.

npm install errsole errsole-mongodb

To set up the Winston integration, you need to install winston, winston-errsole, errsole, and a storage provider (e.g., errsole-sqlite).

# Install Winston and the transport
npm install winston winston-errsole

# Install Errsole and a storage engine
npm install errsole errsole-sqlite

To host the Errsole Web Dashboard as a route within your existing application, use the Errsole Proxy Middleware. This allows you to access the dashboard using your application's domain (e.g., https://api.example.com/errsole).

Critical Requirements:

1. Mandatory Path: You must specify a path where the dashboard will be accessible.
2. Middleware Order: The Errsole Proxy Middleware must be the first middleware in your application. All other middlewares (like body parsers or routers) must be placed after it.
3. Custom Paths: If you have initialized Errsole with a custom path, you must append that custom path to the middleware path registration.

If your application is behind an NGINX reverse proxy, add the following configuration to map a specific URL path to the Errsole Web Dashboard (defaulting to port 8001):

location = /your-app-name/logs {
  return 301 /your-app-name/logs/;
}
location /your-app-name/logs/ {
  proxy_pass http://localhost:8001/;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "upgrade";
}

Note: Replace /your-app-name/logs with your desired path. After updating, reload NGINX using sudo nginx -s reload.

If your application is behind an NGINX reverse proxy, add a location block to your NGINX configuration to proxy requests to the Errsole dashboard (default port 8001).

Replace /your-app-name/logs with your preferred URL path.

location = /your-app-name/logs {
  return 301 /your-app-name/logs/;
}
location /your-app-name/logs/ {
  proxy_pass http://localhost:8001/;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "upgrade";
}

After updating, reload NGINX using sudo nginx -s reload.

Initialize Errsole by creating a dedicated logger.js file. This ensures the logger is a singleton that can be easily imported throughout your application. The ErrsoleMongoDB constructor accepts a connection URL, an optional database name, and an optional object for MongoDB client options (such as collectionPrefix).

// CommonJS
const errsole = require('errsole');
const ErrsoleMongoDB = require('errsole-mongodb');

errsole.initialize({
  storage: new ErrsoleMongoDB(
    'mongodb-connection-url',
    'optional-database-name',
    { collectionPrefix: 'your-app-name' }
  ),
  appName: 'your-app-name'
});

module.exports = errsole;

Initialize Errsole by passing a new instance of ErrsolePostgres to the storage option within errsole.initialize(). You must provide connection details such as host, user, password, database, and tablePrefix.

errsole-postgres uses the pg package, so it supports all standard PostgreSQL connection options provided by the node-postgres client.

import errsole from 'errsole';
import ErrsolePostgres from 'errsole-postgres';

errsole.initialize({
  storage: new ErrsolePostgres({
    host: 'postgres-host',
    user: 'database-user',
    password: 'database-password',
    database: 'database-name',
    tablePrefix: 'app-name',
  }),
  appName: 'app-name'
});

export default errsole;

Initialize Errsole by providing a new ErrsoleMySQL() instance to the storage option. You must provide connection details such as host, user, password, database, and tablePrefix.

errsole-mysql uses the mysql2 package, so it supports all standard MySQL connection options for advanced configuration.

const errsole = require('errsole');
const ErrsoleMySQL = require('errsole-mysql');

errsole.initialize({
  storage: new ErrsoleMySQL({
    host: 'mysql-host',
    user: 'database-user',
    password: 'database-password',
    database: 'database-name',
    tablePrefix: 'app-name'
  }),
  appName: 'app-name'
});

module.exports = errsole;

To use MySQL as a storage backend for Errsole, install both the core errsole package and the errsole-mysql adapter using npm.

npm install errsole errsole-mysql