FAQ: Event Log Feature


Forum Sentry has many logging capabilities, from logging entire API transaction details, to logging only specific pieces of the message flows, to masking or removing sensitive data. There are even Artificial Intelligence logs that have recently been developed for the product. An admin has the ability to tune their logging to best suit their needs. In many cases, they may want to have their logging sent to a log aggregation tool for analysis and storing.


The major benefit of the logging capability in Sentry is that an admin can easily determine what is happening for an API call when there is an issue or an error happening. However, setting Forum into the most verbose setting does have a downside. When the logs are set to debug level, the system must allocate CPU to handle writing all the log entries as well as performing garbage collection. In a high-volume environment, this is less than ideal. For that reason, most admins will want to keep logs in an info mode and choose to echo out only the most crucial info in the logs. With Version 9.1.166, a new feature has been added to enhance the troubleshooting capability within Sentry while keeping the log level to a minimum.



New Feature

The Event Log Feature allows for logging of error detail when the log levels are not in debug mode. To enable the feature at the policy level, select the content policy you are troubleshooting and select the Enable policy level logging settings under the logging tab. Leave the Policy Log Level in a setting other than debug. Next select the Enable Event Log option and hit Save. See below.

Note: The setting can also be enabled at the Global level under Log Configuration Settings by checking Enable Event Log.



Once the Event Log Feature has been enabled on a policy, an admin can view errors under the Diagnostics Menu by selecting the Event Log link. Any errors that occur will be displayed there in descending order with time stamps and displaying 10 errors per page. See below.

Note: Connection related errors happening on the listener will not be displayed within the event logs as these errors are handled prior to entering the communication layer.



In order to view error detail, select the plus icon next to the error you would like to view. From there, you will be provided with several details specific to the error including the error code and many other details. Click on the Download Event Log link to see more info about the error. The event detail will be downloaded in JSON format. See below.



Event Log doc shown below.



Article is closed for comments.