NAME
snm_br - Site/SunNet/Domain Manager results browser
SYNOPSIS
snm_br [-b] [ files... ]
DESCRIPTION
snm_br is an OPEN LOOK application that processes log files generated by various components of the Site/SunNet/Domain Manager package. These files usually contain reports from agents. The program provides a way to scan log files quickly, and to optionally send portions of the logs to snm_gr(1), the Site/SunNet/Domain Manager grapher.
All files read by snm_br must conform to the file format specified in snm.logfile(5). Any files specified on the command line are loaded on startup. Once the program is running, load files with the File/Load menu item.
Folders:
Folders are places to collect similar (or disjoint, if you prefer) report streams. You might have folders for reports about individual systems, critical gateways, or whatever.
Use the File/Load menu item to load data/event logs into the ``current'' folder. If you load multiple files into a folder, duplicate reports are ignored. Use the File/Save menu item to save the contents of the current folder to the named file.
Folders exist only while the program is running. If you restart the program, you'll only have one folder - the Main folder - available. This is different from mailtool(1), where folders are really files. In snm_br, folders are temporary organizational bins to simplify graphing and printing.
Folder Operations: Accessed via the Edit button and Folder menu
Change folders with the ``Folder'' menu button. Rename the current folder by entering the new name in the text item at the top of the window and typing the Return key. You can't rename the ``Main'' folder.
Create a new folder by selecting Edit->New Folder. You're switched to a folder called ``New Folder,'' which you can rename.
Edit->Empty Folder removes all reports from the current folder. Edit - >Delete Folder empties the folder, and then removes it from the Folder selection list. You are switched to the ``Main'' folder after the delete operation. Deleting the ``Main'' folder empties it but doesn't delete it.
Streams:
Streams are logical groupings of reports from agents. Each stream corresponds to a manager request (identified by the manager's address and the request timestamp). Error reports from a request are split off into separate streams.
The top window (just under the buttons) is the Streams window. Each stream has a summary line with the format:
system agent group type date #reports
where ``system'' is the name of the target system (not necessarily the name of the system where the agent was running). ``type'' is the report type -- Data, Event, etc. ``date'' is the time of the original request from the manager. The year is not shown. ``#reports'' is the total number of reports in the stream.
Clicking the SELECT button on a summary line selects the stream so that you can operate on it (print, delete, etc). Select multiple streams with the SELECT button. Double clicking the SELECT button on a summary line makes that stream the ``current'' stream. The stream's individual reports appear in the lower window (called the report window). Double - clicking clears any existing selections. Selected streams have a highlighted box around them, and the ``current'' stream is additionally highlighted with a bold font.
The list is sorted by system name, agent name, and date.
Stream Operations: Accessed via the Streams Menu
The streams menu is available by pressing the MENU button while the mouse pointer is in the streams window.
You can select all streams that match certain properties: system name, agent/group name, and report type. Pull right on the ``Select'' item to get a list of the possible choices based on the reports currently in the folder.
All the other menu items in the stream menu operate on the streams that have been selected. You can copy the streams to another folder, print the streams and delete them.
Sending streams to snm_gr
You can send individual attributes (of type float and int) to snm_gr, Site/SunNet/Domain Manager Grapher. Using the streams menu, pull right on the ``Send'' item, through ``Graph'' to see a list of attributes that can be graphed. The list is based on the first selected stream in the streams window. All the reports in the selected streams that contain the attribute are sent to the Grapher.
Select the ``Choices...'' item to graph more than one attribute. A window appears where you select a number of attributes. Select the Apply button to send the data to the grapher.
If you want to graph all the attributes in the menu list, select the ``All Attributes'' menu item at the bottom of the menu.
Reports:
Reports are individual agent reports; displayed in the lower window (known as the report window). You ``move'' though the report stream, viewing individual reports, using the slider just above the report window. If there is no current stream, or the current stream has only one report, the slider doesn't appear. For attributes that return elapsed time (like the "uptime" attribute returned by the hostperf data group), the time is displayed in the format "<days>d <hours>:<minutes>:<seconds>.<subseconds>". Note that the same attribute value is displayed by the Console in the format "<hours>:<minutes>:<seconds>.<subseconds>".
Report Operations: Accessed via the Reports menu
The reports menu is available by pressing the MENU button while the mouse pointer is in the reports window.
The ``Clone'' item makes a copy of the current report in a new window, enabling you to compare two or more reports. To remove the window, pull out the window's pushpin or select the Dismiss option from the window's menu.
The ``Delete'' option removes the current report from the report stream. This can be handy when you've got an abnormality in the stream, and the graph isn't scaling correctly because of it. If you delete the last report in a stream, the stream summary line is removed from the streams window.
The ``Print'' submenu allows you to print the current report, print all the reports in the current stream starting from the current report, and print the entire stream from the first report. This last option is the same as using the print option in the streams menu when there is only one stream selected.
OpenWindows.MultiClickTimeout
Two clicks within this interval (expressed in tenths of a second) indicates a mouse button double-click, rather than two single clicks. Default is 4.
SNM.Br.WPosX The initial window position, in pixels from the left of the display. Default is 300.
SNM.Br.WPosY The initial window position, in pixels from the top of the display. Default is 100.
SNM.Br.WSizeX The initial window width, in pixels. Default is 512.
SNM.Br.WSizeY The initial window height, in pixels. Default is 640.
SNM.Br.Print This command line string is passed the selected report streams when a Print menu item is selected. Default is lp .
SNM.Br.DisplayParams
If True, the system/agent/group is displayed in the report. Default is True.
SNM.Br.DisplayFrom
If True, the time the request was made, as well as the name of the host making the request, is displayed. Default is True.
SNM.Br.DisplaySent
If True, the time the report was sent by the agent, as well as the name of the host where the agent was running, is displayed. Default is True.
SNM.Br.DisplayReceived
If True, the time the entry was logged is displayed. Default is True.
SNM.Br.DisplayMisc
If True, Delta time, Error code, and report flags, as reported by the agent, are displayed. Default is True.
SNM.Br.DisplayAttr
If True, attributes and values are displayed. Default is True.
SNM.Br.FormatRight
If True, attribute names are right-justified; otherwise they are left-justified. Default is True.
Tool Properties: Accessed via the Edit menu
The Edit menu button entry ``Tool Properties...'' brings up a window where you can customize the program. Except for the multi-click timeout, each item in the window corresponds to an entry in the X resource database described above. The multi-click timeout can be set from the OpenWindows properties tool.
Use the Apply button to accept these changes. Use the Save button to accept these changes and write them out to the ~/.Xdefaults file. Use the Load button to load the resources currently held by the X resource manager (note that it does not load the ~/.Xdefaults file). Use the Reset button to reset the properties to the state of the window at the last Apply or Save.
The Print Option and Report Format properties take effect as soon as you select Apply or Save. None of the others take effect until you Save them, reload the ~/.Xdefaults file into the X resource manager (see the xrdb(1) man page) and restart snm_br.
FILES
~/.Xdefaults
~/.brmenu
SEE ALSO
xrdb(1), snm.logfile(5)
Site/SunNet/Domain Manager Application and Agent Development Guide
NOTES
snm_br was designed to handle many agent reports. Because report logs may be extremely large, only pointers to individual reports are kept in memory. This means every time you load a file, the file is kept open so that reports can be read when you ask for them. You should not save a folder out to a file from which you've already loaded reports. This will destroy the existing file, and the program's pointers into the file will be no good.
There is no ``Undo.'' However, since the program operates on pointers to the data rather than the data itself (except for the File Save option), deleting reports doesn't do any permanent harm. You can always re-load the files.
Because the program keeps open every file it ever read, it eventually may run out of file descriptors. In that case, no more files can be loaded. Restarting the program helps, but you'll lose the organization of all the data you've loaded. Instead, you can start another snm_br.