Monitoring and audit
Where messages are stored
| Destination | Mode | Content | Level limit |
|---|---|---|---|
| Instance log database | Database | Rule and run messages, together with the transfers. Viewed in the Riversoft® Console Portal. | Instance Log.Verbose |
| Text log | Local file | The same messages, in a file in the applLogDir directory. | Log.Verbose in cfgInstance |
| Standard error (stderr) | Both | Run messages, for whoever triggered the command. Can be written to a file with -errfile. | applDebug |
Each message has a code (MSGnnnn), described in Message codes, and is recorded with the rule source user (SourceUser), which makes it easy to filter a partner’s events in the Portal.
Level of detail
Each message has a level and is recorded only when its level is lower than or equal to the destination limit. The levels of the rule messages are set in the routing (LogLevelOnSuccess, LogLevelOnWarning, LogLevelOnInfo and LogLevelOnError). See Message levels.
Examples:
To also record time and size warnings, set
LogLevelOnWarningto a value lower than or equal to the instanceLog.Verbose.To diagnose a problem on the command line, temporarily raise
applDebugand use-errfile:stcpren -db -rules INBOUND -errfile /tmp/stcpren-debug.log /mailbox/IN/NOTES.TXTSet
applDebugback to its previous value after the diagnosis.
What to monitor
| Indicator | How to monitor |
|---|---|
| Files with no rule | MSG7003 messages. They indicate files left at the source. |
| Copy and backup failures | MSG7007 and MSG7019 messages, usually caused by permissions, disk space or an existing destination. |
| External command failures | MSG7011 and MSG7012 messages. |
| Files piling up at the source | Number of files in the scanned directory. A pile-up indicates rules with no match or runs that are not happening. |
| Startup failures | Exit code 4 and message MSG7942. |
| License validity | End date given in MSG7909. |
Audit
- In the database mode, messages are stored in the instance log database, with date and time, user, rule and file, and follow the retention set for that database.
- In the local file mode, include the
applLogDirdirectory in the server backup and log rotation routine. - Routings exported with
-exportserve as a record of the rules in use at each point in time.