Setting logging level for GUI components

You can set the amount of information log files capture for each GUI component. The changes can be made before system startup or during operation. The changes are persistent, and are not affected by system restarts.

About this task

To set the logging behavior, you need to modify the corresponding configuration file.

Procedure

  1. Go to $NMGUI_HOME/profile/etc/tnm/.
  2. Open the .properties file of the GUI component you want to set the logging level for:
    Option Description
    discoconfig.properties

    Discovery configuration GUI
    itnmgraph.properties

    MIB graphing

    MIB Browser
    monitorconfig.properties

    Network polling configuration (poll policies and definitions)
    nmdb.properties

    Management database (formerly called OQL Workbench)
    nm_rest.properties

    ReST API and SQL queries
    structurebrowser.properties

    Structure browser
    tnm.properties

    General settings including database properties for GUI components
    topoviz.properties

    Topology visualization GUI
  3. Edit the line name.log.level to set the message level:
    Option Description
    CONFIG

    Logs all events up to and including configuration changes.
    INFO

    Logs only system state changes. This is the default setting.
    WARNING

    Logs recoverable system errors.
    SEVERE

    Logs unrecoverable system errors.
    FINE

    Minimum level of tracing. The majority of stack traces appear at this level already and are written to the trace file. The trace file also includes all log messages.

    Note: When setting the logging level to FINE, FINER, FINEST, or ALL, both log files and trace files will contain information, and the trace files will include all messages from the log files in addition to the more technical details of operation. If any other logging level is set, the trace files remain empty.
    FINER

    Medium level of tracing that provides more detailed debug messages.
    FINEST

    Maximum level of tracing that produces very detailed technical information.
    ALL

    Enables logging and tracing on all levels for the application.
    OFF

    Disables all logging and tracing for the application.
  4. Save and close the .properties file.
    Note: The changes take effect immediately if they are made before starting Network Manager. If the changes are made when the system is already running, Network Manager reads the configuration files every 60 seconds and applies any changes immediately.

Example

The following example shows the section of the structurebrowser.properties file that determines logging level:

structurebrowser.log.filename=ncp_structureview.%g.log
structurebrowser.log.level=INFO
structurebrowser.log.maxsize=10
structurebrowser.log.count=1

structurebrowser.trace.filename=ncp_structureview.%g.trace
structurebrowser.trace.maxsize=10
structurebrowser.trace.count=1

The settings here show the default INFO setting for the log files. This means log files are populated with information about system state changes, and trace files remain empty.

To change the logging level to have all log messages and enable trace messages, change INFO to at least FINE (or FINER, or FINEST, depending on the level of detail you require in the trace files). This will mean both log files and trace files will contain information. The following example reflects this change:

structurebrowser.log.filename=ncp_structureview.%g.log
structurebrowser.log.level=FINE
structurebrowser.log.maxsize=10
structurebrowser.log.count=1

structurebrowser.trace.filename=ncp_structureview.%g.trace
structurebrowser.trace.maxsize=10
structurebrowser.trace.count=1