Syslog

Example Path: examples/syslog

NetBurner Syslog Demo

Overview

This application demonstrates how to use the NetBurner Syslog utility to send logging information to a destination host computer via UDP on port 514. The demo sends a simple counting variable that increments every second to show elapsed time.

It also serves a small web page that reports the live syslog state — current mode, destination, and the number of messages sent so far — rendered on the device as the page is served.

Features

• Network stack initialization with DHCP support
• Syslog messaging via UDP
• Support for both broadcast and targeted syslog transmission
• Real-time counting demonstration
• Built-in web server (port 80) with a live status page generated on the device via a CPPCALL handler

How It Works

The application initializes the NetBurner network stack, waits for DHCP configuration to complete, and then begins sending syslog messages every second. Each message contains an incrementing counter showing elapsed seconds since startup.

Syslog Modes

The application supports two syslog transmission modes:

1. Broadcast Mode (default): When SysLogAddress is left unset (null), syslog data is sent as a UDP broadcast to 255.255.255.255:514. This works out of the box with no configuration.
2. Targeted Mode: When SysLogAddress is configured, syslog data is sent to the specified IP address on port 514. This is preferred on a busy network.

Setup Instructions

Prerequisites

• NetBurner device with network connectivity
• Properly configured IP address and subnet mask
• NetBurner "UDP Terminal Tool" application (for receiving syslog messages)

Configuration Steps

1. Verify Network Connection
   • Ensure your NetBurner device has proper network communication
   • Verify the device has obtained an IP address and subnet mask
2. Configure Target Address (Optional)
   • By default the example broadcasts, so no configuration is required.
   • To target a specific host instead, in main.cpp uncomment the line // SysLogAddress = AsciiToIp("10.1.1.193"); and replace "10.1.1.193" with your computer's IP address.
3. Setup Syslog Receiver
   • Run the NetBurner "UDP Terminal Tool" application
   • Set the local listening port to 514 (default syslog port)
4. Deploy Application
   • Download and run the application on your NetBurner device

Code Structure

Main Components

• Network Initialization: Sets up network stack and waits for DHCP completion
• System Diagnostics: Enables diagnostic features (should be removed for production)
• Web Server: Starts HTTP server on default port 80
• Syslog Loop: Continuously sends elapsed time messages every second

Key Functions

• init(): Initializes the network stack
• StartHttp(): Starts the web server
• WaitForActiveNetwork(): Waits for network connectivity
• showIpAddresses(): Displays current IP configuration
• SysLog(): Sends formatted syslog messages

Expected Output

Once running, the application will:

1. Display startup messages on the console
2. Show IP address information
3. Indicate whether syslog is running in broadcast or targeted mode
4. Begin sending messages like: "Seconds elapsed: 0", "Seconds elapsed: 1", etc.

Web Status Page

Browse to the device's IP address (port 80) to see a live status page. The page uses a <!--CPPCALL ShowSyslogStatus --> tag: the web server hands the HTTP socket to the ShowSyslogStatus() function in main.cpp, which formats the current mode, destination, UDP port, message count, and uptime straight into the page with fdprintf.

The message count and uptime then update once a second without a full page reload: a small piece of JavaScript polls status.html – a second CPPCALL (ShowSyslogData()) that returns just the two changing values as a JSON object – and rewrites them in place. The page is styled with a small self-contained stylesheet (plain CSS, no framework or CDN).

Related Examples

• UDP examples — general UDP send/receive, the transport syslog is built on.
• ShowInterfaces — a web view of the device's network configuration.

Network Requirements

• Protocol: UDP
• Port: 514 (standard syslog port)
• Default Target: 255.255.255.255 (broadcast) or configured IP address

Production Considerations

• Remove EnableSystemDiagnostics() call for production deployments
• Consider implementing proper error handling for network failures
• Adjust timing intervals based on logging requirements
• Implement log rotation or filtering for long-running applications

Troubleshooting

• No syslog messages received: Verify firewall settings and UDP port 514 access
• DHCP issues: Check network configuration and DHCP server availability
  
• Wrong target address: Verify the configured IP address in SysLogAddress
• Network connectivity: Ensure proper physical network connection and IP configuration