splunk-logger

splunk-logger is a robust and efficient JavaScript library designed to streamline the process of sending logs to Splunk. It provides a simple yet powerful interface for log management.

Installation

Use the package manager npm to install splunk-logger.

npm install splunk-logger

Usage

import { SplunkLogger } from "splunk-logger";

const logger = new SplunkLogger({
    token: "your token",
    domain: "your splunk host",
});

logger.info('server is running on port 3000');

Use with Winston logger

import * as winston from "winston";
import { SplunkLogger } from "splunk-logger";
import { SplunkWinstonTransport } from "splunk-logger";

const logger = winston.createLogger({
    transports: [
        new winston.transports.Console(),
        new SplunkWinstonTransport({
            token: "your token",
            domain: "your splunk host",
        })
    ]
});

Full options object

const options = new SplunkLoggerOptions({
    domain: "localhost",
    port: 8088,
    tls: false,
    token: "00000000-0000-0000-0000-000000000000",
    shouldPrintLogs: true,
    isBatchingEnabled: false,
    batchOptions: {
        batchSize: 500, 
        queueSizeLimit: 10000 
    },
    exceptionOnFailure: false
});

const logger = new SplunkLogger(options)

You can expect the console to print:

12:31:12 - INITIAL - Logger initialed

In case of error, please check if your Splunk settings and make sure your token and address are correct.

BatchMode Overview

What is BatchMode?

BatchMode is an advanced feature in SplunkLogger designed to optimize logging performance in high-traffic environments. This mode enables the batching of multiple log entries, which are then sent to Splunk in a single HTTP request. This method is highly efficient and beneficial for applications where minimizing the impact on the event loop and reducing network traffic is crucial.

Benefits

• Batched Log Entries: BatchMode batches a specified number of log entries, which are then sent as a single HTTP request. This significantly reduces the total number of HTTP requests made to Splunk.
• Reduced Event Loop Activity: By lowering the frequency of HTTP requests, BatchMode minimizes the workload on the event loop and network usage, leading to improved application performance.
• Customizable Queue Size: Users have the flexibility to set a limit on the queue size, which helps in managing memory usage effectively and preventing potential memory leaks.

Recommended Usage

BatchMode is particularly useful for applications that generate a large volume of logs and require efficient log management. It should be configured with a careful balance between performance enhancement and resource utilization.

Configuration

To enable and configure BatchMode in your application set:

    isBatchingEnabled: true

To enable to receive exceptions when sending data to splunk fails set:

    exceptionOnFailure: true

Log levels

• info
• warn
• error
• fatal
• debug
• raw (for sending raw data directly to Splunk)

License

MIT