Overview#
You can configure AppDynamics integration to send and monitor file transfer tasks and device status changes with Cisco AppDynamics.
This integration uses the AppDynamics Analytics Events API to send events as custom events.
After completing the integration, events are sent to AppDynamics whenever designated events occur, such as a transfer being Started (Transfer Started) or Completed (Transfer Completed), or a device being Connected (Device Connected) or Disconnected (Device Disconnected), allowing them to be monitored in Analytics.
The entire process consists of two steps: ① Verify Credentials and Prepare the Schema → ② Configure the Integration in the Product.
Prerequisites#
Before you begin, check the following.
| Item | Description |
|---|---|
| AppDynamics account | An AppDynamics (Controller) account that can create an Events API Key and verify the Global Account Name is required. |
| Event schema | A custom event schema (event type) for storing events must be defined in advance. |
| License | A Transaction Analytics license is required to publish custom events. |
| Network | Outbound HTTPS communication to the Events Service endpoint must be allowed from the environment where the product is installed. (SaaS uses port 443, and on-premises uses the default port 9080.) |
Verify Credentials and Prepare the Schema#
To send events to AppDynamics, you need an Events Service Endpoint, Global Account Name, and Events API Key, and you must also prepare a Custom Event Schema (Event Schema) for storing events.
Step 1. Events Service Endpoint Check#
Check the Events Service Endpoint to which events will be sent.
In a SaaS environment, check the Analytics (Events Service) domain on the SaaS Domains and IP Ranges page. (Example: https://analytics.api.appdynamics.com)
In an on-premises environment, use the Events Service host and the default port 9080.
Step 2. Check the Global Account Name#
Check the Global Account Name under Settings → License → Accounts in the Controller UI.
Step 3. Obtain an Events API Key#
Create an API Key under Analytics → Configuration → API Keys → Add in the Controller.
The API Key must have the Manage and Publish Custom Analytics Events permission.
Copy the generated API Key.
ℹ️ An API Key is equivalent to a password, so make sure it is not exposed in public repositories or external documents. Event transmission must use HTTPS. If it is exposed, delete the existing key and create a new one.
Step 4. Prepare the Event Schema#
Prepare the custom event schema (Event Schema) for storing events and check the schema name.
ℹ️ The schema name is used in the event publishing path. If the schema does not exist, event publishing fails.
Checklist#
- ✔ The Events Service Endpoint has been confirmed.
- ✔ The Global Account Name has been confirmed.
- ✔ The Events API Key has been created.
- ✔ The target event schema has been prepared.
Configure Cisco AppDynamics Integration#
Enter the confirmed values in the product settings.
When you open the Monitoring settings window, the following screen is displayed.
Step 1. Enter the Events Service Endpoint#
Enter the confirmed address in the Events Service Endpoint field.
(Example: https://analytics.api.appdynamics.com)
Step 2. Enter the Global Account Name#
Enter the confirmed value in the Global Account Name field.
Step 3. Enter the Events API Key#
Enter the created key in the Events API Key field.
Step 4. Enter the Event Schema Name#
Enter the name of the custom event schema for storing events in the Event Schema Name field.
Step 5. Select Events#
Select the events to monitor under Events.
You can select multiple events, and events are sent to AppDynamics only when the selected events occur.
| Event | When It Occurs |
|---|---|
| Transfer Started | When the transfer task starts |
| Transfer Completed | When the transfer is completed successfully |
| Transfer Paused | When the transfer is temporarily paused |
| Transfer Recovered | When the transfer is automatically recovered and resumed after an interruption or error |
| Device Connected | When a device is connected |
| Device Disconnected | When a device is disconnected |
Step 6. Save the Settings#
After completing the input, click Add to save the integration.
Checklist#
- ✔ 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 events to monitor have been selected.
Verify the Integration#
Verify that the settings are working correctly.
Step 1. Trigger a Test Event#
Run an actual transfer task or trigger one of the selected events.
Step 2. Check AppDynamics#
Check whether events for the relevant Event Schema have been collected in AppDynamics Analytics.
Checklist#
- ✔ An event has been collected in AppDynamics.
- ✔ The triggered event was delivered successfully.
Setup Complete#
Once the settings are saved, the integration is applied.
After that, an event is automatically sent to AppDynamics whenever the selected events occur.
Troubleshooting#
| Issue | Checklist |
|---|---|
| Events are not displayed | Check whether the Events Service Endpoint, Global Account Name, Events API Key, and Event Schema Name are correct and whether there are leading or trailing spaces or missing characters. |
| An authentication error occurs | Check whether the Events API Key and Global Account Name are correct. |
| A publishing permission error occurs | Check whether the API Key has the Manage and Publish Custom Analytics Events permission and whether the Transaction Analytics license is active. |
| A schema error occurs | Check whether the target Event Schema has been created in advance and whether the fields in the transmitted data match the schema. |
| Integration fails in a closed network | Check whether outbound communication to the Events Service endpoint (SaaS 443 / on-premises 9080) is allowed by the firewall or proxy. |