nettlgen.conf(4) nettlgen.conf(4)
NAME [Toc] [Back]
nettlgen.conf - network tracing/logging and kernel logging
configuration file
SYNOPSIS [Toc] [Back]
/etc/nettlgen.conf
DESCRIPTION [Toc] [Back]
/etc/nettlgen.conf, the configuration file for Common Network
Tracing/Logging and Kernel Logging commands commands, contains
configuration information used by the nettl, kl, and netfmt commands
(see nettl(1M), kl(1M), and netfmt(1M)). The nettlconf command (see
nettlconf(1M)) maintains network and kernel log and subsystem data in
this file, allowing subsystems to safely add, modify, or delete
existing entries in the file. nettlconf also allows system
administrators to customize logging resource usage parameters and file
names. Changes to this file should only be made using the nettlconf
command.
The file is composed of records containing fields which are separated
by colons (:). Each line is a unique record containing either global
network or kernel logging information or subsystem information. The
first field in each record is the tag field which identifies the type
of information contained in that record. A LOG tag identifies global
network log information; a KL tag identifies global kernel log
information; a SS tag identifies subsystem information. Blank lines
or lines beginning with # are ignored.
Log Record [Toc] [Back]
The log record defines static information used to configure logging
defaults such as the name of the log file and whether to turn console
logging on or off. Note that only the last log record encountered in
the file is used; prior log records are ignored. Users can alter the
network log information to suit their particular needs using the
nettlconf command. For the network log information changes to take
effect, the system administrator must stop and restart the network
tracing/logging facility using the nettl command.
Log record fields are as follows:
Field [Toc] [Back]
Number Name Description
___________________________________________________________
1 tag Contains LOG tag string.
2 Console Logging Flag Set to 1 if console
logging is to be
enabled, 0 if not.
Hewlett-Packard Company - 1 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
3 Log Port Size Amount of memory to
reserve for internal log
message buffers.
Specified in Kbyte
units. Valid range is 1
- 32. The default is 8.
4 Maximum Log File Space Determines the maximum
logging file space to be
allowed. Specified in
Kbyte units. This value
is the combined size of
the 2 ping-ponged log
files. Valid range is 1
- 10240. The default is
1000.
5 Log File prefix Path and name of the log
file, without the type
and age extension
(.LOG0x, where x is 0 or
1).
6 Console Filter File Name of filter
configuration file used
for console logging.
The Console Logging Flag determines if console logging is to be
enabled when the network tracing/logging facility is started. Console
logging is used to display log messages on the system console using
criteria specified in the file named by Console Filter File. If there
is no console present or console logging is not desired this feature
can be turned off using the nettlconf command. During system bootup,
the Console Logging Flag is always updated to reflect the value of the
NETTL_CONSOLE variable in the /etc/rc.config.d/nettl file.
If more information is desired than the special terse form used for
console logging, turn off console logging and start a formatter with
an options file specifying the filters to use (see netfmt(1M)).
The Log Port Size defines the number of outstanding messages possible
in the log queue. For logging, 256-byte buffers are used. The number
chosen here indicates how much space to allocate in kilobytes. The
default size is 8192 bytes (specified by 8), which is split into
thirty-two 256-byte blocks. The first block is reserved by the
system, leaving 31 blocks for log messages. Each log message starts
on a new block, taking 64 bytes of overhead. In addition, each block
takes 8 bytes of overhead. The largest message that can be stored
using the default size is 7624 bytes ((31 * 256) - (31 * 8) - 64).
Most log network messages are fairly small, so choosing 8K of buffer
is sufficient for the network logging facility to keep up with a large
Hewlett-Packard Company - 2 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
volume of messages.
The Maximum Log File Space determines the maximum logging file space
to be allowed. Log files are split into two parts. When an
individual log file reaches one-half of the maximum specified here,
the network logging system deletes any existing old file, renames the
current file to the old file, and starts a new file. The default
specification allows for 1 Megabyte of total network log file storage
(each file does not exceed 500K bytes). Since logging is usually
infrequent and network log messages are fairly small, this should be
more than adequate for all needs. The rate at which the file space
fills up depends on what level of network logging is turned on for
each subsystem, the volume of network traffic, frequency of
connections, etc; and is very difficult to predict.
The Console Filter File specifies the name of the file containing
formatter filters used for console logging. This file contains
filters that control the logged information displayed on the console.
The syntax of this file is the same as the filter configuration files
that are used with the netfmt command. See netfmt(1M) for more
details on filter configuration files.
If the console filter file does not exist, the specified file is
created with a default set of filters which will display DISASTER
messages on the console. If the console filter file does exist and
contains a time_from filter, the time_of_day and day_of_year fields in
the filter will be updated every time nettl is started.
The Console Filter File field is optional. If omitted the default
file /var/adm/conslog.opts will be used.
KL Record [Toc] [Back]
KL record fields are as follows:
Field [Toc] [Back]
Number Name Description
_________________________________________________________________
1 Tag Contains KL tag string
2 KL Minimum (initial) Queue Size Minimum (initial)
amount of messages
that could
simultaneously reside
in the memory. Valid
range is 100 - 10000.
The default is 1000.
Hewlett-Packard Company - 3 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
3 KL Maximum Queue Size Maximum amount of
messages that could
simultaneously reside
in the memory. Valid
range is 100 - 10000.
The default is 1000.
4 Maximum KL File Space Determines the maximum
logging file space to
be allowed. This
value is the size of
the ping-ponged log
file. Valid range is
8K - 1024M. The
default is 1M.
5 Log File Prefix Path and name of the
log file, without the
type and age extension
(.KLOG0x, where x is 0
or 1).
6 Write To Disk Flag Set to 1 if writing
messages to disk is to
be enabled when KL
facility is started, 0
if not.
The KL Minimum and Maximum Queue Size define the number of outstanding
messages possible in the kernel log queue. The default size is 1000.
The Maximum Log File Space determines the maximum logging file size to
be allowed. Log files are split into two parts. When an individual
log file reaches the maximum specified here, the kernel logging system
deletes any existing old file, renames the current file to the old
file, and starts a new file. The default specification allows for 1
Megabyte of the kernel log file storage for one file. The rate at
which the file space fills up depends on what level of kernel logging
is turned on for each subsystem, the load of the system, number of
central processor units (CPUs), and is very difficult to predict. One
can use suffixes K and M to specify whether the size is to be in Kilo
or Mega bytes. For instance, 16K = 16384 and 4M = 4096K.
The Write To Disk Flag determines if writing kernel logging messages
to disk is to be enabled when the kernel logging facility is started.
Writing to disk is used to preserve the information stored inside
kernel logging messages on the non-volatile storage and to have a
permanent log of kernel activity.
Subsystem Record [Toc] [Back]
The subsystem record defines the information for that subsystem, and
Hewlett-Packard Company - 4 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
has ten fields including the tag field. The fields are separated by
colons (:); thus no field can contain a colon. An empty field can be
represented by the string NULL. NOTE: the information in the
subsystem records should only be changed by the subsystem using the
nettlconf command during system installation. Users should not change
this information unless directed by a Hewlett-Packard support
representative.
Subsystem record fields are as follows:
Field [Toc] [Back]
Number Name Description
________________________________________________________________
1 tag Contains SS tag string.
2 Subsystem ID An integer between 0
and 1023. Network
tracing/logging
facility supports
subsystems in the range
0 - 511, while Kernel
logging facility
services subsystems
between 512 and 1023.
This number is set by
the HP factory and must
not be changed.
3 Subsystem Mnemonic A text string
consisting of letters,
numbers, and the
underscore character.
The string is set at
the factory and must
not be changed.
4 Initial Log Level Logging level for the
subsystem when the
network tracing/logging
or kernel logging
facility is
initialized. This value
is different depending
on whether subsystem is
supported by NetTL or
KL facility. Please
see explanation below.
Hewlett-Packard Company - 5 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
5 Subsystem Type Set to s if the
subsystem is streams
based and exists in the
kernel, k if the
subsystem exists in the
kernel and non-streams
based, u if neither.
Subsystems, whose IDs
are within 512 - 1023
range, i.e. subsystems
supported by KL
facility, should have
Subsystem Type to be k.
6 Subformatter Shared Library Name of the shared
library file containing
the subformatter
functions listed below.
7 Subformatter Message Catalog Basename of the message
catalog to use when
formatting data for
this subsystem.
8 Subformatter Function C function in the
subformatter library to
call when formatting
data for this
subsystem.
9 Subformatter Options C function in the
subformatter library to
call to get filter
options for this
subsystem.
10 Group Name A text string to be
used in the header
banner line in the
formatted output.
The recommended setting for the default logging level is set by the
products' configuration scripts. The available classes are Disaster
(8), Error (4), Warning (2), and Informative (1). Classes can be
combined by adding the numbers; thus Disaster and Error together
become 12. It can be changed by the user if another level of logging
is desired on initialization. NOTE: for KL subsystems, logging is
enabled for all classes with greater severity than the logclass value
in the SS line.
Hewlett-Packard Company - 6 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
The logging level can also be changed at run time using nettl -log
command for subsystems serviced by NetTL facility and using kl -l
command for subsystems serviced by KL facility.
If the subformatter library file name does not contain an absolute
path, it is assumed to be under /usr/lib. The subformatter library
must be a shared library.
EXTERNAL INFLUENCES [Toc] [Back]
Message catalogs are found in the path determined by the environment
variable NLSPATH. Default message catalogs are found in
/usr/lib/nls/%L/%N.cat where the contents of the LANG environment
variable is substituted for the %L field, and the name specified in
this parameter is substituted for the %N field.
EXAMPLES [Toc] [Back]
The following example shows the default network logging information.
Console logging is enabled; logging uses 8 Kbytes to hold log
messages; the log files are limited to 1000 Kbytes total (500 Kbytes
per file); the log files are /var/adm/nettl.LOG000 and
/var/adm/nettl.LOG001; and the console logging filter file is
/var/adm/conslog.opts. Most recent data is always in the .LOG000
file.
#
# LOG INFORMATION
#
LOG:1:8:1000:/var/adm/nettl:/var/adm/conslog.opts
The following example turns off console logging, and limits the size
of the log file space to 100 Kbytes. Other values are the same as the
default.
#
# LOG INFORMATION
#
LOG:0:8:100:/var/adm/nettl:/var/adm/conslog.opts
The following example shows the default kernel logging information.
Kernel logging queue can keep 1000 messages; the log file is limited
to 1M bytes total (512 Kbytes for each file); the kernel log files are
/var/adm/kl.KLOG0 and /var/adm/kl.KLOG1 ; and the write to disk flag
is set to 0. Most recent data is always in the .KLOG0 file.
#
# KL INFORMATION
#
Hewlett-Packard Company - 7 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
KL:1000:1000:1M:/var/adm/kl:0
The following example turns on write to disk option when KL facility
is started, decreases the size of the kernel logging queue to 500
messages and increases the size of the log file space to 5M bytes.
Other values are the same as the default.
#
# KL INFORMATION
#
KL:500:5000:5M:/var/adm/kl:1
The following example shows a typical subsystem record. These records
should not be changed by the user, but are set by the subsystems using
nettlconf during product installation.
#
# TEST NetTL SUBSYSTEMS
#
SS:96:TEST_ID_1:8:u:NULL:netfmt:subsys_GENERIC_FORMAT: \
ss_96_go:FORMATTER
SS:97:TEST_ID_2:8:u:NULL:netfmt:subsys_GENERIC_FORMAT: \
ss_97_go:FORMATTER
#
# Test KL Subsystems
#
SS:538:Test_ID_8:8:k:libklfmt.sl:klfmt:subsys_kl_format: \
subsys_kl_get_options:KERNEL LOGGING
SS:539:Test_ID_9:12:k:libklfmt.sl:klfmt:subsys_kl_format: \
subsys_kl_get_options:KERNEL LOGGING
Note: The continuation marks in this example (\ at end-of-line) and
the following one are placed for readability purposes only. nettl,
kl, and netfmt do not understand continuation mark.
The following entry must always be included in the configuration file.
This defines the subsystem for the formatter itself; if it is not in
the file, the formatter netfmt will not operate properly.
#
# FORMATTER SUBSYSTEMS
#
SS:127:FORMATTER:12:u:libfmtutil.sl:netfmt: \
subsys_GENERIC_format:subsys_127_get_options:FORMATTER
Hewlett-Packard Company - 8 - HP-UX 11i Version 2: August 2003
nettlgen.conf(4) nettlgen.conf(4)
SS:512:FORMATTER:e:u:libfmtutil.sl:netfmt: \
kl_GENERIC_format:subsys_512_get_options:KL FORMATTER
FILES [Toc] [Back]
/etc/nettlgen.conf
SEE ALSO [Toc] [Back]
netfmt(1M), nettl(1M), kl(1M), nettlconf(1M).
Hewlett-Packard Company - 9 - HP-UX 11i Version 2: August 2003 [ Back ] |
