The cmlog viewer is an interactive Eclipse plugin for viewing and querying cmlog messages. It can be run within SEAL, or as a stand-alone application.
What does it do?
The viewer allows you to browse control system messages, receiving updates from the live system as well as those previously logged. You can specify keyword filters to narrow messages to only those that interest you. It also supports printing, saving to a file, cutting and pasting, sorting, pausing and resuming.
How do I use it?
Starting within SEAL
Start the cmlog viewer by starting its Eclipse View. That is, Window -> Show View (you may need to select Other ... at this point) SEAL -> cmlog. Once started, use the File -> Get Messages dialog to connect to a cmlog server.
Starting the Stand-Alone viewer
Run cmlogviewer from the command-line.
Getting some messages
Under the "File" menu, select "Get Messages...". Doing so will open a dialog box that allows you to specify the message server, filter messages by content, and indicate whether to listen for live messages, or only to search through old messages.
Server: Usually you will want to select "OPI Gateway", since this provides both SLC and LCLS messages from the operational control system. You can choose another server if you have a specific need. You can also manually enter a server by specifying its network name and port separated by a colon (e.g. opi00gtw00.slac.stanford.edu:8093).
Filter: If you are interested in only certain messages, you can indicate this with keywords. Only messages that contain all of the whitespace-separated words you enter in this text box will be delivered. If you leave "No Filter" selected, all messages will be delivered. Note that you can also change the filter after a connection has been established. Those who wish to do more specialized filtering may use the CMLOG query syntax. To do so, enter ':' as the first character of the filter, and follow that with a valid CMLOG query.
Live / Old Messages: If you choose to listen for live messages (the default), you must specify how much time's worth to keep. Do so by entering a number and a unit of time in the text box (e.g. 10 minutes, or 3 hours, or 2 days, ...). When the connection is first established, the entire timespan will be filled in with previously logged messages. They will disappear from the viewer when they become too old.
If you choose to retrieve old messages only, then you specify a time range in the text box. Only messages logged within that time range will be retrieved by the viewer. You may select a pre-defined time range, or enter one yourself in the format of "begin - end". In addition to the standard mm/dd/yy hh:mm:ss format, you may also use several special phrases as shorthand. (e.g. 11/26/07 08:00 - 11/26/07 12:30, or current day - now, or current hour - current minute, or current day - current shift).
Known Issues
In Jira, Cmlog Viewer is a component in the SEAL Project.
Summary of known Jira Issues: https://jira.slac.stanford.edu/secure/IssueNavigator.jspa?reset=true&mode=hide&sorter/order=ASC&sorter/field=priority&pid=10447&component=10850