log3admin(4) log3admin(4)
NAME
log3admin - Logging administration file
SYNOPSIS
$LOGPATH/log3admin
DESCRIPTION
The log server is controlled by means of the administration file
log3admin. The administrator uses entries in this file to determine,
for example, which log files are to record the log information.
If log data for a particular application is to be written to a log
file other than that originally provided, it is not necessary to
modify the application. In this case, it is sufficient to adjust the
relevant entry in the administration file.
The administration file is located in the directory defined by
$ADMPATH. If $ADMPATH is not specified in the environment, it is
replaced by the value of $LOGPATH.
The administration file is an ASCII text file that can be edited
either directly using an editor, or via the menu.
The log server does not interpret the text file log3admin directly,
rather it waits for a binary file log3admin.obj, which it can load
using its own data structures and process.
This log3admin.obj file is created using the command log3adm, which is
automatically called via the menu after every change to the log3admin
file. After a change has been made directly to the administration file
using an editor, the command log3adm must be called from Shell level.
The log3adm command carries out a syntax test and creates the binary
file log3admin.obj, if there are no errors.
If the administration file is modified while the log server is run-
ning, the log server can be instructed to update its data using the
instruction log3new. When editing the file via the menu, this instruc-
tion is also executed automatically.
The administration file log3admin contains three information blocks,
two of which must be specified, and one block that is optional, i.e.
it can be omitted. These blocks can be written to the file in any
order.
Every block begins with one of the following keywords:
#LOGFILE Features of the log files
#LOGTYPE Assignment of the application to the log files, etc.
#DEFAULT Optional description of the default log file
Page 1 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
and ends with the first # character that is not contained in a comment
field.
All characters that come after a semicolon (;) to the end of the line,
and the lines between blocks, are interpreted as comment. Both empty
lines and pure comment lines are permitted.
The syntax of the #DEFAULT block is identical to that of the #LOGFILE
block. The only difference is that there only one entry is permitted
for the default log file.
Description of #LOGFILE block
Every administration entry in the #LOGFILE block comprises one line
with five fields separated by blank spaces or tabulators.
FILENAME MAXSIZE MAXCH CLOSE Command
These fields are described below.
FILENAME This is the name of the log file. It can only contain
the characters [A to Z], [a to z], [0 to 8], underscore
(_), backslash (/) and period (.).
Backslashes (/) can only be used if the name contains
an absolute path. If there is no absolute path, the log
files are created relative to $LOGPATH.
The length of a name with an absolute path is res-
tricted to 32 characters. The length of a simple name
must not exceed ten characters because the log server
appends a 4-character suffix, and some systems only
differentiate file names up to the 14th character.
Several applications (components) can write to a log
file.
MAXSIZE This specifies the maximum permitted size of this file
in Kbytes.
The lower limit is defined by means of the size LOGSIZE
(plus one Kbyte) defined in the include file logging.h,
so that at least one log entry can be written to this
file.
MAXCH The number of subsequent files with consecutively num-
bered endings is entered in this field. A figure
between two and nine is permitted.
Page 2 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
The free disk storage capacity required can be
estimated using the formula:
Requirement=Sum of MAXSIZE[i]*MAXCH[i]
(i = Number of log files)
CLOSE This tells the log server either to close this log file
after a logging procedure, or to keep it open. Permit-
ted entries are 1 ("close") and 0 ("open"). In order to
use as few system resources as possible (number of
simultaneously open files), this flag should be set to
1 ("close") for files to which entries are rarely writ-
ten.
Command This field is provided in order to specify an instruc-
tion sequence in inverted commas ("...") if required,
and this is then executed with root authorization.
If a log file has reached its maximum size, an instruc-
tion entered here is carried out by the log server
using the functions fork() and execlp(), where the name
of the log file is transferred as a parameter. The log
server does not wait for this process to end.
The instruction must either contain an absolute path or
be integrated in the $PATH environment of the log
server.
If an instruction sequence itself contains inverted
commas, they must follow a backslash (\), thus allowing
a complete log file to be archived.
An instruction can be a command (e.g. rm), a shell
script, or an executable C program. If a shell script
is used, it should begin with the line #!/bin/sh. A
message for executing this instruction and an error
message can be entered in the debug file if the log
server was started in this way.
Description of #LOGTYPE block
In #LOGTYPE block, every entry comprises one line with four fields
separated by means of blanks or tabulators.
COMPNO LOGFILE REPEATS DIRECTION
COMPNO This field is intended for the unique component number
assigned to every Logging V3.0 application by central
administration. The values range from 1 to 4294967294,
where the values
Page 3 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
4294967291 = NVRAM
4294967292 = Driver
4294967293 = Kernel
4294967294 = The remaining messages of syslogd(1M)
are reserved.
A * character here stands for all component numbers and
means that all applications should be written to this
log file.
LOGFILE Here, a component number is assigned to a log file.
This log file must be defined in the #LOGFILE block.
A component can write to several log files.
A * character here stands for all log files and means
that this application should write to all log files
defined in the #LOGFILE block.
REPEATS Permitted specifications are 1 (repetition ID required)
and 0 (no repetition ID).
If a repetition ID is required for this component, the
log server always compares the last log entry with the
current one before it writes to this log file. If the
two entries are the same, the repetition counter and
the repetition time are simply updated in the last log
entry.
This specification can be overridden when the log
server is started.
DIRECTION Permitted specifications are
0 = logging only
1 = pass the log data on to Event Reporting DSM-ER
2 = filter the log data and where possible, initiate
reactions
3 = 1 + 2
4 = Log the log data for TRANSVIEW
5 = 1 + 4
6 = 2 + 4
7 = 3 + 4
Page 4 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
The log data of the components that are not defined in
the #LOGTYPE block, are written to the default log
file. In this case, there is no Event Reporting, but
the repetition ID is active.
Description of the #DEFAULT block
The syntax of the #DEFAULT block is identical to that of the #LOGFILE
block. The only difference is that here, only one entry is permitted
for the default log file.
Example of an administration file
;************** Syntax of #LOGFILE ****************************
;FILENAME MAXSIZE in Kbyte MAXCH CLOSE Command
;------------- ----------------- ------- ------------- -------------
;file 10 chars min. 3 Kbyte 2...9 0: keep open "string"
;path 32 chars 1: close file
;************** Syntax of #LOGTYPE *******************
;COMPNO LOGFILE REPEATS DIRECTION
;-------------- ------------ ----------- -------------------------
;positive defined 1:recognize 0:logging only
;componenl logfile 0:ignore 1:event reporting DSM-ER
;number 2:filter and reaction
; 4:TRANSVIEW
; combination possible
; e.g. 5=DSM-ER + TRANSVIEW
#DEFAULT
;FILENAME Kbyte MAXCH CLOSE
;-------------- ----- ----- -----
default 100 5 1 ; this is the default destination file
; for applications without an explicit
; #LOGTYPE declaration.
#LOGFILE
;filename Kbyte MAXCH CLOSE
;-------------- ----- ----- -----
nmdiag 100 4 1 ; compno 14 15 19
cmserror 50 2 1 ; compno 16
cmsreport 50 2 1 ; compno 17
ot 50 2 1 ; compno 18
tspool 50 2 1 ; compno 32
iocs 50 2 1 ; compno 33
mwss 50 2 1 ; compno 35
auto 50 2 1 ; compno 41
tums 50 2 1 ; compno 45
tcompc 50 2 1 ; compno 47
tbackup 50 2 1 ; compno 48
sft 50 2 1 ; compno 55
datasyslog 50 4 1 ; compno 0xfffffffb-e 1080009-1080010
log3osm 50 4 1 ; compno 1080003
Page 5 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
radm 50 4 1 ; compno 1080004
#LOGTYPE
;COMPNO LOGFILE REPEATS DIRECTION NAME
;---------- ----------- ------- ---------- ----------------
1 default 1 0 ; T-LOG
13 default 1 0 ; Tele-X-Link
14 nmdiag 1 1 ; Network-Management
15 nmdiag 1 1 ; Network-Management
16 cmserror 1 1 ; CMS Fehlermeldug
17 cmsreport 1 0 ; CMS Statusmeldug
18 ot 1 0 ; Online Testprogr
19 nmdiag 1 1 ; Network-Management
22 default 1 0 ; Remote Support C
32 tspool 1 0 ; T-Spool
33 iocs 1 0 ; IOCS DPTG
35 mwss 1 0 ; IOCS MWSS
36 default 1 0 ; IOCS DPTG2
41 auto 1 0 ; Autooperating
45 tums 1 0 ; T-UMS
46 default 1 0 ; Key-Management
47 tcompc 1 0 ; T-COM PC
48 tbackup 1 0 ; T-Backup
49 default 1 0 ; PC Diagnose
51 default 1 0 ; Datenbank
52 default 1 0 ; LMX
53 default 1 0 ; RDA
54 default 1 0 ; T-COM SNM
55 sft 1 0 ; SFT Filetransfer
56 default 1 0 ; DFA/Questa
57 default 1 0 ; UTS
58 default 1 0 ; DSA-API
59 default 1 0 ; CMS-API
60 default 1 0 ; X-SDE
61 default 1 0 ; ALX
62 default 1 0 ; UTS 9750
0xfffffffb datasyslog 1 0 ; NVRAM
0xfffffffc datasyslog 1 2 ; driver
0xfffffffd datasyslog 1 2 ; kernel
0xfffffffe datasyslog 1 0 ; syslogd
1080001 default 1 0 ; Config
1080002 default 1 0 ; USV
1080003 log3osm 1 0 ; klogger
1080004 radm 1 0 ; Remote Administr
1080005 default 1 0 ; SIsih
1080006 default 1 0 ; hlmuci
1080007 default 1 0 ; Networker
1080008 default 1 0 ; cleandev
1080009 datasyslog 1 2 ; BIST/LAR/fwchk
1080010 datasyslog 1 2 ; errlogd
1130010 default 1 0 ; ASX
#end
Page 6 Reliant UNIX 5.44 Printed 11/98
log3admin(4) log3admin(4)
SEE ALSO
syslogd(1M), log3struct(4), log3(5).
Page 7 Reliant UNIX 5.44 Printed 11/98