The JMX Monitoring extension collects metrics from a JMX based messaging server and uploads them to the AppDynamics Metric Browser.
JMX must be enabled in your JMX based server for this extension to gather metrics. Please make sure you have all the permissions before deploying the extension. In order to use this extension, you do need a Standalone JAVA Machine Agent or SIM Agent. For more details on downloading these products, please visit download.appdynamics.com.
The extension needs to be able to connect to the JMX based server in order to be collect and send metrics. To do this, you will have to either establish a remote connection in between the extension and the product, or have an agent on the same machine running the product in order for the extension to collect and send the metrics.
NOTE: Please place the extension in the "monitors" directory of your Machine Agent installation directory. Do not place the extension in the "extensions" directory of your Machine Agent installation directory.
Note : Please make sure to not use tab () while editing yaml files. You may want to validate the yaml file using a yaml validator
<MACHINE_AGENT_HOME>/monitors/JMXMonitor/. Here is a sample config.yml file
### ANY CHANGES TO THIS FILE DOES NOT REQUIRE A RESTART ### #This will create this metric in all the tiers, under this path #metricPrefix: Custom Metrics|JMXMonitor #This will create it in specific Tier. Replace <TIER_NAME> metricPrefix: "Server|Component:<TIER_NAME or ID>|Custom Metrics|JMXMonitor" # List of JMX Servers servers: - displayName: "" # displayName is a required field. This will be your server name that will show up in metric path. # You can either use just a host and port to connect or use your full serviceURL to make the connection # Do not choose both, comment one out and only use the other. host: "" port: # serviceUrl: "" username: "" password: "" # You can either use the normal password or encrypt your password and provide the encrypted Password and encryptionKey. # Do not provide both, only provide one and comment out the other. # encryptedPassword: "" # encryptionKey: "" # number of concurrent tasks. # This doesn't need to be changed unless many servers are configured numberOfThreads: 10 #timeout for the thread threadTimeout: 30 #~~~~~~~~~~~~~~~~~~~~~~ # List of metrics #~~~~~~~~~~~~~~~~~~~~~~ #Glossary of terms(These terms are used as properties for each metric): # alias # aggregationType # timeRollUpType # clusterRollUpType # multiplier -->not for derived metrics # convert --> not for derived metrics # delta --> not for derived metrics #~~~~~~~~~~~~~~~~~~~~~ # The configuration of different metrics from various mbeans of jmx server # The mbeans are already configured.This does not need to be changed unless # someone needs to configure on their own. mbeans: # This Mbean will extract out Broker metrics - objectName: "org.apache.activemq:type=Broker,brokerName=*" mbeanKeys: ["type", "brokerName"] metrics: include: - StorePercentUsage: "Store Percent Usage" # This Mbean will extract out Queue metrics # This example also shows how you can change the default properties of a metric. - objectName: "org.apache.activemq:type=Broker,brokerName=*,destinationType=Queue,destinationName=*" mbeanKeys: ["type", "brokerName","destinationType","destinationName"] metrics: include: - AverageEnqueueTime: "AverageEnqueueTime" clusterRollUpType: "AVERAGE" timeRollUpType: "SUM" aggregationType: "SUM" - ConsumerCount: "ConsumerCount" clusterRollUpType: "AVERAGE" timeRollUpType: "SUM" aggregationType: "SUM" # Composite Metrics can be set in the following way - objectName: "java.lang:type=Memory" mbeanKeys: ["type"] metrics: include: - HeapMemoryUsage.committed : "Heap Memory Usage|Committed"
servers: - displayName: "" host: "" port: # serviceUrl: "" username: "" password: "" # encryptedPassword: "" # encryptionKey: ""
metricPrefix: "Server|Component:Extensions tier|Custom Metrics|JMX Monitor"
You can use this extension to get all metrics that are available through the JMX Messaging service. In order to do so though, you will have to make sure that all metrics are defined correctly. Please follow the next few steps in order to get this right.1. You will have to list each mBean separately in the config.yml file. For each mBean you will have to add an **objectName**, **mbeanKeys** and **metrics** tag. The following example shows exactly how you should do that. * You will have to each and every **mBeanKey** that is listed in the **objectName**. * Under **metrics** is where you have the ability to include all the metrics that you would like to monitor.
mbeans: - objectName: "org.apache.activemq:type=Broker,brokerName=*" mbeanKeys: ["type", "brokerName"] metrics: include: - StorePercentUsage: "Store Percent Usage"
2. There are several properties that are associated with each metric. They are:
* alias * aggregationType * timeRollUpType * clusterRollUpType * multiplier * convert * delta
This format enables you to change some of the metric properties from what the default configurations are.
In Order to use them for each metric, please use the following example.
- objectName: "org.apache.activemq:type=Broker,brokerName=*,destinationType=Queue,destinationName=*" mbeanKeys: ["type", "brokerName","destinationType","destinationName"] metrics: include: - AverageEnqueueTime: "Average Enqueue Time" clusterRollUpType: "AVERAGE" timeRollUpType: "SUM" aggregationType: "SUM"
- objectName: "java.lang:type=Memory" mbeanKeys: ["type"] metrics: include: - HeapMemoryUsage.committed : "Heap Memory Usage|Committed" - HeapMemoryUsage.init : "Heap Memory Usage|Initialized" - HeapMemoryUsage.max : "Heap Memory Usage|Max" - HeapMemoryUsage.used : "Heap Memory Usage|Sum"
Always feel free to fork and contribute any changes directly here on GitHub.
Find out more in the AppDynamics Exchange community.
Please follow the steps listed in this troubleshooting-document in order to troubleshoot your issue. These are a set of common issues that customers might have faced during the installation of the extension. If these don't solve your issue, please follow the last step on the troubleshooting-document to contact the support team.
Please visit Encryption Guidelines to get detailed instructions on password encryption. The steps in this document will guide you through the whole process. If you want to use password encryption, please send arguments as connectionProperties. You will have to fill in the encrypted Password and Encryption Key fields in the config but you will also have to give an empty "" value to the password field and the encrypted password will be automatically picked up.
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
|Last Updated||March 3, 2018|
List of Changes can be found in the Changelog.md