Skip to content
This repository has been archived by the owner on Dec 31, 2019. It is now read-only.

Latest commit

 

History

History
43 lines (33 loc) · 1.28 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.28 KB
Raw

winston-splunk

A splunk transport for winston. Inspired by winston-greylog2.

This project is no longer maintained. Feel free to fork.

Installation

Tested on node-0.6.x and 0.8.x, requires npm & winston.

  $ npm install winston
  $ npm install winston-splunk

Usage

  var winston = require('winston');
  winston.add(require('winston-splunk').splunk, options);

Splunk props.conf

Example props.conf

[udp:54321]
NO_BINARY_CHECK=1
SHOULD_LINEMERGE=false
TIME_PREFIX={"_timestamp":

Options are the following:

  • level: Level of messages this transport should log. (default: info)

  • silent: Boolean flag indicating whether to suppress output. (default: false)

  • splunkHost: IP address or hostname of the Splunk server. (default: localhost)

  • splunkPort: Port to send messages to on the Splunk server. (default: 54321)

  • splunkHostname: The hostname associated with Splunk messages. (default: require('os').hostname())

  • splunkFacility: The Splunk facility to send log messages.. (default: nodejs)

  • splunkTransport: Select tcp or udp transport. Splunk's docker image requires tcp transport. (default: udp)