log3(5) — Reliant UNIX 5.44c4

log3(5)                                                             log3(5)

NAME
     log3 - log system Logging V3.0

DESCRIPTION
     The task of the log system Logging V3.0 which can be implemented on
     all systems with the SINIX operating system (V5.41 and later) is to
     gather information about processing, status, and error situations in
     system and application programs (applications) in log files, and to
     evaluate these using a function. With SINIX V5.43A or Reliant UNIX,
     Logging V3.0 can react to incoming log messages as soon as programs
     are started.

     A number of applications can transfer their log data to the log server
     for further processing. A C programming interface and a command
     log3logger(1M) are available to the applications for transferring
     data.

     "Named pipes", "sockets" or "streams" can function as communications
     mechanisms. It is irrelevant to the application which option is
     chosen, since the log server interface is not affected.

     The application programmer has extensive freedom with regard to the
     structure in which the user data is transferred to the log server. In
     the interests of effective evaluation of the log information there is
     little point in logging large volumes of data (>1400 characters).
     Examples of useful log information could be the following, for exam-
     ple:

     -  which application was started by which user at what time;

     -  when a particular administration file was edited, and by whom;

     -  with which status an application was aborted.

     For identification purposes, the log data is preceded by a header.
     User data and headers together make up the log information. The log
     information (log message) is written to one of the log files by the
     log server. The system administrator determines to which log file the
     message should be written, whether the message should also be passed
     on to Event Reporting DSM-ER, whether the message should start the
     reaction programs, and so on. This is done by editing the administra-
     tion file log3admin(4), to which only the system administrator or a
     user with similar authorization has access. In particular, the system
     administrator assigns the log files to the applications.











Page 1                       Reliant UNIX 5.44                Printed 11/98

log3(5)                                                             log3(5)

     To facilitate more precise classification of the log information, each
     application should provide the following information on the interface:

     -  Error number/severity of errors: This parameter can be freely
        defined by the application to enable a differentiated analysis of
        the log information. The error numbers should be unique within the
        application. The classification of syslog(3C) is offered as an
        error level.

     -  User text=module name: The text can be freely defined by the appli-
        cation. A significant text no longer than 16 characters should be
        selected to enable log messages to be located unambiguously.
        Depending on the particular case, the package names, driver names,
        or other a priori unique names should be selected.

     -  Component number: A classification of all logging applications. You
        can apply to the system integration for a new component number. The
        number range is divided up to assign new component numbers. The log
        messages transferred to Logging V3.0 over syslogd(1M) have special
        component numbers:

        4294967291 = NVRAM
        4294967292 = driver
        4294967293 = kernel
        4294967294 = remaining messages from syslogd(1M)

     Precisely one log message should describe at least one combination of
     error number/module name or error number/component number. The appli-
     cation can transfer the following as additional parameters:

     -  Structure ID: The structure ID controls the representation of user
        data by evaluating log3display(1M). The ID and the related output
        format are defined by the system administrator in the description
        file log3struct(4).

     -  Release version: Provides more detailed specifications of the log-
        ging applications.

     Logging V3.0 enables the selection and filtering of log information
     using the header information. The header information therefore should
     be as complete and unambiguous as possible. The preparation of the log
     data for log information, saving of this log information, transfer to
     Event Reporting DSM-ER, and starting of reaction programs when events
     occur run automatically.










Page 2                       Reliant UNIX 5.44                Printed 11/98

log3(5)                                                             log3(5)

FILES
     LOGPATH=/opt/log3
          Installation directory for Logging V3.0

     $LOGPATH/log3admin
          Configuration file: Assignment of applications to log files

     $LOGPATH/log3struct
          Configuration file: Assignment of structure IDs to output infor-
          mation

     $LOGPATH/name[0-8]log
          Log files

SEE ALSO
     logger(1), logger(1-ucb), log3logger(1M), log3display(1M),
     syslogd(1M), syslog(3C), log3admin(4), log3struct(4), syslog.conf(4),
     log3close(5), log3memcpy(5), log3open(5), log3printf(5), log3write(5).




































Page 3                       Reliant UNIX 5.44                Printed 11/98

Museum

Related Articles