AppDynamics Monitor (version 2)

Applies to ReadyAPI 3.56, last modified on October 29, 2024
The AppDynamics (version 2) monitor replaces the older AppDynamics monitor starting with ReadyAPI 3.3. If you upgrade to 3.3, all the older AppDynamics monitors will be removed from your projects automatically, and you will have to recreate them.

Use AppDynamics monitors to gather metrics from your AppDynamics application.

Requirements

Associate your API token with one of the following roles:

  • Account Owner

  • Administrator

  • Analytics Administrator

  • Applications & Dashboards Viewer

  • Server Monitoring Administrator

  • Universal Agent Administrator

Add an AppDynamics Monitor

To add AppDynamics Monitor, you will need to generate a token via AppDynamics. This token will be used for API access calls to your Controller. There are two ways to generate a token:

  • Administrator UI – These tokens are long-lived and have a longer expiration time. The account administrator can generate these tokens and distribute them to parties or teams who need access to the Controller. There is no need to refresh these tokens frequently.

  • API – These tokens are short-lived and have a relatively short expiration time. They are typically generated and refreshed regularly by a program before expiration. These tokens can be viewed in the UI but are not individually tracked and managed.

For more detailed information, please refer to the AppDynamics documentation.

Add a Server

To get started, you need to add a server.

  1. Go to Monitoring and select Add new server.

    AppDynamics: Server Monitoring

    Click the image to enlarge it.

  2. Select AppDynamics (version 2) as your monitor type.

    AppDynamics: Add a Server

    Click the image to enlarge it.

    AppDynamics: Add a Server2

    Click the image to enlarge it.

Note:

Once you obtain an authentication token generated through the Administration UI in AppDynamics, configure your server and add the generated token.

Monitor settings

  • Server Name – The name of your server.

  • Host – The address of your AppDynamics controller.

  • Monitor Name – The name of the monitor.

  • Monitor Type – The type of monitor selected.

  • Token – The authentication token. To learn how to generate it, see the AppDynamics documentation.

  • Application name – The name of the application to monitor.

  • Metrics – A list of AppDynamics metrics you are going to work with.

    This setting is only available in ReadyAPI 3.3 and later.

    Click Select and choose the needed metrics in the subsequent dialog or specify them manually:

    Select metrics in the AppDynamics monitor

    Click the image to enlarge it.

    Example

    Note:

    You can change the list of metrics anytime, but make sure to click Test Connection for the changes to be applied:

    AppDynamics monitor: Editing list of metrics

    Click the image to enlarge it.

  • Update rate – How often ReadyAPI should pull data from the AppDynamics server (in seconds).

    Due to the AppDynamics restrictions, actual response may be delayed.

Configure API client to generate the Token

ReadyAPI can also be configured to work with the AppDynamics API Client to generate the token and/or an autorefresh token. Most of these tokens are short-lived and have a relatively short expiration date. A program typically generates and refreshes them regularly prior to expiration.

  1. Create a new API Client or configure an existing API client in AppDynamics. This is explained here.

  2. In ReadyAPI, click on Generate Token in the My Server screen.

    AppDynamics: Generate Token

    Click the image to enlarge it.

    • Generate access token dialog box will appear.

      AppDynamics: Generate Token Box

      Click the image to enlarge it.

  3. Enter the following information to enable ReadyAPI to connect to AppDynamics API Client and generate / autorefresh a token:

    • Client Name – The name assigned to your AppDynamics API Client in AppDynamics.

    • Client Secret – Your AppDynamics Client Secret.

    • Account Name – Your AppDynamics Account Name, e.g. [account name].saas.appdynamics.

    • Auto refresh Token – If your token should auto-refresh.

    AppDynamics: Generate Token Button

    Click the image to enlarge it.

  4. Select Generate Token to generate the token and configure monitoring.

    AppDynamics: Configure Monitoring

    Click the image to enlarge it.

Available metrics

ReadyAPI gets all the metrics provided by the AppDynamics APM platform.

Note: Due to AppDynamics specifics, ReadyAPI gets data once in a few minutes.

Here are the most popular metrics, specified by default:

  • Overall Application Performance|Calls per Minute - The total number of business transaction executions each minute.

  • Overall Application Performance|Average Response Time (ms) - The average time per minute to handle a business transaction.

  • Overall Application Performance|Average End to End Latency (ms) - The average time spent to handle end to end message transactions.

Proxy settings

To connect to AppDynamics through a proxy:

  1. Open Preferences > HTTP and modify the following settings:

    Setting New value
    Max connections per host: 5000
    Max total connections 20000
  2. Configure ReadyAPI proxy and turn it on.

Remarks

Unlike the other ReadyAPI monitors, the AppDynamics monitor gathers only metrics you specified during a test run. It means that after the test run, you cannot view other metrics on the Statistics page.

See Also

Preparing Servers for Monitoring
Server Inspector
Load Testing Templates

Highlight search results