nettlgen.conf(4) Kernel Interfaces Manual nettlgen.conf(4)
NAME
nettlgen.conf - network tracing and logging configuration file
SYNOPSIS
DESCRIPTION
the configuration file for Common Network Tracing and Logging commands commands, contains configuration information used by the and com-
mands (see nettl(1M), and netfmt(1M)). The command (see nettlconf(1M)) maintains network log and subsystem data in this file, allowing
subsystems to safely add, modify, or delete existing entries in the file. also allows system administrators to customize logging resource
usage parameters and file names. Changes to this file should only be made using the command.
The file is composed of records containing fields which are separated by colons Each line is a unique record containing either global net-
work information or subsystem information. The first field in each record is the tag field which identifies the type of information con-
tained in that record. A tag identifies global network log information; a tag identifies subsystem information. Blank lines or lines
beginning with are ignored.
Log Record
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 command. For the network log information changes to take effect, the sys-
tem administrator must stop and restart the network tracing/logging facility using the command.
Log record fields are as follows:
Field
Number Name Description
-------------------------------------------------------------
1 tag Contains LOG tag string.
2 Console Logging Flag Set to 1 if console log-
ging is to be enabled, 0
if not.
3 Log Port Size Amount of memory to
reserve for internal log
message buffers. Speci-
fied 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 configura-
tion file used for con-
sole logging.
The determines if console logging is to be enabled when the network tracing/logging facility is started. Console logging is used to dis-
play log messages on the system console using criteria specified in the file named by If there is no console present or console logging is
not desired this feature can be turned off using the command. During system bootup, the is always updated to reflect the value of the
NETTL_CONSOLE variable in the 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 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 volume of messages.
The 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 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
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 fil-
ter will be updated every time is started.
The field is optional. If omitted the default file will be used.
Subsystem Record
The subsystem record defines the information for that subsystem, and 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 NOTE: the information in the subsystem records
should only be changed by the subsystem using the 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
Number Name Description
-------------------------------------------------------------------
1 tag Contains SS tag string.
2 Subsystem ID Network tracing/logging
facility supports subsys-
tems in the range 0 -
511. 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 net-
work tracing and logging
facility is initialized.
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 nei-
ther.
6 Subformatter Shared Library Name of the shared
library file containing
the subformatter func-
tions listed below.
7 Subformatter Message Catalog Basename of the message
catalog to use when for-
matting data for this
subsystem.
8 Subformatter Function C function in the subfor-
matter library to call
when formatting data for
this subsystem.
9 Subformatter Options C function in the subfor-
matter 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.
The logging level can also be changed at run time using command for subsystems serviced by NetTL facility
If the subformatter library file name does not contain an absolute path, it is assumed to be under The subformatter library must be a
shared library.
EXTERNAL INFLUENCES
Message catalogs are found in the path determined by the environment variable Default message catalogs are found in where the contents of
the environment variable is substituted for the field, and the name specified in this parameter is substituted for the field.
EXAMPLES
The following example shows the default network logging information. Console logging is enabled; logging uses 8 Kbytes to hold log mes-
sages; the log files are limited to 1000 Kbytes total (500 Kbytes per file); the log files are and and the console logging filter file is
Most recent data is always in the file.
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.
The following example shows a typical subsystem record. These records should not be changed by the user, but are set by the subsystems
using during product installation.
The continuation marks in this example at end-of-line) and the following one are placed for readability purposes only. and do not under-
stand 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 will not operate properly.
FILES
SEE ALSO
netfmt(1M), nettl(1M), nettlconf(1M).
nettlgen.conf(4)
