Monitoring the Publishing Server with cell events

By default, the publishing server sends event information to the cell. Users with service administrator access can monitor the status of a publishing server by using the administrator console. For the request, connection, and error events, see the Administration tab. For information about the administrator console, see Infrastructure Management administrator console.

You can view all generated events in the operator console, from Other Cells > Admin > By Location > < domain_name> > < host_name> > < publishingserver_name >.

TrueSight Infrastructure Management creates ADMIN_EVENT for the control events of the publishing server, so you can view the status of the publishing server in Infrastructure Management view of the administrator console.

If automated Atrium CMDB Publishing is enabled, you must monitor the publication requests to locate failures.

Modifying the generation of events

The Publishing Server creates status, connection, and publication request information that describes the internal state of the publishing server and its connection to the Atrium CMDB and the cells.

To modify the publishing server events sent to a cell, you can make changes in configuration files. The following table describes the types of events with an example, the configuration file for each, and the location of the configuration file.

Publishing Server event generation

Type of event	Example event message	Configuration file name	Configuration file location on the cell computer
Control–status events generated when the publishing server starts or stops in a controlled way	Publishing Server started	pserver.conf	**installationDirectory/pw/server/etc/pserver.conf** or if this file does not exist, then installationDirectory/pw/server/etc/ ps_ hostName/ pserver.conf
Connection – events generated when the publishing server makes a connection with one of its surrounding components	serverName connection failure.	pserver.conf	**installationDirectory/pw/server/etc/pserver.conf** or if this file does not exist, then installationDirectory/pw/server/etc/ ps_ hostName/ pserver.conf
Request – events generated for every publication and classinfo request that is processed by the publishing server	Class validation request failed.	pserver.conf	**installationDirectory/pw/server/etc/pserver.conf** or if this file does not exist, then installationDirectory/pw/server/etc/ ps_ hostName/ pserver.conf
Error – events that indicate that there is a problem with the correct functioning of the publishing server	serverName exception occurred: xxx	pserver.trace	**installationDirectory/pw/server/etc/pserver.trace** or if this file does not exist, then installationDirectory/pw/server/etc/ ps_ hostName/ pserver.trace

To modify the generation of events

In the pserver.conf file, set the IPSEventsIM parameter to the name of the cell that will receive the events.

In the example, events are sent to the cell named cell.Admin (default cell).

Example

In the relevant section of the pserver.conf file:

#---------------------------------------------------------------------------
#Events
#---------------------------------------------------------------------------
#Events tracking Publishing Server's operation and errors are sent to im
#<IPSEventsIM>
#IPSEventsIM=<ImpactAdminCell>
#By default IPS_EVENTs are generated to the Impact Admin Cell
IPSEventsIM=cell.Admin
#Only operation events of the classes listed in IPSEventClasses are created.
#By default events of all IPS_EVENT concrete subclasses are created
#IPSEventClasses=IPS_START,IPS_STOP,IPS_CONFIG,IPS_CONNECT,#IPS_IM_CONNECT,
#IPS_PUBLISH,IPS_CLASSINFO
#Enabling of error events (IPS_ERROR) is to be configured in pserver.trace

If you enter an incorrect cell name in this file, (a cell name that is not present in the cell directory as it is configured by IMFileDirectoryName), then no events are generated. In the tmp/ps_ hostname/pserver.trace output file, the error message is Unable to report ips events to im X: IPSEventsIM points to unregistered im.

To generate error events, in the etc/pserver.trace file, uncomment the following line by removing the # at the beginning of the line as shown in the example..
#log4j.logger.com.bmc.sms.ps=DEBUG, IPSERROREVENTS

Example

In the relevant section of the pserver.trace file:

# Print messages of level DEBUG or above in the package
#log4j.logger.com.bmc.sms.imapi=DEBUG
#log4j.logger.com.bmc.sms.imapi.nls=DEBUG
#log4j.logger.com.bmc.sms.imapi.gw=DEBUG
#log4j.logger.com.bmc.sms.imobject=DEBUG
*log4j.logger.com.bmc.sms.ps=DEBUG, IPSERROREVENTS*

Restart the Publishing Server service or process.

Understanding classes and slots for Publishing Server events

The following table describes the Common Event Model (CEM) slots (defined in CORE_EVENT ) and values that are applicable to all events generated by Publishing Server.

Common Event Model (CEM) slots

Slot name	Slot label	Description	Default value
mc_event_category	Category	High-level normalized category of the object the event represents	OPERATIONS_MANAGEMENT
mc_object_class	Object Class	Identifies the class of an object	For status events of the publishing server itself = Publishing Server For status events of the automated publishing service of the publishing server = Publishing Server - Automated Publishing
mc_object	Object	Name of the Publishing Server instance	ps_hostname
mc_host_class	Host Class	Type of host	Computer
mc_host	Host	Name of the computer on which Publishing Server is running	Not defined
mc_host_address	Host Address	Network address of the host computer on which Publishing Server is running	Not defined
mc_origin_class	Origin Class	Identifies the event management system type	Publishing Server
mc_origin	Origin	Specifies the event management system that is "closest" to the source of the event and is considered to have detected the event	ps_hostName
mc_tool_class	Tool Class	The way in which the incident is reported to the cell	Publishing Server
mc_tool	Tool	Defines where any event is within a value that can further distinguish where the event is coming from within the mc_tool_class value	ps_hostName
mc_tool_address	Tool Address	IP address of the host computer on which Publishing Server is running	Not defined

Event classes and slots specific to Publishing Server

The event classes that are specific to Publishing Server are subclasses of the class IPS_EVENT. The class hierarchy for IPS_EVENT is

IPS_EVENT

IPS_CONTROL

IPS_START

IPS_STOP

IPS_CONFIG

IPS_CNX

IPS_CONNECT

IPS_IM_CONNECT

IPS_ERROR

IPS_REQUEST

IPS_CLASSINFO

IPS_PUBLISH

These classes are defined in the ips.baroc file, located in the installationDirectory/pw/server\etc\default\standard\kb\classes directory.

When you enable event generation to a cell, all operational events are generated, which are the event classes IPS_START, IPS_STOP, IPS_CONFIG, IPS_CONNECT, IPS_IM_CONNECT, IPS_PUBLISH, and IPS_CLASSINFO.

In addition to operational events, you can also enable the generation of Publishing Server error events of the class IPS_ERROR.

IPS_START--Impact Publishing Server start

The IPS_START class contains events that occur when the Publishing Server service (or process) is started or when automated publishing is started.

IPS_START slots

Slot name

Slot label

Description

process_run_id

Process Run ID

All IPS_CONTROL events that are generated from the same processing run of Publishing Server are assigned the same process run ID (guid) for easy correlation of these events.

mc_parameter

Status

Value is the string status

mc_parameter_value

Parameter Value

Indicates the status of Publishing Server:

As it launches: starting
When up and running: started

IPS_STOP – Impact Publishing Server stop

The IPS_STOP class contains events that occur when the Publishing Server service (or process) is stopped.

IPS_STOP slots

Slot name	Slot label	Description
process_run_id	Process Run ID	All IPS_CONTROL events that are generated from the same processing run of Publishing Server are assigned the same process run ID (guid) for easy correlation of these events.
Severity	Severity	Seriousness of the event; default is INFO
mc_parameter	Status	Value is the string status
mc_parameter_value	Parameter Value	Indicates the status of the Publishing Server: When stopping: stopping When stopped: stopped

IPS_CONFIG – Impact Publishing Server configuration file

The IPS_CONFIG class contains events that are generated when Publishing Server starts and displays configuration information for the Publishing Server instance, as shown in the following table.

Event generation for this class is enabled by default.

IPS_CONFIG slots

Slot name	Slot label	Description
os_class	OS Class	Indicates the class of the operating system
os_version	OS Version	Indicates the version of the operating system
process_run_id	Process Run ID	All IPS_CONTROL events that are generated from the same processing run of Publishing Server are assigned the same process run ID (guid) for easy correlation of these events.
ps_version	IPS Version	Contains the version of the Publishing Server
ps_build_number	IPS Build Number	Contains the software build number of the Publishing Server
ps_build_date	IPS Build Date	Contains the build date of the Publishing Server
home_dir	Home Directory	Contains the absolute path of the home directory for the Publishing Server
conf_file	Configuration File	Contains the absolute path of the configuration file; pserver.conf is the default file
kb_dir	KB Directory	Contains the absolute path of the kb directory
log_dir	Log Directory	Contains the absolute path of the log directory
mcell_dir	Cell Directory Fi le	Contains the absolute path of the cell directory file (default is mcell.dir )
trace_conf	Trace Configuration File	Contains the absolute path of the trace configuration file; pserver.trace is the default file
trace_file	Trace File	Contains the absolute path of the trace file; pserver.trace is the default file

IPS_CONNECT – Impact Publishing Server connect

The IPS_CONNECT class contains events that occur when Publishing Server tries to establish a connection to other components.

IPS_CONNECT slots

Slot name	Slot label	Description
ips_request_id	Request ID	The ID of the request sent to the publishing server.The connection is required for the processing of the request. For every request, IPS_CONNECT events are created for every component that must be connected.
Destination	Destination	Type of the component to which the publishing server is connecting; possible values are as follows: CMDB for BMC Atrium CMDB IM for BMC Impact Manager SMM for Service Model Manager
dst_name	Destination Name	Name of the component to which the publishing server is connecting
dst_location	Destination Location	Host and port number of the computer to which the publishing server is connecting
dst_user	Destination User	Logon used to connect blank for Impact Manager and Service Model Manager connections because those connections do not require authentication
Result	Result	Indicates the success or failure of the connection; possible values are SCS when the connection succeeds FLR when the connection fails

IPS_IM_CONNECT – Impact Publishing Server connect

The IPS_IM_CONNECT class contains events that occur when the Publishing Server tries to establish a connection to a cell.

IPS_IM_CONNECT slots

Slot name	Slot label	Description
dst_location2	Destination Secondary Location	Host and port number of the secondary Infrastructure Management Impact Manager server, if high availability is enabled

IPS_REQUEST – Publishing Server request

The IPS_REQUEST class contains events that occur when Publishing Server receives a request (for example, a request for a publishing preview).

IPS_REQUEST slots

Slot name	Slot label	Description
Severity	Severity	Enables you to follow the status of a request. When the request is sent to the Publishing Server, the severity is INFO. When the Publishing Server finishes the processing of this request, it updates the severity of the event: OK if the request is successful WARNING if the request failed
client_data	Client Data	Data coming from the client. For automated publishes resulting from a BMC Impact Model Designer promotion, this slot displays the ReconJobRunId and the PromotionId.
request_id	Request ID	The ID of the request sent to the Publishing Server This ID is necessary when you retrieve the request log by using a BMC IX local action and is useful in diagnosing publication failures.
request_msg	Request Message	The content of the request (for example, EnvId=PROD; Queue=T). This is the internal communication protocol, useful for debugging.
request_result	Request Result	Initially UNK (unknown). Set to SCS (success) or FLR (failure) when processing is terminated.
result_msg	Result Message	Brief description of the success or the failure of the handled request. For example, Request failed: Publish verification of IM(s) failed. You can find more detailed failure messages in the request log.
user_id	User ID	The logon user ID of the requestor. For automated publishes that are invoked from a BMC Impact Model Designer promotion, this slot displays the BMC Impact Model Designer logon user ID. For publishes from a CLI, this slot displays the user of the CLI or publish@ hostname if the CLI is run locally without authentication.
Description	Description	The description that comes with the request. For automated publishes resulting from a BMC Impact Model Designer promotion, this slot displays the BMC Impact Model Designer promotion comment. For publishes from a CLI, this slot displays the description you entered when using the -s option.

IPS_PUBLISH – Publishing Server publication request

The IPS_PUBLISH class contains events that occur when a request for a publication is generated.

IPS_PUBLISH slots

Slot name

Slot label

Description

publish_type

Publish Request Type

Indicates the type of publish; possible values are as follows:

direct when the publish request is for a DirectPublish
init when the publish request is an initialization, as with the pinit cli
publish when the publish request is a delta or incremental publication, as with automated publish or with the publish CLI command
selected_publish when a publish request is for selected objects, as with the publish -d
CLI command

env_id

Environment ID

ID of the publishing environment
For example:

PROD for production environment
TEST.user.1 for BMC Impact Model Designer test environment

IPS_CLASSINFO – Publishing Server class information request

The IPS_CLASSINFO class contains events that are generated when information about classes is requested, for example, when you use a CLI to verify the class definitions between a cell and the BMC Atrium CMDB.

IPS_CLASSINFO slots

Slot name

Slot label

Description

classinfo_type

Class Info Request Type

Indicates the type of classinfo; possible values are as follows:

validation when the classInfo request happens with the CLI command pclassinfo -n cellName
export when the classInfo request is generated with BMC Impact Model Designer export metadata functions, or with the CLI command pclassinfo -x

IPS_ERROR – Publishing Server errors

IPS_ERROR events are different from other events in the IPS_EVENT class. They report issues that occur with the Publishing Server, while other IPS_EVENT report information.

IPS_ERROR slots

Slot name	Slot label	Description
severity	Severity	Indicates the seriousness of the event The default is WARNING

IPS_ENV – Publishing Server environment request

Each time a penv CLI is issued (except for the action command info ), an IPS_ENV event is generated. IPS_ENV events are generated for the following environment requests:

Creation of a publishing environment
Modification of a publishing environment
Initialization of CMDB datasets of an Atrium CMDB publishing environment
Removal of a publishing environment

IPS_ENV slots

Slot name	Slot label	Description
origin_id	Origin ID	Contains the origin ID (Atrium CMDB or DirectPublish) of the publishing environment
env_id	Environment ID	Contains the IDs of the publishing environment
env_type	Environment Request Type	Contains the action open, set, init or close

Monitoring the Publishing Server with cell events

To modify the generation of events

Understanding classes and slots for Publishing Server events

Event classes and slots specific to Publishing Server

IPS_START--Impact Publishing Server start

IPS_STOP – Impact Publishing Server stop

IPS_CONFIG – Impact Publishing Server configuration file

IPS_CONNECT – Impact Publishing Server connect

IPS_IM_CONNECT – Impact Publishing Server connect

IPS_REQUEST – Publishing Server request

IPS_PUBLISH – Publishing Server publication request

IPS_CLASSINFO – Publishing Server class information request

IPS_ERROR – Publishing Server errors

IPS_ENV – Publishing Server environment request

Comments