Click the Start a free trial link to start a 15-day SaaS trial of our product and join our community as a trial user. If you are an existing customer do not start a free trial.
AppDynamics customers and established members should click the sign in button to authenticate.
Before proceeding with this document, go through the Extensions Prerequisites Guide and verify whether the environment and agents being used have been set up correctly.
PLEASE NOTE | Not all steps may be applicable for your extension.
To build the extension artifact from the source, follow the prerequisite and installation steps from individual extension documentation.
Once the artifact is generated, extract it to the <MachineAgentHome>/monitors directory. It is important to verify the supported Controller, Machine Agent, and artifact versions from the extension's documentation.
Every monitoring extension is shipped with a file called config.yml. The following steps must be verified for the config.yml:
Most config.yml files contain two metricPrefix sections which may look like the following (Considering the Redis Monitoring Extension as an example):
|metricPrefix Prefix||Recommended use|
This metric prefix is recommended when SIM is enabled.
|This metric prefix is recommended when you would like to publish metrics to the Machine Agent configured tier.|
This metric prefix points to one specific component (tier). The COMPONENT_ID can be found by using these steps:
NOTE | The component ID, or component name, is the same as the tier ID, or tier name. To get the component ID, go to the URL under Applications > Tiers & Nodes > Dashboard, as shown in the image, below.
IMPORTANT | The component ID (or component name) specified in the metric prefix of the extension should match the corresponding tier of the Machine Agent. The extension cannot report to a different tier than its Machine Agent's tier.
LEARN MORE | To read about advanced metric prefix configuration scenarios, please refer to the Advanced Metric Prefix Configuration Scenarios for AppDynamics Monitoring Extensions Knowledge Base article.
After verifying the metric prefix and configuring the details of the artifact monitored by the extension, ensure that the config.yml is correctly formatted. The use of Tabs is not supported by YML files. You can validate the file using an online YML validator like https://codebeautify.org/yaml-validator.
Another file present in the extracted extension's directory is the monitor.xml. In most cases, this file does not need any changes. If the monitor.xml does need to be modified, complete the following steps:
An extension ships with a default execution frequency of 60 seconds. The highest execution frequency supported by monitoring extensions is 5 minutes (300 seconds). It is important to ensure that this limit is not exceeded, as it will lead to inconsistencies in metric values.
Ensure that the path to the config.yml is correctly specified under the following tag:
<task-arguments> <argument name="config-file" is-required="true" default-value="monitors/RedisMonitor/config.yml" /> </task-arguments>
An absolute path can also be used here.
At this point, ensure that the Machine Agent has restarted.
Deploying new extensions and making changes to the monitor.xml for previously deployed extensions require a Machine Agent restart. However, simply changing the contents of a previously deployed extension's config.yml does not require a Machine Agent restart.
Once everything has been configured correctly, follow the relevant steps below to look for Custom Metrics in the Controller:
What if you followed all the steps up to this point, but still don’t see all the required metrics in the Metric Browser?
It could be a case of the Machine Agent's metric limit being hit. In this case, you should restart it with a higher metric limit. For example, to increase the limit to 5000, you can use the following command while starting the Machine Agent:
java -Dappdynamics.agent.maxMetrics=5000 -jar machineagent.jar
However, this limit should not be an arbitrarily large number. It is a factor of the number of metrics generated by any installed extensions, heap memory provided to the Machine Agent, etc. Check the hardware and sizing requirements for Machine Agents and extensions in the Machine Agent Requirements and Supported Environments documentation.
For more information, see the latest Metric Limits documentation.
For Windows, where the Machine Agent is running as a service:
cscript <machine_agent_home>\InstallService.vbs -Dappdynamics.agent.maxMetrics=5000
If at this point the extension’s metrics are still not visible, please refer to the extension-specific troubleshooting steps (if any) found on the respective extension documentation pages.