Integrate Cisco AppDynamics Monitoring
Overview
You can integrate Cisco AppDynamics to monitor file transfer activities and device status changes.
This integration uses the AppDynamics Analytics Events API to publish events as custom analytics events.
Once configured, events such as Transfer Started, Transfer Completed, Device Connected, and Device Disconnected are automatically sent to AppDynamics whenever the selected events occur, allowing you to monitor them in AppDynamics Analytics.
The overall process consists of the following steps:
① Verify Credentials and Prepare the Event Schema → ② Configure the Integration in the Product
Prerequisites
Before you begin, verify the following requirements.
| Item | Description |
|---|---|
| AppDynamics Account | An AppDynamics (Controller) account with permission to generate an Events API Key and view the Global Account Name is required. |
| Event Schema | A custom event schema (event type) for storing published events must already exist. |
| License | A Transaction Analytics license is required to publish custom analytics events. |
| Network | The environment where the product is installed must allow outbound HTTPS communication to the Events Service endpoint. (Port 443 for SaaS or the default port 9080 for on-premises deployments.) |
Verify Credentials and Prepare the Event Schema
To publish events to AppDynamics, you need the Events Service Endpoint, Global Account Name, Events API Key, and a custom Event Schema to store the events.
Step 1. Verify the Events Service Endpoint
Locate the Events Service Endpoint used to publish analytics events.
For SaaS deployments, refer to the SaaS Domains and IP Ranges documentation to identify the Analytics (Events Service) endpoint.
Example:
https://analytics.api.appdynamics.com
For on-premises deployments, use the Events Service host with the default port 9080.
Step 2. Verify the Global Account Name
In the Controller UI, navigate to:
Settings → License → Accounts
Verify your Global Account Name.
Step 3. Generate an Events API Key
Navigate to:
Analytics → Configuration → API Keys → Add
Create an API Key with the Manage and Publish Custom Analytics Events permission.
Copy the generated API Key.
Treat the API Key as confidential information. Do not expose it in public repositories or external documentation.
Always use HTTPS when publishing events. If the key is compromised, revoke it immediately and generate a new one.
Step 4. Prepare the Event Schema
Create or verify the custom Event Schema that will store the published events.
Record the schema name.
The schema name is used in the event publishing endpoint. Event publishing will fail if the specified schema does not exist.
Verification
✔ The Events Service Endpoint has been verified.
✔ The Global Account Name has been verified.
✔ The Events API Key has been generated.
✔ The target Event Schema has been prepared.
Configure Cisco AppDynamics Integration
Enter the verified information into the product configuration.
When you open the Monitoring configuration page, the following screen is displayed.
Step 1. Enter the Events Service Endpoint
Enter the Events Service Endpoint verified in the "Verify Credentials and Prepare the Event Schema" section.
Example:
https://analytics.api.appdynamics.com
Step 2. Enter the Global Account Name
Enter the Global Account Name verified in the "Verify Credentials and Prepare the Event Schema" section.
Step 3. Enter the Events API Key
Enter the Events API Key generated in the "Verify Credentials and Prepare the Event Schema" section.
Step 4. Enter the Event Schema Name
Enter the name of the custom Event Schema that will store the published events.
Step 5. Select Events
Select the events to be monitored.
Multiple events can be selected. Only the selected events will be published to AppDynamics.
| Event | Trigger |
|---|---|
| Transfer Started | When a Transfer begins. |
| Transfer Completed | When a Transfer completes successfully. |
| Transfer Paused | When a Transfer is paused. |
| Transfer Recovered | When a Transfer automatically resumes after an interruption or failure. |
| Device Connected | When a device connects. |
| Device Disconnected | When a device disconnects. |
Step 6. Save the Configuration
After completing the configuration, click Add to save the integration.
Verification
✔ The Events Service Endpoint has been entered.
✔ The Global Account Name has been entered.
✔ The Events API Key has been entered.
✔ The Event Schema Name has been entered.
✔ The monitoring events have been selected.
Verify the Integration
Verify that the integration is operating correctly.
Step 1. Generate a Test Event
Start a Transfer or trigger one of the selected monitoring events.
Step 2. Verify in AppDynamics
Open AppDynamics Analytics and verify that events are being collected under the configured Event Schema.
Verification
✔ Events have been received by AppDynamics.
✔ The generated events have been delivered successfully.
Configuration Complete
After the configuration is saved, the integration becomes active.
From this point forward, whenever one of the selected events occurs, the corresponding event is automatically published to AppDynamics.
Troubleshooting
| Issue | Verification |
|---|---|
| Events do not appear | Verify that the Events Service Endpoint, Global Account Name, Events API Key, and Event Schema Name are correct and contain no leading or trailing spaces. |
| Authentication error occurs | Verify that the Events API Key and Global Account Name are correct. |
| Publishing permission error | Verify that the API Key includes the Manage and Publish Custom Analytics Events permission and that the Transaction Analytics license is active. |
| Event Schema error | Verify that the target Event Schema already exists and that the published event fields match the schema definition. |
| Integration fails in a restricted network | Verify that outbound communication to the Events Service endpoint is allowed through the firewall or proxy. (Port 443 for SaaS or 9080 for on-premises deployments.) |