observable-syslog
observable-syslogSyslog client observable plugin for forwarding logs to syslog servers
@bsb/syslog
Syslog server and client for BSB - receive syslog messages and send logs to syslog servers.
Installation
npm install @bsb/syslog
Features
Syslog Server
- Receive syslog messages - UDP/TCP protocols
- RFC compliance - Supports RFC 3164 and RFC 5424
- Event emission - Emit received messages as BSB events
- Client API - Subscribe to syslog messages from other services
Syslog Client (Observable)
- Send BSB logs to syslog - Forward application logs
- Multiple protocols - UDP, TCP, TLS support
- RFC compliance - RFC 3164 and RFC 5424
- Level filtering - Control which log levels are sent
Configuration
Server Configuration
plugins:
services:
- plugin: "@bsb/syslog"
service: "SyslogServerPlugin"
enabled: true
config:
port: 514
address: "0.0.0.0"
exclusive: false
Client (Observable) Configuration
plugins:
observables:
- plugin: "@bsb/syslog"
observable: "SyslogClientPlugin"
enabled: true
config:
host: "localhost"
port: 514
protocol: "udp"
facility: 16
appName: "my-app"
rfc: "5424"
levels:
debug: true
info: true
warn: true
error: true
Usage
import {
SyslogServerPlugin,
SyslogServerClient,
SyslogClientPlugin
} from "@bsb/syslog";
License
Dual-licensed under AGPL-3.0-only OR Commercial License.
Installation
Install plugin (Node.js)
npm i @bsb/syslog
Configuration
Configuration options for this plugin:
Tree view shows nested config fields and object branches.
host
host
string
default: "localhost"
port
port
integer
default: 514
protocol
protocol
"udp" | "tcp" | "tls"
default: "udp"
tls
tls
object
optional
rejectUnauthorized
tls.rejectUnauthorized
boolean
default: true
ca
tls.ca
string
optional
cert
tls.cert
string
optional
key
tls.key
string
optional
facility
facility
integer
default: 16
hostname
hostname
string
optional
appName
appName
string
default: "bsb-app"
rfc
rfc
"3164" | "5424"
default: "5424"
levels
levels
object
debug
levels.debug
boolean
default: true
info
levels.info
boolean
default: true
warn
levels.warn
boolean
default: true
error
levels.error
boolean
default: true
Supported Features
Observable capabilities implemented by this plugin:
Logging
debug
available
info
available
warn
available
error
available
Metrics
createCounter
unavailable
createGauge
unavailable
createHistogram
unavailable
incrementCounter
unavailable
setGauge
unavailable
observeHistogram
unavailable
Tracing
spanStart
unavailable
spanEnd
unavailable
spanError
unavailable
Available Versions
v9.0.0