Wiki source code of Event Log
Version 5.1 by Mark Kohlmann on 2020/04/08 04:43
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | SHOWRUNNER™'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. | ||
| 2 | |||
| 3 | === Setup === | ||
| 4 | |||
| 5 | * If saving to files, insert an SD card or use a USB memory card | ||
| 6 | * Connect to the text console (SSH Recommended) | ||
| 7 | * Enable event log methods | ||
| 8 | ** Enable Logging to Console: ##sr eventlog console true## | ||
| 9 | ** Enable Logging to File: ##sr eventlog file true## | ||
| 10 | * Enable event log: ##sr eventlog true## | ||
| 11 | * Files are saved by default to: \RM\ShowRunner\(ProcessorHostname)\Log\EventLog | ||
| 12 | * ((( | ||
| 13 | View the Event Log Status: ##sr eventlog status## | ||
| 14 | ))) | ||
| 15 | |||
| 16 | (% class="box" %) | ||
| 17 | ((( | ||
| 18 | ##RMC3>sr eventlog status | ||
| 19 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 20 | ~| Property | Value | | ||
| 21 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 22 | ~| Enabled | False | | ||
| 23 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 24 | ~| Log to Console | True | | ||
| 25 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 26 | ~| Log to File | True | | ||
| 27 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+ | ||
| 28 | ~| Log File Path | \RM\ShowRunner\CI-SJC-RMC3\Log\EventLog | | ||
| 29 | +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--+## | ||
| 30 | ))) | ||
| 31 | |||
| 32 | === File Format === | ||
| 33 | |||
| 34 | * File is saved in a csv (comma separated values) format | ||
| 35 | * 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. | ||
| 36 | * Once the file reaches 2MB it will automatically be zipped and a new file will be created and the index will be incremented. | ||
| 37 | * Text qualifier is not used. | ||
| 38 | * Columns: | ||
| 39 | ##AppID,Timestamp,Type,GlobalId,Name,Message,Value## | ||
| 40 | ** AppID - The app number on the control system that logged the message | ||
| 41 | ** Timestamp - Timestamp of the log entry in YYYY-MM-DDTHH:MM:SSTZ format. Example: 2020-02-21T11:57:21-06:00 | ||
| 42 | ** Type - Type of object logging the message | ||
| 43 | ** GlobalId - Unique Id of the object logging the message | ||
| 44 | ** Name - Name of the object logging the message | ||
| 45 | ** Message - Type of value to expect | ||
| 46 | ** Value - Current state of the type | ||
| 47 | |||
| 48 | === Notes === | ||
| 49 | |||
| 50 | * Before removing the SD card stop the event log: ##sr eventlog off## | ||
| 51 | |||
| 52 | === Examples === | ||
| 53 | |||
| 54 | * [[Area Occupancy and Scene (Power BI)>>attach:ShowRunner_LogAnalysis.pbix]] |