Wiki source code of Event Log
Last modified by Scott Kohlmann on 2023/04/21 14:08
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
15.1 | 1 | ShowRunnerCLC™'s event log logs system activities to text files and/or the console. The event log is disabled by default but it can be enabled if desired. We do not recommend leaving logging on unless necessary. |
| |
1.1 | 2 | |
| |
6.1 | 3 | The "Trace" function allows the trigger of an event to be tracked throughout the event's execution. Trace logs the originating event and tags each eventlog entry with the identifying information on the originating device/control point. Trace creates a small additional burden on the system, not recommended on larger 3-series systems. |
| 4 | |||
| |
1.1 | 5 | === Setup === |
| 6 | |||
| 7 | * If saving to files, insert an SD card or use a USB memory card | ||
| 8 | * Connect to the text console (SSH Recommended) | ||
| 9 | * Enable event log methods | ||
| 10 | ** Enable Logging to Console: ##sr eventlog console true## | ||
| 11 | ** Enable Logging to File: ##sr eventlog file true## | ||
| 12 | * Enable event log: ##sr eventlog true## | ||
| |
6.1 | 13 | * Enable Trace: ##sr eventlog trace true## |
| |
9.1 | 14 | * Files are saved by default to: ##\RM\sr\log\eventlog (processor) or /opt/crestron/virtualcontrol/RunningPrograms/ROOMID/User/sr/log (VC-4)## |
| |
1.1 | 15 | * ((( |
| 16 | View the Event Log Status: ##sr eventlog status## | ||
| 17 | ))) | ||
| 18 | |||
| 19 | (% class="box" %) | ||
| 20 | ((( | ||
| 21 | ##RMC3>sr eventlog status | ||
| 22 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 23 | ~| Property | Value | | ||
| 24 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| |
6.1 | 25 | ~| Enabled | True | |
| |
1.1 | 26 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ |
| 27 | ~| Log to Console | True | | ||
| 28 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| |
6.1 | 29 | ~| Log to File | False | |
| |
1.1 | 30 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ |
| |
8.1 | 31 | ~| Log File Path | \RM\sr\log\eventlog | |
| |
6.1 | 32 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ |
| 33 | ~| Enable Trace | True | | ||
| |
1.1 | 34 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+## |
| 35 | ))) | ||
| 36 | |||
| 37 | === File Format === | ||
| 38 | |||
| 39 | * File is saved in a csv (comma separated values) format | ||
| |
5.1 | 40 | * Files are saved incrementally: ##EventLog_2020-02-21T11-56-21_~#~##.csv## where 2020-02-21T11-56-21 is the program start time and ~#~## is the index of the file, starting at 000. |
| 41 | * Once the file reaches 2MB it will automatically be zipped and a new file will be created and the index will be incremented. | ||
| |
7.1 | 42 | * Quote (") is used as a text qualifer |
| |
1.1 | 43 | * Columns: |
| |
7.1 | 44 | ##AppID,Timestamp,Level,Trigger,Type,GlobalId,Name,Message,Value## |
| |
1.1 | 45 | ** AppID - The app number on the control system that logged the message |
| 46 | ** Timestamp - Timestamp of the log entry in YYYY-MM-DDTHH:MM:SSTZ format. Example: 2020-02-21T11:57:21-06:00 | ||
| |
7.1 | 47 | ** Level - Level of logging (Trace, Debug, Information, Warning, Error, Critical) |
| 48 | ** Trigger - Empty unless Enable Trace is true. The object that triggered the event. **Version 3.014 or later.** Multiple possible triggers. Additional triggers may be added in the future. | ||
| |
6.1 | 49 | *** BACNET:X - BACnet instance that triggered the event. X is the BACnet name. |
| 50 | *** FUSION:XX - Crestron Fusion triggered the event. XX is the IP-ID. | ||
| 51 | *** GID:N - Triggered by a ShowRunner object. N is the GlobalId of the object. | ||
| 52 | *** TCP:X - TCP Listener triggered the event. X is the IP Address of the host that triggered the event. | ||
| 53 | *** UDP:X - UCP Listener triggered the event. X is the IP Address of the host that triggered the event. | ||
| 54 | *** WEBSESSION-USER:X [Y] - Triggered from REST API/LWAPI. X is the SessionId, Y is the username associated with the session OR if username is not available | ||
| 55 | *** WEBSESSION-HOST:X [Y] - Triggered from REST API/LWAPI. X is the SessionId, Y is the IP Address associated with the session. | ||
| |
1.1 | 56 | ** Type - Type of object logging the message |
| 57 | ** GlobalId - Unique Id of the object logging the message | ||
| 58 | ** Name - Name of the object logging the message | ||
| 59 | ** Message - Type of value to expect | ||
| 60 | ** Value - Current state of the type | ||
| 61 | |||
| |
4.1 | 62 | === Notes === |
| 63 | |||
| 64 | * Before removing the SD card stop the event log: ##sr eventlog off## | ||
| |
6.1 | 65 | * There is no automatic deletion of files. Please be aware of available disk space on the SD card. |
| |
10.1 | 66 | * The eventlog is written |
| |
4.1 | 67 | |
| |
1.1 | 68 | === Examples === |
| 69 | |||
| |
3.1 | 70 | * [[Area Occupancy and Scene (Power BI)>>attach:ShowRunner_LogAnalysis.pbix]] |
| |
13.1 | 71 | * [[Log Entries with Trace>>SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.Event Log.Log Entries with Trace.WebHome]] |
| |
6.1 | 72 | |
| 73 |