node-rsyslog
Options
All
  • Public
  • Public/Protected
  • All
Menu

A nodejs client for send rsyslog

 
const rsyslog = require('node-rsyslog');

Index

Enumerations

Classes

Type aliases

Variables

Object literals

Type aliases

RSyslogOptions

RSyslogOptions: { appname?: undefined | string; bom?: undefined | false | true; facility: FACILITY; host: string; hostname?: undefined | string; method?: "TCP" | "UDP"; port: number; procid?: undefined | number }

Syslog UDP options.

Type declaration

  • Optional appname?: undefined | string

    Sender's [APPNAME]. Defaults to NILVALUE, i.e. -.

  • Optional bom?: undefined | false | true

    Utf8 with BOM [PROCID]. Defaults to false.

  • facility: FACILITY

    Sender's [facility]. Defaults to local0.

  • host: string

    Host to which to send packets. Defaults to 127.0.0.1.

  • Optional hostname?: undefined | string

    Sender's [HOSTNAME]. Defaults to os.hostname().

  • Optional method?: "TCP" | "UDP"

    Send packets use tcp or udp. Defaults to UDP.

  • port: number

    Port to which to send packets. Defaults to 514.

  • Optional procid?: undefined | number

    Sender's [PROCID]. Defaults to process.pid.

RSyslogSendOptions

RSyslogSendOptions: { msgid?: undefined | string; timestamp?: undefined | number }

Message send options.

Type declaration

  • Optional msgid?: undefined | string

    [MSGID]. Defaults to NILVALUE, i.e. -.

  • Optional timestamp?: undefined | number

    Timestamp of this message, as ms since epoch. Defaults to Date.now().

Variables

Const BOM

BOM: Buffer = Buffer.from('EFBBBF', 'hex')

Const DELIMITER

DELIMITER: Buffer = Buffer.from(' ', 'ascii')

Const NILVALUE

NILVALUE: "-" = "-"

Object literals

Const defaultRSyslogOptions

defaultRSyslogOptions: object

appname

appname: string = NILVALUE

bom

bom: false = false

facility

facility: local0 = FACILITY.local0

host

host: string = "127.0.0.1"

hostname

hostname: string = hostname()

method

method: "UDP" = "UDP"

port

port: number = 514

procid

procid: number = process.pid

Legend

  • Constructor
  • Method
  • Private property
  • Private method
  • Inherited method

Generated using TypeDoc