AppDynamics officially supports an IIB Agent to instrument IIB applications. This extension just collects resource and message flow stats from an application but wouldn't instrument the application. Please make sure to use the right product for your use case.
com.ibm.mq.allclient.jar com.ibm.mq.traceControl.jar fscontext.jar jms.jar providerutil.jarFor previous versions,
com.ibm.mqjms.jar jms.jar
/monitors/ Bindings mode, please make sure that based on your OS, the right paths containing the IBM MQ and JMS jars are specified in the `appd-message-broker-monitor.sh` or `appd-message-broker-monitor.bat`. opt/mqm/java/lib directory, update the `appd-message-broker-monitor.sh` file as below. (Take a note of two places where you may have to edit the path in the script file)#!/bin/bash #Passing machine agent process id to java process. ../../jre/bin/java -cp "./*:../../machineagent.jar:/opt/mqm/java/lib/*" -Djava.library.path=/opt/mqm/java/lib64 -Dlog4j.configuration=file:./log4j.xml -Dextension.configuration=./monitors/WMBMonitor/config.yml com.appdynamics.extensions.wmb.WMBMonitor $PPID exit $?
Client mode, please download the right version of IBM MQ Client on that remote server and obtain the above mentioned IBM jars from there and place it in the directory and just like above change the paths in the `appd-message-broker-monitor.sh` or `appd-message-broker-monitor.bat` files. mqsichangeresourcestats BrokerA -c active -e default
where
BrokerA -> the broker name
default -> the execution group / integration server
Please follow the below documentation to get more familiar with the mqsichangeresourcestatsmqsichangeflowstats BrokerA -e default -k application -f messageflow -s -o xml -c active
where
BrokerA -> the broker name
default -> the execution group / integration server
application -> the application name
messageflow -> the name of the message flow
Please follow the below documentation to get more familiar with the mqsichangeflowstats- Open IBM WebSphere MQ Explorer - Click on Integration Node i.e. Broker Name - Right click on the execution group which you want statistics for and view resource statistics.Alternatively you can verify that the collection of statistics is enabled using the Broker's Web Interface.
$SYS/Broker/BrokerA/ResourceStatistics/default. Similarly, snapshot statistics for message flows get published every 20 seconds to the corresponding topic $SYS/Broker/+/StatisticsAccounting/SnapShot/application/messageflow. Client or Bindings mode. In `Bindings` mode the extension needs to be installed on the same box as the MQ Server. In Client mode the extension needs to be remote and should have the access to the MQ Server. <MachineAgent_Dir>/monitors/WMBMonitor The metricPrefix of the extension has to be configured as specified here. Please make sure that the right metricPrefix is chosen based on your machine agent deployment, otherwise this could lead to metrics not being visible in the controller. #This will create the metrics in all the tiers,under this path
#metricPrefix: "Custom Metrics|WMB"
#This will create the metricUtils in a specific Tier/Component. Make sure to replace the
# with the appropriate one from your environment. To find the in your environment
#,please follow the screenshot here https://docs.appdynamics.com/display/PRO42/Build+a+Monitoring+Extension+Using+Java
metricPrefix: "Server|Component:|Custom Metrics|WMB"
queueManagers:
- host: "localhost"
#TCP Listener port. Please make sure that the listener is started.
port: 2414
#Actual name of the queue manager.
name: "QMgr1"
#The transport type for the queue manager connection, the default is "Bindings".
#For bindings type connection WMQ extension (i.e machine agent) need to be on the same machine on which WebsphereMQ server is running
#for client type connection WMQ extension is remote to the WebsphereMQ server. For client type, Change it to "Client".
transportType: "Bindings"
#Channel name of the queue manager. Channel should be server-conn type. Make sure the channel is active. It is irrelevant for Bindings Mode
#channelName: "SYSTEM.ADMIN.SVRCONN"
#userId and password with admin level credentials. For Windows, please provide the administrator credentials. These fields are irrelevant for Bindings Mode
#userID: ""
#password: ""
#SSL related properties. Please provide the path.
#sslKeyRepository: ""
#Cipher Suites. eg. "SSL_RSA_WITH_AES_128_CBC_SHA256"
#cipherSuite: ""
#Client Connection Name
clientID: "AppDynamics Extension for Message Broker"
#Resource Statistics Subscribers - https://www.ibm.com/support/knowledgecenter/en/SSMKHH_9.0.0/com.ibm.etools.mft.doc/bj43310_.htm
#Please make sure to provide unique subscriber name for each statistic subscription.
resourceStatisticsSubscribers:
- topic: "$SYS/Broker/+/ResourceStatistics/#"
subscriberName: "allResourceStatistics"
#Flow Statistics Subscribers - https://www.ibm.com/support/knowledgecenter/en/SSMKHH_9.0.0/com.ibm.etools.mft.doc/aq20080_.htm
#Please make sure to provide unique subscriber name for each statistic subscription.
flowStatisticsSubscribers:
- topic: "$SYS/Broker/+/StatisticsAccounting/SnapShot/#/#"
subscriberName: "allFlowStatistics"
#For resource and flowstatistics, all the fields listed in this section will be reported as metrics.
#Remove fields you don't need to reduce the number of metricUtils.
#Available fields:
#https://www.ibm.com/support/knowledgecenter/SSMKHH_10.0.0/com.ibm.etools.mft.doc/bn43250_.htm
metrics:
resourceStatistics:
- type: "JVM"
identifiers: ["summary","Heap Memory","Non-Heap Memory","Garbage Collection - Copy","Garbage Collection - MarkSweepCompact"]
include:
- InitialMemoryInMB : "InitialMemoryInMB" #The initial amount of memory that the JVM requests from the operating system for memory management during startup. Its value might be undefined.
- UsedMemoryInMB : "UsedMemoryInMB" #The amount of memory that is currently in use.
- CommittedMemoryInMB : "CommittedMemoryInMB" #The amount of memory that is allocated to the JVM by the operating system.
- MaxMemoryInMB : "MaxMemoryInMB" #The maximum amount of memory that can be used for memory management. Its value might be undefined.
- CumulativeNumberOfGCCollections : "CumulativeNumberOfGCCollections" #The total number of garbage collections that have occurred for this instance of the JVM. Its value might be undefined.
- type: "JDBCConnectionPools"
identifiers: ["summary"]
include:
- MaxSizeOfPool : "MaxSizeOfPool" #The maximum size of the connection pool.
- ActualSizeOfPool : "ActualSizeOfPool" #A snapshot of the number of connections currently in the pool when the statistics were reported.
- CumulativeRequests : "CumulativeRequests" #A count of the number of requests received by the connection pool during this accounting period.
- CumulativeDelayedRequests : "CumulativeDelayedRequests" #The number of times a request for a connection could not be satisfied immediately, because the number of allocated connections reached the maximum pool size and no connections are currently available.
- MaxDelayInMilliseconds : "MaxDelayInMilliseconds" #The maximum time a caller waited for a connection to be allocated, in milliseconds.
- CumulativeTimedOutRequests : "CumulativeTimedOutRequests" #A count of the number of requests for connections that could not be satisfied within 15 seconds.
- type: "JMS"
identifiers: ["summary"]
include:
- NumberOfOpenJMSConnections : "NumberOfOpenJMSConnections" #The current number of open JMS connections.
- NumberOfClosedJMSConnections : "NumberOfClosedJMSConnections" #The total number of JMS connections that were closed since the last integration server restart.
- NumberOfOpenJMSSessions : "NumberOfOpenJMSSessions" #The current number of open JMS sessions.
- NumberOfClosedJMSSessions : "NumberOfClosedJMSSessions" #The total number of JMS sessions that were closed since the last integration server restart.
- NumberOfMessagesReceived : "NumberOfMessagesReceived" #The total number of messages received by JMSInput or JMSReceive nodes.
- NumberOfMessagesSent : "NumberOfMessagesSent" #The total number of messages sent by JMSOutput nodes.
- NumberOfMessagesBrowsed : "NumberOfMessagesBrowsed" #The total number of messages browsed by JMSReceive nodes.
- NumberOfJMSConnectionFailures : "NumberOfJMSConnectionFailures" #The total number of attempted JMS connections that failed since the last integration server restarts.
- type: "Sockets"
identifiers: ["summary"]
include:
- TotalSockets : "TotalSockets" #The number of outbound sockets that have been opened since the last integration server restart.
- TotalMessages : "TotalMessages" #The number of requests for a socket; for example, from a SOAPRequest node.
- TotalDataSent_KB : "TotalDataSent_KB" #The number of bytes sent, in kilobytes (KB).
- TotalDataReceived_KB : "TotalDataReceived_KB" #The number of bytes received, in kilobytes (KB).
- SentMessageSize_10KB-100KB : "SentMessageSize_10KB-100KB" #The number of messages sent in each size range. For example, a message of 999 bytes is counted in SentMessageSize_0-1KB; a message of 1000 bytes is counted in SentMessageSize_1KB-10KB.
- type: "TCPIPClientNodes"
identifiers: ["summary"]
include:
- OpenConnections: "OpenConnections" #The current number of open connections
- ClosedConnections: "ClosedConnections" #The total number of connections that were closed since the last integration server restart
- MessagesReceived: "MessagesReceived" #The total number of messages received (by TCPIPClientInput or TCPIPClientReceive nodes)
- MessagesSent : "MessagesSent" #The total number of messages sent (by TCPIPClientOutput nodes)
- BytesSent : "BytesSent" #The total amount of data sent (by TCPIPClientOutput nodes), excluding SSL wrappers.
- BytesReceived: "BytesReceived" #The total amount of data received (by TCPIPClientInput or TCPIPClientReceive nodes), excluding SSL wrappers.
- FailedConnections : "FailedConnections" #The total number of attempted connections that failed since the last integration server restarts.
- type: "TCPIPServerNodes"
identifiers: ["summary"]
include:
- OpenConnections: "OpenConnections" #The current number of open connections
- ClosedConnections: "ClosedConnections" #The total number of connections that were closed since the last integration server restart
- MessagesReceived: "MessagesReceived" #The total number of messages received (by TCPIPClientInput or TCPIPClientReceive nodes)
- MessagesSent : "MessagesSent" #The total number of messages sent (by TCPIPClientOutput nodes)
- BytesSent : "BytesSent" #The total amount of data sent (by TCPIPClientOutput nodes), excluding SSL wrappers.
- BytesReceived: "BytesReceived" #The total amount of data received (by TCPIPClientInput or TCPIPClientReceive nodes), excluding SSL wrappers.
- FailedConnections : "FailedConnections" #The total number of attempted connections that failed since the last integration server restarts.
flowStatistics:
- type: "MessageFlow"
identifiers: [""]
include:
- TotalElapsedTime : "TotalElapsedTime" #Total elapsed time spent processing input messages (microseconds)
- MaximumElapsedTime : "MaximumElapsedTime" #Maximum elapsed time that is spent processing an input message (microseconds)
- MinimumElapsedTime : "MinimumElapsedTime" #Minimum elapsed time that is spent processing an input message (microseconds)
- TotalCPUTime : "TotalCPUTime" #Total processor time spent processing input messages (microseconds)
- MaximumCPUTime : "MaximumCPUTime" #Maximum processor time that is spent processing an input message (microseconds)
- MinimumCPUTime : "MinimumCPUTime" #Minimum processor time that is spent processing an input message (microseconds)
- CPUTimeWaitingForInputMessage : "CPUTimeWaitingForInputMessage" #Total processor time spent waiting for input messages (microseconds)
- ElapsedTimeWaitingForInputMessage : "ElapsedTimeWaitingForInputMessage" # Total elapsed time that is spent waiting for input messages (microseconds)
- TotalInputMessages: "TotalInputMessages" #Total number of messages processed.TotalInputMessages records only those messages that are propagated from input node terminals.
- TotalSizeOfInputMessages : "TotalSizeOfInputMessages" #Total size of input messages (bytes)
- MaximumSizeOfInputMessages : "MaximumSizeOfInputMessages" #Maximum input message size (bytes)
- MinimumSizeOfInputMessages : "MinimumSizeOfInputMessages" #Minimum message input size (bytes)
- NumberOfThreadsInPool : "NumberOfThreadsInPool" #Number of threads in pool
- TimesMaximumNumberofThreadsReached : "TimesMaximumNumberofThreadsReached" #Number of times the maximum number of threads is reached
- TotalNumberOfMQErrors : "TotalNumberOfMQErrors" #Number of MQGET errors (MQInput node) or web services errors (HTTPInput node). For example, a conversion error occurs when the message is got from the queue.
- TotalNumberOfMessagesWithErrors : "TotalNumberOfMessagesWithErrors" #Number of messages that contain errors
- TotalNumberOfErrorsProcessingMessages : "TotalNumberOfErrorsProcessingMessages" #Number of errors when processing a message
- TotalNumberOfTimeOutsWaitingForRepliesToAggregateMessages : "TotalNumberOfTimeOutsWaitingForRepliesToAggregateMessages" #Number of timeouts when processing a message (AggregateReply node only)
- TotalNumberOfCommits : "TotalNumberOfCommits" #Number of transaction commits
- TotalNumberOfBackouts : "TotalNumberOfBackouts" #Number of transaction backouts
- type: "Threads"
identifiers: ["ThreadStatistics"]
include:
- TotalNumberOfInputMessages : "TotalNumberOfInputMessages" #Total number of messages that are processed by a thread
- TotalElapsedTime: "TotalElapsedTime" #Total elapsed time spent processing input messages (microseconds)
- TotalCPUTime : "TotalCPUTime" #Total processor time spent processing input messages (microseconds)
- CPUTimeWaitingForInputMessage : "CPUTimeWaitingForInputMessage" #Total processor time spent waiting for input messages (microseconds)
- ElapsedTimeWaitingForInputMessage : "ElapsedTimeWaitingForInputMessage" #Total elapsed time that is spent waiting for input messages (microseconds)
- TotalSizeOfInputMessages : "TotalSizeOfInputMessages" #Total size of input messages (bytes)
- MaximumSizeOfInputMessages : "MaximumSizeOfInputMessages" #Maximum size of input messages (bytes)
- MinimumSizeOfInputMessages : "MinimumSizeOfInputMessages" #Minimum size of input messages (bytes)
- type: "Nodes"
identifiers: ["NodeStatistics"]
include:
- Number: "Number" #Number of node statistics subfolders in Nodes folder
- TotalElapsedTime: "TotalElapsedTime" #Total elapsed time spent processing input messages (microseconds)
- MaximumElapsedTime : "MaximumElapsedTime" #Maximum elapsed time spent processing input messages (microseconds)
- MinimumElapsedTime : "MinimumElapsedTime" #Minimum elapsed time spent processing input messages (microseconds)
- TotalCPUTime : "TotalCPUTime" #Total processor time spent processing input messages (microseconds)
- MaximumCPUTime : "MaximumCPUTime" #Maximum processor time spent processing input messages (microseconds)
- MinimumCPUTime : "MinimumCPUTime" #Minimum processor time spent processing input messages (microseconds)
- CountOfInvocations : "CountOfInvocations" #Total number of messages that are processed by this node
- NumberOfInputTerminals: "NumberOfInputTerminals" #Number of input terminals
- NumberOfOutputTerminals : "NumberOfOutputTerminals" #Number of output terminals
- type: "Nodes"
identifiers: ["NodeStatistics|TerminalStatistics"]
include:
- CountOfInvocations : "CountOfInvocations" #Total number of messages that are processed by this node
derivedMetrics:
flowStatistics:
- type: "MessageFlow"
identifiers: [""]
include:
- AverageElapsedTime : "AverageElapsedTime"
- AverageCPUTime: "AverageCPUTime"
- AverageCPUTimeWaitingForInputMessage: "AverageCPUTimeWaitingForInputMessage"
- AverageSizeOfInputMessages: "AverageSizeOfInputMessages"
- type: "Threads"
identifiers: ["ThreadStatistics"]
include:
- AverageElapsedTime: "AverageElapsedTime"
- AverageCPUTime: "AverageCPUTime"
- AverageCPUTimeWaitingForInputMessage: "AverageCPUTimeWaitingForInputMessage"
- AverageElapsedTimeWaitingForInputMessage: "AverageElapsedTimeWaitingForInputMessage"
- AverageSizeOfInputMessages: "AverageSizeOfInputMessages"
- type: "Nodes"
identifiers: ["NodeStatistics"]
include:
- AverageElapsedTime: "AverageElapsedTime"
- AverageCPUTime: "AverageCPUTime"
#Don't change this unless you are having more than 10 queue managers to monitor.
numberOfThreads: 10
#Don't change this.
machineAgentWatchDog:
#In seconds
initialDelay: 0
#Check the existence of MA process in 'period' seconds.
period: 5
<file os-type="aix">appd-message-broker-monitor.sh</file>in the monitor.xml and change the appd-message-broker-monitor.sh and process_checker.sh files to using korn shell.
config.yml for each metric. - type: "TCPIPClientNodes"
identifiers: ["summary"]
include:
- OpenConnections: "OpenConnections" #The current number of open connections
- MessagesReceived: "MessagesReceived" #The total number of messages received (by TCPIPClientInput or TCPIPClientReceive nodes)
delta: true
metricType: "SUM SUM INDIVIDUAL"
- MessagesSent : "MessagesSent" #The total number of messages sent (by TCPIPClientOutput nodes)
delta: true
metricType: "SUM SUM INDIVIDUAL"
- BytesSent : "BytesSent" #The total amount of data sent (by TCPIPClientOutput nodes), excluding SSL wrappers.
delta: true
metricType: "SUM SUM INDIVIDUAL"
- BytesReceived: "BytesReceived" #The total amount of data received (by TCPIPClientInput or TCPIPClientReceive nodes), excluding SSL wrappers.
delta: true
metricType: "SUM SUM INDIVIDUAL"
- FailedConnections : "FailedConnections" #The total number of attempted connections that failed since the last integration server restarts.
delta: true
metricType: "SUM SUM INDIVIDUAL"
In the above configuration, for MessagesReceived,MessagesSent,BytesSent,BytesReceived,FailedConnections, we have configured two properties delta and metricType. In the above example, metricType: "SUM SUM INDIVIDUAL", means Aggregation Qualifier = SUM Time Roll Up Qualifier = SUM Cluster Roll Up Qualifier = INDIVIDUAL.
Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.
Workbench is an inbuilt feature provided with each extension in order to assist you to fine tune the extension setup before you actually deploy it on the controller. Please review the following document on How to use the Extensions WorkBench
-Dappdynamics.agent.maxMetrics=5000 if there is a metric limit reached error in the logs. If you don't see the expected metrics, this could be the cause.The config cannot be null error.config.yml file path with linux file path separator /. Use Windows file path separator \ e.g. monitors\MQMonitor\config.yaml. For Windows, please specify the complete path.If after going through the Troubleshooting Document you have not been able to get your extension working, please file a ticket and add the following information.
Please provide the following in order for us to assist you better.
<MachineAgent>/logs.<MachineAgent>/conf/logging/log4j.xml. Change the level value of the following <logger> elements to debug.<logger name="com.singularity"><logger name="com.appdynamics"><MachineAgent>/logs/*.<MachineAgent>/conf/* directory here.<MachineAgent>/monitors/ExtensionFolderYouAreHavingIssuesWith directory here .For any support related questions, you can also contact help@appdynamics.com.
Always feel free to fork and contribute any changes directly via GitHub.
Version: | 5.1.2 |
Compatibility: | 4.1+ |
Last Update: | 06/24/2019 |
IBM WebSphere Message Broker Version Tested On: | 9.0.0.2 |
