Syslog icon

Syslog

Forwards data to an external syslog receiver

Overview

This node forwards data as syslog messages to an external syslog receiver. It is useful for integrating n8n workflows with centralized logging systems or monitoring tools that accept syslog input. For example, you can send alerts, system events, or custom log messages from your workflow to a syslog server for aggregation and analysis.

Typical use cases include:

  • Sending application logs or error notifications to a syslog server.
  • Forwarding audit trails or security events.
  • Integrating with network devices or infrastructure that consume syslog messages.

Properties

Name Meaning
Syslog Version Which syslog version to use. Options: Default (from credential), RFC3164 (BSD), RFC5424
Facility Message facility code indicating the type of program generating the message. Options include Kernel, User, System, Audit, Alert, Local0–Local7
Severity Message severity level. Options: Emergency, Alert, Critical, Error, Warning, Notice, Informational, Debug
Hostname Hostname to include in the syslog message (default: "localhost")
Application Name Application name to include in the syslog message
Message The actual message text to send to the syslog server
Item Key Name The key name under which the status object will be added to each item’s JSON output

Output

The node outputs the original items with an additional property (named by the "Item Key Name" parameter) added to each item's JSON. This property contains an object with:

  • status: A string confirming the message was sent ("Message sent").
  • message: The exact message text that was sent.

No binary data is produced by this node.

Example output snippet for one item:

{
  "json": {
    "...original data fields...",
    "syslogStatus": {
      "status": "Message sent",
      "message": "Your syslog message here"
    }
  }
}

Dependencies

  • Requires an external syslog server reachable via network.
  • Needs credentials containing the syslog server host, port, protocol (TCP/UDP), and default syslog version.
  • Uses the syslog-client Node.js package internally to send messages.

Troubleshooting

  • Connection errors: If the node cannot reach the syslog server, verify network connectivity, correct hostname/IP, port, and protocol settings.
  • Authentication issues: Ensure the provided credentials are valid and have necessary permissions if the syslog server requires authentication.
  • Invalid parameters: Check that Facility and Severity values are within allowed ranges.
  • Error messages: If sending fails, the node throws an error with details. Review the error message to identify issues such as unreachable server or invalid configuration.
  • Message not appearing on syslog server: Confirm the syslog server is configured to accept messages from the client IP and on the specified port/protocol.

Links and References

Discussion