DSLOG-MANAGER system handle attributes and methods
- Last Updated: March 30, 2020
- 2 minute read
- OpenEdge
- Version 12.2
- Documentation
The DSLOG-MANAGER system handle is similar to the
LOG-MANAGER system handle. Is is used to control the logging settings for
the server context of the OpenEdge DataServer logging infrastructure, while the
LOG-MANAGER controls logging settings for OpenEdge Client and DataServer
client context. Although both provide attributes and methods for enabling, disabling, and
changing logging capabilities, the DSLOG-MANAGER applies only to DataServer
components.
The DB-CONTEXT attribute must be set before any other
DSLOG-MANAGER attribute can be accessed.
The following table lists the DSLOG-MANAGER system handle attributes.
| Attribute | Access | Function |
|---|---|---|
DB-CONTEXT1
|
Readable/ Writable | Specifies the logical database name of a valid and connected data
source for a supported db-type. It set the system handle to a specific server context
to enable access to other DSLOG-MANAGE attributes and methods. You
can also set it to the alias of a connected data source. |
ENTRY-TYPES-LIST |
Readable | Returns a list of all valid entry types. |
LOG-ENTRY-TYPES |
Readable/ Writable | Returns/Writes a list of one or more types of log entries. The
default value returned by the LOG-ENTRY-TYPES attribute are the
logentrytypes specified in the -Dsrv parameter
when the foreign data source was connected. |
LOGFILE-NAME2
|
Readable | Returns the name of the log file. By default, the
DSLOG-MANAGER uses the dataserv.lg log file. You
can change the file name by using the -dslog startup parameter from
the OpenEdge client or the srvrDSLogFile UBROKER property from the
DataServer broker instance. The server context cannot work without a log file opened
so it cannot be changed at runtime. This would risk having no log file opened in the
event that the new log file name failed to open. |
LOGGING-LEVEL |
Readable/ Writable | Returns/Writes the level at which log entries are written. The
default value returned by the LOGGING-LEVEL attribute is the
logginglevel specified in the -Dsrv parameter when
the foreign data source was connected. |
LOG-THRESHOLD3
|
Readable | Returns the file size threshold of log files. When the current log file becomes equal to or greater than the specified size, OpenEdge renames and saves the log file and creates a new log file. |
NUM-LOG-FILES4
|
Readable | Returns the number of rolled over log files to keep on disk at any one time, for OpenEdge session, including the current log file. |
HANDLE
|
Readable | Returns a handle. |
INSTANTIATING-PROCEDURE
|
Readable | Returns a procedure handle for the first, or instantiating, procedure. |
TYPE
|
Readable | Returns the type of handle. |
By default, the DSLOG-MANAGER uses the dataserv.lg log
file. You can change the file name by using the -dslog startup parameter from
the OpenEdge client or the srvrDSLogFile UBROKER property from the DataServer
broker instance.
The following example tests for an active connection before setting the
DSLOG-MANAGER to that connected DataServer context and getting a list of
log entry types and setting a specific message inside the application at runtime.
|
For more information on the DSLOG-MANAGER system handle or its attributes,
see the DSLOG-MANAGER system handle reference entry in OpenEdge
Development: ABL Reference.
The following table lists the function of each DSLOG-MANAGER system handle
method.
| Method | Function |
|---|---|
CLEAR-LOG( ) |
Clears all messages existing in the current client log file and leaves the file open for writing |
WRITE-MESSAGE( ) |
Writes user messages to the current log file |
CLOSE-LOG( ) is not a supported
DSLOG-MANAGER system handle method. You cannot execute the
CLOSE-LOG( ) method unless there is only one brokered DataServer server
spawned by the Unified Broker or by ProBroker.DB-CONTEXT attribute enables you to provide different logging settings
for each data source connection. The DB-CONTEXT attribute must be set to
the logical database name or alias which is currently connected, prior to setting any other
attributes. The attribute defaults to the unknown value. If DB-CONTEXT does
not contain the value of a valid logical database name, any attempt to access other
attributes of DSLOG-MANAGER fails. LOGFILE-NAME is the default name
dataserv.lg or; the name specified by the -dslog
client startup parameter for self-service clients; the name specified by the
-dslog startup parameter when ProBroker is started; the name specified by
the srvrDSLogFile attribute in the ubroker.properties
file when a Unified Broker instance is started for DataServer connections.LOG-THRESHOLD is one of
the following:the name specified by the -logthreshold client startup
parameter for self-service clients; the name specified by the -logthreshold
startup parameter when ProBroker is started; the name specified by the
srvrLogThreshold attribute in the ubroker.properties
file when a Unified Broker instance is started for DataServer connections.NUM-LOG-FILES is one of the
following: the name specified by the -numlogfiles client startup parameter
for self-service clients; the name specified by the -numlogfiles startup
parameter when ProBroker is started; the name specified by the
srvrNumLogFiles attribute in the ubroker.properties
file when a Unified Broker instance is started for DataServer connections.