Introduction

You need information on how to capture a syslog from selected STB devices via Orchestrate. This feature is particularly useful for operators who need to retrieve syslog from selected devices for in-depth troubleshooting.

Prerequisites

To use this feature, you need to request enabling it to assist Amino in managing the substantial amount of data that can be collected. Contact Amino customer support to enable this feature for your Orchestrate domain. The default service limits per domain are 5 concurrent logging sessions and a 5GB log buffer.

Summary

Setting up logging on a device

To enable syslog on a device, navigate to the Device Details screen. You can do this by going to Device Management > Device List and selecting the 'Details' button beside the device you want to enable syslog on.

1. On the right-hand side of the screen, click the 'Device Logging' link.
2. Configure the settings highlighted in the following screenshot and click save to enable device logging.
3. If you see an "i" mark next to a field in Orchestrate, click it for help. On this screen, the information mark will provide more information about the log level and the log buffer options.

Device Logging on Orchestrate

Once again, navigate to the Device Details screen from the Device list for your domain and select Device Logging. Under the Device Log Listing at the bottom of the screen, you will see a list of the logs being collected. For each log entry, there are two possible options available in the Actions column of the table:

• The download button allows you to download the syslog to your local PC
• The delete button removes the syslog from Orchestrate storage for your domain.

It is important to manage log storage and delete those no longer required to stay within your domain's limits.

Additional Information

If the device is rebooted with logging enabled, please stop and start logging again. Verify whether the device is uploading syslog to Orchestrate by refreshing the device logging page with F5 and checking if the "Last Updated" field value is changing.

Send logs to a remote Syslog server

To automatically send logs from the device to your own Syslog Server you just add the following INI option via Orchestrate, DHCP, or USB for a standalone environment:

logremoted.server = <Syslog IP address>

Generating too many Syslog events will cause a rise in CPU usage.

For this reason, it is recommended not to enable Syslog in production devices but to use high log levels for test/lab devices only.

Note that a low log level may not contain sufficient information for troubleshooting.

Orchestrate can be useful by allowing the separation of specific devices from the deployment population into a different group with different log settings, allowing higher log levels to be set for specific units without affecting the entire population. This isn't easily done with a traditional DHCP server.

To change the syslog level the following option needs to be set:

logremoted.priority=<consider the below options>

• Verbose (default)
• DEBUG
• INFO
• WARN
• ERROR
• FATAL
• Silent

A reboot is needed to take effect

References

None