home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / SYSLOG.INS / SYSLOG.DOC < prev   
Text File  |  1999-01-25  |  10KB  |  222 lines
  1.  
  2. Searchlight 4.5 Activity Log
  3. ----------------------------
  4. Beginning with version 4.5, Searchlight uses a DBase III file (DBF file) to 
  5. log system activity. This file, SYSLOG.DBF, replaces the old ACTIVITY.LOG 
  6. and FILES.LOG files used in earlier versions. A single SYSLOG.DBF file is 
  7. used to log all activity from all nodes. In addition, the file format allows 
  8. third party applications to use the SYSLOG.DBF file if desired.
  9.  
  10. This document describes the general format of the SYSLOG.DBF file, the 
  11. format of individual events logged by Searchlight BBS, and covers the use of 
  12. the LOGDUMP.EXE command for retrieving information from the log file.  
  13.  
  14.  
  15. DBF Format
  16. ----------
  17. SYSLOG.DBF is a standard DBase III database file. Each record contains 11 
  18. data fields. This chart shows the name, type, size, and contents of each 
  19. field: 
  20.  
  21.   Label   Type  Size  Description
  22.   PROGID  C      8    The name of the program that logged the event
  23.   USER    C     25    The name of the current user when the event took place
  24.   NODE    C      4    The node number (right-justified ASCII text)
  25.   DATE    D      8    Date, in the format YYYYMMDD (i.e. 19950415)
  26.   TIME    C      5    Time, in 24 hour HH:MM format (i.e. 18:45)
  27.   RES1    C      4    Reserved for future use
  28.   RES2    C      4    Reserved for future use
  29.   RES3    C      4    Reserved for future use
  30.   RES4    C      4    Reserved for future use
  31.   ACTION  C      1    One-character "action" code, as shown below
  32.   MSG     C     60    Message describing what happened
  33.  
  34. Most of these fields are self-explanatory. The PROGID field is used to store 
  35. the name of the program which generated the event; in the case of 
  36. Searchlight, this can either be LOGIN for events generated by the Login 
  37. program, or BBS for events generated from the main program. Third party 
  38. programs which wish to log events can do so by placing their own program ID 
  39. name in this field.
  40.  
  41. In order to help categorize events, an event is described by using both a 
  42. one-character "Action" code, and a 60 character description. The action 
  43. codes help you when you wish to examine all the events of a particular type. 
  44. Searchlight currently uses the following action codes:
  45.  
  46.   ! Error
  47.   N New User Login
  48.   O Login by Existing User
  49.   F Logoff or System Reset
  50.   U File Upload
  51.   D File Download
  52.   M User entered a menu
  53.   X User executed a command on a menu
  54.   S User saved a message
  55.   J User jumped to a conference or file area
  56.   G User downloaded a message
  57.   Q QWK Mail event
  58.   C Custom Message (user defined log entry)
  59.  
  60. Other programs which use the system log should use their own codes to log 
  61. events separate from these.
  62.  
  63. Note that the above chart is not the literal file format of a SYSLOG.DBF 
  64. file. All DBF files contain standard header information as defined in the 
  65. industry standard DBF format. If you wish to write programs that deal with 
  66. the SYSLOG.DBF file, you should use a file access library that understands 
  67. the DBF file format. Alternately, use the LOGDUMP utility program (described 
  68. below) to create a text version of the system log.
  69.  
  70.  
  71. Searchlight Events
  72. ------------------
  73. Events supported in Searchlight BBS at this time include the following:
  74.  
  75. (1) Logoff/System Reset
  76. This event is logged any time the system resets back to the "Waiting for 
  77. call" screen. Normally this indicates the end of a call, although a reset 
  78. can occur even if there is not a call in progress. System Reset uses an 
  79. action code of "F". There is no data placed in the message field or user
  80. name fields.
  81.  
  82. (2) Login
  83. Login events are recorded with an action code of "N" for a new user, or "O" 
  84. for an existing user. The username field contains the name of the user who 
  85. logged in. The Msg field contains the following additional information: 
  86. caller's graphics mode, baud rate, invisible status, location, and caller id 
  87. information. The Msg field is formatted as follows:
  88.  
  89.      Graphics BaudRate [+] [Location] <CallerID>
  90.  
  91. "Graphics" is a single character representing Rip (R), Color (C), Monochrome 
  92. (M), or non-ansi (N). Baudrate is a seven-character field (left padded with 
  93. spaces if necessary) representing the baud rate. The word "Local" is used to 
  94. designate local logins.
  95.  
  96. If a Sysop logs in and selects the invisible login option, a + sign appears 
  97. next in the line with a space on either side.
  98.  
  99. In the case of new user logins, the user's location is recorded next. 
  100. Finally, if caller ID information is available, it appears last on the line, 
  101. enclosed within angle brackets.
  102.  
  103. (3) Bad Passwords
  104. A bad password is recorded with a "!" in the action field, and the following 
  105. message text: "Bad Password Attempted". The name for which the bad password 
  106. was tried appears in the Username field. For security reasons, the bad 
  107. password itself is not recorded.  
  108.  
  109. (4) File Upload or Download
  110. File transfers are indicated with the action code "U" for Upload or "D" for 
  111. Download. The Msg line contains the name of the file uploaded or downloaded, 
  112. one blank space, and the name of the associated file directory (this is the 
  113. directory name as it appears in the Searchlight config program, not the 
  114. physical DOS path).
  115.  
  116. (5) Menus
  117. If the Event Logging flag for a menu is enabled, Searchlight adds a record 
  118. to the activity log each time that menu is activated. The log records these 
  119. events with an "M" in the action field, and the one to eight-character menu 
  120. name in the message field.
  121.  
  122. (6) Commands
  123. If a command on a menu is flagged for logging, Searchlight makes a log entry 
  124. each time that command is executed. These types of entries contain "X" as 
  125. the action code. The message field contains the menu name and the name of 
  126. the command, separated by a period. For example, "FILES.List" indicates that 
  127. the caller executed the command "List" from the menu FILES.
  128.  
  129. (7) User defined entries
  130. Internal command 220 can be used to place an arbitrary message into the 
  131. system log. The entire parameter string used with command 220 becomes the 
  132. log message; the action code for these types of entries is "C".
  133.  
  134. (8) Fatal Errors
  135. These error events are logged with a "!" action code:
  136.  
  137.   Error loading menu <menuname>
  138.   Read/Write error xxx on file <filename>
  139.   Lock/Unlock error on file <filename>
  140.   No conferences available
  141.   No file directories available
  142.  
  143. (9) Messages
  144. If the "Public Message" or "Email Message" logging flag is enabled, the log 
  145. file records each time a user saves a public or private message. The action
  146. character for these entries is "S"; the message line contains the following
  147. information: the subboard name, the message number, the word "To:", and the
  148. addressee of the message. For example:
  149.  
  150.   MAIL 456 To: SYSOP
  151.   MAIL 497 To: john@multiverse.com
  152.   GENERAL 1294 To: All
  153.  
  154. (10) Conferences & Directories
  155. If "Jump to Conference" or "Jump to Directory" logging is enabled, 
  156. Searchlight logs each time a caller changes to a new message conference or a 
  157. new file directory, respectively. The log shows "J" as the action code for
  158. these types of events, followed by "Conf.CONFNAME" for conferences or 
  159. "Dir.DIRNAME" for directories. For example:
  160.  
  161.   Conf.GENERAL
  162.   Conf.ALBBSE
  163.   Dir.UPLOADS
  164.  
  165. Note that this type of event is different than simply logging the "Jump" 
  166. menu command because it records any time the current conference or directory 
  167. changes, regardless of which command caused the change. It also records the
  168. default conference and directory that is established at login.
  169.  
  170. (11) Message Download
  171. If the Message Download event is enabled, Searchlight records each instance
  172. that a message is downloaded as a binary file (ie. by pressing 
  173. Other/Download while viewing the message). The action code for these events 
  174. is "G"; the message shows the subboard name and the message number of the 
  175. message that was downloaded. If multiple messages are downloaded at once
  176. (ie. a thread or part of a thread) then the message line contains each 
  177. message number separated by a space.
  178.  
  179.  
  180. Logdump Utility Program
  181. -----------------------
  182. If you do not wish to use a database program to view your activity log, the 
  183. Logdump program will generate a text dump of your activity log to standard 
  184. output, which you may then redirect to a file or a process. The syntax for 
  185. running LOGDUMP.EXE is as follows:
  186.  
  187. LogDump [?] [-I P|N|U|D|T|A|M] [-P <progid>] [-N <node #>] [-A <action code>]
  188.  
  189.   -I Include (Program, Node, Username, Date, Time, Action, Message
  190.              (Default = Include All)
  191.  
  192. If you type LOGDUMP with no parameters, the utility lists all transactions 
  193. in your SYSLOG.DBF file and includes all information about each transaction.
  194.  
  195. You can use the -I switch to list only certain fields in your output. For 
  196. example, if you want to generate a list that contains only the time, date, 
  197. and message, type LOGDUMP -ITDM. To create a list containing only the date, 
  198. username, and action code, use LOGDUMP -IDUA.
  199.  
  200. The -P switch lets you list only those items associated with a particular 
  201. program. For example, if you type LOGDUMP -Plogin, you will receive a list 
  202. of only those events associated with the LOGIN program (ie. logins, logoffs, 
  203. and bad passwords).
  204.  
  205. The -N switch restricts the list to a particular node; thus, LOGDUMP -N2 
  206. gives you a list of only those events associated with Node 2.
  207.  
  208. The -A switch lists only the events for the given action code. If you type 
  209. LOGDUMP -AU, you'll list only upload events.
  210.  
  211. Two or more switches may be used together to further specify the type of 
  212. listing desired.
  213.  
  214. As with any DOS program that writes to standard output, you can use the 
  215. redirection characters > or | to pipe the output to a file or process. For 
  216. example:
  217.  
  218.    LOGDUMP >LOGFILE.TXT
  219.  
  220. This command places a text dump of your entire activity log into a file 
  221. called LOGFILE.TXT.
  222.