Syslog

The syslog sink is used to send log messages to a remote syslog server in RFC3164 format over TCP connection.

It supports customization of message facility, severity, tag, and other syslog-specific settings.

JAVAYAML

SyslogSinkConfigBuilder.builder()
     .withAddress("0.0.0.0", 321)
     .withMessageBuilder(message -> {
         message.withFacility(SyslogMessageFacility.ALERT);
         message.withSeverity(SyslogMessageSeverity.DEBUG);
         message.withHostname("some_host");
         message.withTag("app");
     });

sink:
  syslog:
    host: "syslog.example.com"
    port: 514
    message:
      facility: USER
      severity: NOTICE
      hostname: "my-host"
      tag: "my-app"

Java dependency management

Add this declaration to your dependency management system to access the configuration DSL for this plugin in Java.

MavenGradle

<dependency>
    <groupId>org.voltdb</groupId>
    <artifactId>volt-stream-plugin-syslog-api</artifactId>
    <version>1.8.0</version>
</dependency>

implementation group: 'org.voltdb', name: 'volt-stream-plugin-syslog-api', version: '1.8.0'

Properties

address

Sets the target syslog server's host address and port. Default port for syslog is 514. Required.

Type: object

Fields of address:

address.host

Type: string

address.port

Type: number

address.hasBracketlessColons

Type: boolean

message

Configures the details of messages sent by this source as per the RFC3164 specification. Type: object

Fields of message:

message.facility

Facility that generated the message. Type: object

Supported values: kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7.

Default value: USER

message.severity

Defines the severity level of the message. Type: object

Supported values: emergency, alert, critical, error, warning, notice, informational, debug.

Default value: NOTICE

message.hostname

Should be set to the hostname, the IPv4 address, or the IPv6 address of the originator of the message. May only contain ASCII characters.

Type: string

Default value: UNKNOWN

message.tag

Typically the value in the TAG field will be the name of the program or process that generated the message. May only contain ASCII characters.

Type: string

JSON Schema

You can validate or explore the configuration using its JSON Schema.

Metrics

Syslog metrics

Metric enum: org.voltdb.stream.plugin.syslog.SyslogMetric

Prometheus name	Type	Description
voltsp_syslog_messages_bytes_sent_bytes	counter	Number of syslog message bytes sent.
voltsp_syslog_messages_sent_total	counter	Number of syslog messages sent.
voltsp_syslog_send_errors_total	counter	Number of syslog send errors.
voltsp_syslog_messages_time_seconds	histogram	Syslog message send duration.

Syslog tags

Tag enum: org.voltdb.stream.plugin.syslog.SyslogTag

Metrics reported by this component may include these tags. Not every metric includes every tag; tags are present only when they are relevant to the measurement.

Tag	Description
syslog_protocol	Syslog protocol variant used by the sink.