ctfile.cfg File

Purpose

Controls tracing and logging for various RSCT components.

Description

To initiate tracing and logging control, system administrators can create the RSCT file configuration (RFC) file, /etc/ctfile.cfg. A system administrator can copy a sample configuration file, /opt/rsct/cfg/ctfile.cfg, to the /etc directory, and then modify it. The control information in the configuration file takes effect the next time a specified component, a daemon, for example, is started.

RSCT components that support tracing and logging control, which are listed in the sample configuration file, obtain the following information from /etc/ctfile.cfg:
  • An absolute path to a directory tree under which the component trace files and log files are to be written. This path can refer to a remote file system.
  • A flag that indicates whether tracing is to be disabled for each component.
  • A flag that indicates whether tracing is to be disabled for all RSCT components.
  • When tracing is enabled, the size of a trace file for each component and each trace file. Some components write to several trace files.
  • The amount of information to be traced.
  • A flag that indicates whether logging is to be disabled for each component.
  • A flag that indicates whether logging is to be disabled for all RSCT components.

Lines that consist of only the characters NL or white space are ignored. If the first non-white-space character of a line is the number sign character (#), the line is a comment, so it is ignored. All other lines must contain one or more tokens. If there is more than one token on a line, the tokens must be separated by white space. A token line can contain leading or trailing white space. White space is any mix of the blank and tab characters.

The trace and log root directory token

The trace and log root directory token is a name/value pair. The format is:
CT_TRACE_LOG_ROOT_DIR=path_name
The path name must be absolute. If this token is not specified, the trace and log root directory is assumed to be /var/ct. In either case, all trace and log file path names are constructed with the trace and log root directory as the path name prefix.

The trace disable token

The trace disable token is a name/value pair followed by an optional component name. The format is:
CT_TRACE_DISABLE={true|false} [component_name]
This token can be specified more than once, each on a separate line. If this token is not specified then tracing is enabled for all components that reference this file and are not otherwise specified in another trace disable token line. If this token is specified with a value of true, and no component name is specified, tracing is disabled for all components that reference this file and are not otherwise specified in another trace disable token line. If this token is specified with a value of false, and no component name is specified, then tracing is enabled for all components that reference this file and are not otherwise specified in another trace disable token line. If a component name is specified then tracing for that component is enabled or disabled to match the value false or true, respectively. For a component, the token line that specifies that component has precedence over any token line that does not specify a component. If more than one token line specifies the same component, the last such token line has precedence. Component names are the resource manager names in the case of resource managers (as derived from the resource manager .mdef file), mc in the case of the RMC daemon and ctcasd in the case of the cluster authentication services daemon. Specifically, the component name must be the name used in constructing the full path name of a trace file. Here is an example:
CT_TRACE_DISABLE=true
CT_TRACE_DISABLE=false mc
CT_TRACE_DISABLE=false IBM.MgmtDomainRM
Tracing is enabled for the management domain resource manager and the RMC daemon. For all other components trace is disabled.

The trace file size token

The trace file size token is a name/value pair followed by a component name and trace file name. It has the following form:
CT_TRACE_FILE_SIZE=nnn[K] component_name file_name
where nnn is the size of the specified trace file in bytes. If the optional K suffix is specified, the size is specified in units of 1024 bytes. The RSCT trace facility rounds up file sizes to a page boundary. If a trace file size token is not specified, components use the file sizes that are programmed into the component.

The trace level token

The trace level token is a name/value pair followed by a component name. The format is:
CT_TRACE_LEVELS=string component_name
The level string is in standard trace facility format, for example, Comp_ID:category=level. If a trace level token is not specified, components use the trace levels programmed into the component. Trace levels determine the amount of information recorded in a trace file.

The logging disable token

The logging disable token is a name/value pair followed by an optional component name. The format is:
CT_LOGGING_DISABLE={true|false} [component_name]
This token can be specified more than once, each on a separate line. If this token is not specified, logging is enabled for all components that refer to this file and are not otherwise specified in another logging disable token line. If this token is specified with a value of true and no component name is specified, logging is disabled for all components that refer to this file and are not otherwise specified in another logging disable token line. If this token is specified with a value of false and no component name is specified, logging is enabled for all components that refer to this file and are not otherwise specified in another logging disable token line. If a component name is specified, logging for that component is enabled or disabled to match the value false or true, respectively. For a component, the token line that specifies that component has precedence over any token line that does not specify a component. If more than one token line specifies the same component, the last such token line has precedence. Component names are the resource manager names in the case of resource managers (as derived from the resource manager's .mdef file), mc in the case of the RMC daemon and ctcasd in the case of the cluster authentication services daemon. Specifically, the component name must be the name that is used in constructing the full path name of a logging file.

Files

/etc/ctfile.cfg
Location of the RSCT file configuration (RFC) file that is created by the system administrator
/opt/rsct/cfg/ctfile.cfg
Location of the sample ctfile.cfg file

Implementation specifics

This file is part of the Reliable Scalable Cluster Technology (RSCT) fileset for AIX®.

Location

/etc/ctfile.cfg