Logs for the Infrastructure Management REST API

ProactiveNet.lo

This section lists the different log files that are part of Infrastructure Management.

Log files for REST APIs that retrieve data

The errors and exception messages of the APIs that retrieve data from Infrastructure Management are logged on to the following log files:

  • statsws.log
  • bppmws.log
  • TrueSight.log

The log files are located in the \pw\pronto\logs folder. 

Log files for REST APIs that manage CIs

The errors and exception messages of the APIs that manage CIs are logged on to the following log files:

  • ciws.log
  • bppmws.log
  • TrueSight.log

The log files are located in the \pw\pronto\logs folder. 

Log files for REST APIs that manage events

The errors and exception messages of the APIs that manage events are logged on to the following log files:

  • eventws.log
  • bppmws.log
  • TrueSight.log

The log files are located in the \pw\pronto\logs folder. 

Debug log files for REST APIs

The following debug log files also record the errors and exception messages if you have enabled them:

  • statsws.debug.log
  • ciws.debug.log
  • eventws.debug.log
  • bppmws.debug.log
  • jserver.log

The debug log files are located in the \pw\pronto\logs\debug folder. 

List of log files for REST API

The following table lists the log files that contain information related to Infrastructure Management:

Log file name

Description

Corresponding debug log file name

bppmws.log

Records all activities in the REST API framework. This log file must be included in all support cases that are related to REST API.

bppmws.debug.log

errorws.log

Records details about the failures in the REST API. This log file must be included in all support cases that are related to REST API.

errorws.debug.log

sapws.log

Records details about activities in the Single Access Point deployment that is for Central-Child servers (not Standalone servers). This log file must be included in all support cases that are related to REST API that run on Central server; Central-Child registration, deregistration, heartbeat; and DSIM use cases.

sapws.debug.log

bwws.log

Records details about ITDA integration.

bwws.debug.log

imws.log

Records details about IMData CRUD REST API.

imws.debug.log

statsws.log

Records the monitoring statistics data that is related to REST API.

statsws.debug.log

slows.log

Records details about the SLO CRUD REST API.

slows.debug.log

caws.log

Records details about Integration service that is related to REST API.

caws.debug.log

eventws.log

Records details about the Event CRUD REST API.

eventws.debug.log

ciws.log

Records details about the CI CRUD REST API.

ciws.debug.log

ctaws.log

Records details about Cloud Vista REST API that are used in CLM integration.

ctaws.debug.log

streamws.log

Records details about the Event Streaming related REST API.

streamws.debug.log

The log files are present in the \pw\pronto\logs folder. The debug log files are present in the \pw\pronto\logs\debug folder. The debug log files are available only when the debug option is enabled. For information about enabling the debug option, see Debug log files.

Note

You can also refer to TrueSight.log and jserver.log files for BMC TrueSight Infrastructure Management Server and JServer related log entries.

Subsystems of Infrastructure Management

Every log file is part of the subsystem of Infrastructure Management (bppmws subsystem). The supported subsystems of Infrastructure Management are:

  • statsws
  • ciws
  • eventws
  • slows
  • bppmws

bppmws is the gateway for Infrastructure Management, and bppmws is a subsystem on its own.

For example, the ciws.log file contains log entries of the REST APIs that manage CIs.

Configuration of log files

The log4j configuration file, bppmws.log4j.properties, located in the \pw\pronto\conf folder contains the configuration details of the log files for REST API. Each bppmws subsystem is listed in the log4j file as appender name.

For example, the configuration of statsws subsystem in the log4j file is as follows:

log4j.logger.com.bmc.sms.statsws=INFO, statsws
#Subsystem is specified as statsws

log4j.additivity.com.bmc.sms.statsws=false
#Sets the activity as false for the subsystem, which prevents from adding the entries to the rootLogger appender

log4j.appender.statsws=org.apache.log4j.RollingFileAppender
#Defines the appender for the subsystem

Debug log files

By default, the debug log files are not available. You must enable them using the pw debug CLI command. You can use the following pw debug commands:

  • pw debug list
  • pw debug on|off

For information about the pw debug commands, see pw-debug.

Note

For the pw debug command, the subsystem name is always prefixed by the gateway name, which is bppmws, but you do not have to prefix the gateway name if the subsystem is bppmws.

Examples for pw debug command

The following examples explain the usage of the subsystem names for the pw debug command:

  • To enable the debug log files for the slows subsystem, run the following pw debug command:
    pw debug on -p jserver -s bppmws/slows

    slows is the subsystem for the REST API. It is prefixed with bppmws which is the gateway name.
  • To disable the debug log files for the bppmws subsystem, run the following pw debug command:
    pw debug off -p jserver -s bppmws

    bppmws is the subsystem for the REST API, and it does not require the prefix of bppmws similar to other subsystems.