Activating the service activity monitoring facility
Service activity monitoring provides you with information about how InfoSphere® MDM services and transactions are being used in a given installation. To activate the service activity monitoring facility, certain configuration steps are required.
- Activating service activity monitoring alongside Apache Kafka
- Activating service activity monitoring without Apache Kafka
Activating service activity monitoring alongside Apache Kafka
If your InfoSphere MDM deployment includes Apache Kafka, complete the following steps to activate the service activity monitoring facility.
- Use the Configuration and Management module of InfoSphere MDM to change the
value of the
/IBM/DWLCommonServices/Report/Broadcaster/enabled
property totrue
.This configuration setting is dynamic, so when the value changes, the application server applies the change without requiring a restart. For information about using the Configuration and Management module, see Using the Configuration and Management components.
- To enable the service activity monitoring facility to capture the activity data in a log file,
use the Configuration and Management module of InfoSphere MDM to change the
value of the
/IBM/DWLCommonServices/Report/KafkaListener/enabled
property totrue
.When enabled, this configuration setting registers the listener with the MBean Server, providing the object name of the MBean that issued the notification. This configuration setting is static, so when the value changes, you must restart the application server to apply the change.
- To use the service activity monitoring facility at runtime, assign administrative IBM®
WebSphere® Application Server roles such as
Administrator or Operator. For more information, see Administrative roles in the IBM
WebSphere Application Server documentation.
Complete the following steps if the user running InfoSphere MDM does not have the proper administrative IBM WebSphere Application Server roles:
- Add the following JVM properties:
MDM_SAM_USER
specifies the username of the user with administrative roles to run service activity monitoring.MDM_SAM_PASSWORD
specifies the password ofMDM_SAM_USER
. This value can be encoded with IBM WebSphere Application Server. For more information, see Encoding password with WebSphere Application Server.MDM_SAM_REALM
specifies the name of realm (user registry) where theMDM_SAM_USER
is defined, for example,defaultWIMFileBasedRealm
. If this property is not provided, InfoSphere MDM checks the above credentials in the current application realm.
After you add the JVM properties, InfoSphere MDM attempts to run service activity monitoring with the credentials you provided.
- Configure the following properties to ensure a successful login:
- Open WSLogin. and select
- From the JAAS Login Modules, select
com.ibm.ws.security.common.auth.module.WSLoginModuleImpl
. - Set the value to
true
for the following custom properties:use_realm_callback
use_appcontext_callback
- Restart the application server.
- Add the following JVM properties:
- Start the Apache Kafka server.
- If it is not yet created, create the MDM service activity monitoring Kafka topic
com-ibm-mdm-report-transactiondata
.- Configure
<MDM_INSTALL_HOME>/KafkaProcessor/bin/createTopics_Sample:
KAFKA_HOME=<KAFKA_HOME>
is the Kafka installation directoryhostname=<KAFKA_HOST_NAME>
is the Kafka host nameport=<KAFKA_PORT>
is the Kafka port number
- Run the
createTopics_Sample
script:- For Microsoft Windows systems:
<MDM_INSTALL_HOME>/KafkaProcessor/bin/createTopics_Sample.bat
- For Linux and UNIX systems:
<MDM_INSTALL_HOME>/KafkaProcessor/bin/createTopics_Sample.sh
- For Microsoft Windows systems:
- Configure
<MDM_INSTALL_HOME>/KafkaProcessor/bin/createTopics_Sample:
- Start file connector.
- Configure
<MDM_INSTALL_HOME>/KafkaProcessor/bin/runKafkaFileConnector.[bat/sh]
to set the
KAFKA_HOME
parameter to the file path of the Apache Kafka installation directory. - Run the
runKafkaFileConnector
script:- For Microsoft Windows systems:
<MDM_INSTALL_HOME>/KafkaProcessor/bin/runKafkaFileConnector.bat
- For Linux and UNIX systems:
<MDM_INSTALL_HOME>/KafkaProcessor/bin/runKafkaFileConnector.sh
- For Microsoft Windows systems:
- Configure
<MDM_INSTALL_HOME>/KafkaProcessor/bin/runKafkaFileConnector.[bat/sh]
to set the
- On the WebSphere Application Server administrative console, browse to
<KAFKA_HOSTNAME>:<KAFKA_PORT_NO>
to thebootstrap.servers
property to allow the MDM engine to send service activity monitoring messages.Tip: If security is enabled, configure additional properties as need, such as:- username and password
- SSL trust store type, location, and password
and set
Activating service activity monitoring without Apache Kafka
If your InfoSphere MDM deployment does not include Apache Kafka, complete the following steps to activate the service activity monitoring facility.
- Use the Configuration and Management module of InfoSphere MDM to change the
value of the
/IBM/DWLCommonServices/Report/Broadcaster/enabled
property totrue
.This configuration setting is dynamic, so when the value changes, the application server applies the change without requiring a restart. For information about using the Configuration and Management module, see Using the Configuration and Management components.
- To enable the service activity monitoring facility to capture the activity data in a log file,
use the Configuration and Management module of InfoSphere MDM to change the
value of the
/IBM/DWLCommonServices/Report/Listener/enabled
property totrue
.When enabled, this configuration setting registers the listener with the MBean Server, providing the object name of the MBean that issued the notification. This configuration setting is static, so when the value changes, you must restart the application server to apply the change.
- To use the service activity monitoring facility at runtime, assign administrative IBM
WebSphere Application Server roles such as
Administrator or Operator. For more information, see Administrative roles in the IBM
WebSphere Application Server documentation.
Complete the following steps if the user running InfoSphere MDM does not have the proper administrative IBM WebSphere Application Server roles:
- Add the following JVM properties:
MDM_SAM_USER
specifies the username of the user with administrative roles to run service activity monitoring.MDM_SAM_PASSWORD
specifies the password ofMDM_SAM_USER
. This value can be encoded with IBM WebSphere Application Server. For more information, see Encrypting passwords with WebSphere Application Server.MDM_SAM_REALM
specifies the name of realm (user registry) where theMDM_SAM_USER
is defined, for example,defaultWIMFileBasedRealm
. If this property is not provided, InfoSphere MDM checks the above credentials in the current application realm.
After you add the JVM properties, InfoSphere MDM attempts to run service activity monitoring with the credentials you provided.
- Configure the following properties to ensure a successful login:
- Open WSLogin. and select
- From the JAAS Login Modules, select
com.ibm.ws.security.common.auth.module.WSLoginModuleImpl
. - Set the value to
true
for the following custom properties:use_realm_callback
use_appcontext_callback
- Restart the application server.
- Add the following JVM properties:
What to do next
See the Elements in the Configuration and Management component topic for details about these configurations.