sockslog

SocksLog

SocksLog is a logging utility that allows you to log messages with different levels (INFO, WARN, ERROR) both locally and remotely.

Features

• Log messages with different levels: INFO, WARN, ERROR
• Remote logging to a database
• Client for real-time log streaming
• TypeScript support
• Non-blocking background logging
• Proper error stack trace handling
• Automatically fully unpacks objects and arrays

Installation

npm install sockslog

Then create an account on https://kvs.wireway.ch and create a database and copy its ID from the URL and the access token using the button.

Usage

JavaScript Usage

Logger Usage without remote

const logger = require('sockslog');

logger.setup({
    noRemote: true
});

logger.info('Hello World');

Logger Usage with remote

const logger = require('sockslog');

logger.setup({
    accessToken: 'ENTER_YOUR_ACCESS_TOKEN',
    kvsId: 'ENTER_YOUR_ID'
});

logger.info('Hello World');

Logging Errors with Stack Traces

const logger = require('sockslog');

logger.setup({
    noRemote: true
});

try {
  throw new Error('Something went wrong');
} catch (err) {
  logger.error(err); // Will properly display the full stack trace
}

Client/Viewer Usage

const logger = require('sockslog');

logger.setup({
    accessToken: 'ENTER_YOUR_ACCESS_TOKEN',
    kvsId: 'ENTER_YOUR_ID'
});

logger.client()

TypeScript Usage

Logger Usage without remote

import logger from 'sockslog';

logger.setup({
    noRemote: true
});

logger.info('Hello World');

Logger Usage with remote

import logger from 'sockslog';

logger.setup({
    accessToken: 'ENTER_YOUR_ACCESS_TOKEN',
    kvsId: 'ENTER_YOUR_ID'
});

logger.info('Hello World');

Logging Errors with Stack Traces

import logger from 'sockslog';

logger.setup({
    noRemote: true
});

try {
  throw new Error('Something went wrong');
} catch (err) {
  logger.error(err); // Will properly display the full stack trace
}

Client/Viewer Usage

import logger from 'sockslog';

logger.setup({
    accessToken: 'ENTER_YOUR_ACCESS_TOKEN',
    kvsId: 'ENTER_YOUR_ID'
});

logger.client();