Configure Service Graph Connector for Observability - AppDynamics using the guided setup
Set up scheduled import jobs to pull in data from AppDynamics into your Configuration Management Database (CMDB).
Antes de Iniciar
To use this Service Graph Connector, you need a subscription to a Subscription Unit that is based in the IT Operations Management (ITOM) Visibility application or in the ITOM Discovery application. As defined in the section titled "Managed IT Resource Types" in ServiceNow Subscription Unit Overview for your subscription, for managed IT resources that are created or modified in the CMDB by this Service Graph Connector, but that aren’t yet managed by ITOM Visibility or ITOM Discovery, these resources will increase Subscription Unit consumption from that application. Review your current Subscription Unit consumption within ITOM Visibility or ITOM Discovery to ensure available capacity.
- The Integration Commons for CMDB store app, which is automatically installed.
- The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models app.
- The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
- ITOM Licensing plugin (com.snc.itom.license). For more information, see Request Discovery.
- The Datastream Action plugin (com.glide.hub.action_type.datastream), which is automatically installed.
- Observability Commons for CMDB (sn_observability), which is only required for event ingestion. This must be installed prior to installing the connector for Event Management to work. For more information, see Observability Commons for CMDB on the ServiceNow Store.
- Application (client) ID
- Client Secret
Role required: admin
Procedimento
- Navigate to All > Service Graph Connector AppDynamics > Setup.
-
Ensure that the application scope is set to the Service Graph Connector for Observability - AppDynamics application by using the application picker.
For more information, see Application picker.
- Navigate to All > Service Graph Connectors > AppDynamics > Setup.
- On the Getting started page, select Get Started.
-
Configure the authentication credentials and establish an HTTP connection to send requests to the AppDynamics API.
- In the Configure API authentication section of the Service Graph Connector for Observability - AppDynamics page, select Get Started.
-
Configure the connection for AppDynamics by editing the default connection.
You can configure either a Basic Auth connection or an OAuth connection.
Nota:As the connector supports only single instance, edit the AppDynamicsConnectionAlias connection, available by default.- Configure a Basic Auth connection.
- For the Configure Basic Auth Connection task, select Configure.
- Select Edit for AppDynamicsConnectionAlias.Nota:If not redirected to the connection setup, search for AppDynamicsConnectionAlias on the Integrations page, and then select View Details to edit the default connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 1. Connection Information Field Description Connection name Name to identify the AppDynamics connection record. AppDynamicsConnectionAliasis the default credential alias name and is read-only.Host name Host name of your AppDynamics controller. - (Optional) If a MID Server is required for the AppDynamics server connection, select the Use MID server check box. Then, select the MID Server-related fields accordingly.
- In the Credential Information section of the Edit Connection window, fill in the fields.
Tabela 2. Credential Information Field Description Username AppDynamics account user name that is used to authenticate the connection request. Nota:Verify that Server Visibility is active for the AppDynamics account and the AppDynamics user has the Applications and Dashboards Viewer (Default) and Server Monitoring User (Default) roles.Password Password that is used to authenticate the connection request. - Select Edit Connection.
- Return to the guided setup page.
- Set the Configure Basic Auth Connection task to complete by selecting Mark as Complete.
- Configure an OAuth connection.
- For the Configure OAuth Authentication: Client Credentials task, select Configure.
- Select Edit for AppDynamicsConnectionAlias.Nota:If not redirected to the connection setup, search for AppDynamicsConnectionAlias on the Integrations page, and then select View Details to edit the default connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 3. Connection Information Field Description Connection name Name to identify the AppDynamics connection record. AppDynamicsConnectionAliasis the default credential alias name and is read-only.Connection URL Base URL of your AppDynamics controller. - (Optional) If a MID Server is required for the AppDynamics server connection, select the Use MID server check box. Then, select the MID Server-related fields accordingly.
- In the Credential Information section of the Edit Connection window, fill in the fields.
Tabela 4. Credential Information Field Description OAuth Client ID Application (client) ID of your AppDynamics client application as noted in the Before you begin section. Nota:Verify that the API client has a role with the required privileges and sufficient Token Expiration Time.OAuth Client Secret Client secret of your AppDynamics client application as noted in the Before you begin section. - Select Edit Connection.
- Return to the guided setup page.
- Set the Configure OAuth Authentication: Client Credentials task to complete by selecting Mark as Complete.
- Configure a Basic Auth connection.
-
Configure the connection for AppDynamics by editing the default connection.
Nota:As the connector supports only single instance, edit the AppDynamics Connection connection, available by default.
- For the Configure the connection task, select Configure.
- Select Edit for AppDynamics Connection.Nota:If not redirected to the connection setup, search for AppDynamics Connection on the Integrations page to edit the default connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 5. Connection Information Field Description Connection name Name to identify the AppDynamics connection record. AppDynamics Connectionis the default credential alias name and is read-only.Host name Hostname of your AppDynamics controller. Nota:This field is automatically set to the URL to connect to the application. Leave the field value as is. - (Optional) If a MID Server is required for the AppDynamics server connection, select the Use MID Server check box. Then, select the MID Server-related fields accordingly.
- In the Credential Information section of the Edit Connection window, fill in the fields.
Tabela 6. Credential Information Field Description User name AppDynamics account user name that is used to authenticate the connection request. Nota:Verify that Server Visibility is active for the AppDynamics account and the AppDynamics user has the Applications and Dashboards Viewer (Default) and Server Monitoring User (Default) roles.Password Password that is used to authenticate the connection request. - Select Edit Connection.
- Return to the guided setup page.
- Set the Configure the connection task to complete by selecting Mark as Complete.
-
Test the connection.
- For the Test connection task, select Configure.
- Select the Test Connection related link to start the testing process.
- When the Status field is set to Success, return to the guided setup page.Nota:If any of the tests have errors, follow the suggestions for remediation.
- Set the Test the connection task to complete by selecting Mark as Complete.
-
Enable AppDynamics event integration with your ServiceNow instance by pushing a default HTTP Request Template to AppDynamics.
Nota:To push HTTP requests, verify that the Observability Commons for CMDB application (sn_observability) is installed for events ingestion on your ServiceNow instance. Also, on your AppDynamics instance, as the ServiceNow user, you must have the account-level Configure HTTP Request Templates permission to create or modify HTTP Request Templates.
- For the Push HTTP Request Template task, select Configure.
- Select the Push HTTP Request Template related link.
- Return to the guided setup page.
- Set the Push HTTP Request Template task to complete by selecting Mark as Complete.
After you push the HTTP request template, multiple API calls are executed to start the event ingestion service in AppDynamics. For more information, see the Service Graph Connector for Observability AppDynamics article on the ServiceNow Community site.
-
In the Configure Credentials section, configure your credentials.
- Select Configure.
- Update the Name and User name field.Nota:Server Visibility needs to be active for your AppDynamics account. The AppDynamics user requires the AppDynamics role: Applications and Dashboards Viewer (Default) and Server Monitoring User (Default).
- Click Update then Mark as Complete.
-
In the Configure Connection section, configure the connection.
- Click Configure.
- Review the fields and enter the controller base URL into the Host field.
Tabela 7. HTTP(s) Connection form Field Description Name Name of the connection. Host Target host value used by the connection. The Connection URL will automatically fill in the hostname. Credential Credential value that is used by this connection. Connection alias Connection value that is used to refer to the connection. URL builder URL builder that is used to build the connection URL. Connection URL Connection URL for the connection. You can either manually enter a URL, or use the URL builder to build the connection string. Mutual authentication Option to set the connection with mutual authentication. Protocol Underlying protocol used by the connection. Nota:Update the Protocol field if you are using anything other than https.Active Option to activate the HTTP connection. Domain Domain that contains the connection. Override default port Target value port that is used by the connection. Base path Base path for HTTPs connection. - Click Update then Mark as Complete.
-
In the Validate data sources section, validate the data sources by selecting Configure.
- Review the fields on the form.
Tabela 8. Data Source form Field Description Name Unique name of this data source. Import set table label Label of the import set table that this data source will produce. Import set table name Name of the table that will be created for this data source. Type Data storage type of the data to be imported. Data in single column Option to set the data in a single column. Application Application that contains this record. Data Loader Script that loads data in the import set table. - To test the connection, click the Test Load 20 Records related link.
When the test is finished, select Mark as Complete.
Testing the connection may take a few moments. The page is refreshed to show the test results.
Nota:The connection is successful if the HTTP Status is 200. If there is anything displayed in the Error Code and Error Message fields, then the connection failed and further troubleshooting is required.
- Review the fields on the form.
-
In the Push HTTP Request Template section, push the HTTP Request by selecting Configure.
Nota:To push HTTP requests, ensure that the Observability Commons for CMDB (sn_observability) plugin is installed for events ingestion on your ServiceNow instance. Also, on your AppDynamics instance, as the ServiceNow user, you must have the account-level Configure HTTP Request Templates permission to create or modify HTTP Request Templates.
- In the Related Links section, click Push HTTP Request Template.
- Click Mark as Complete.
After you push the HTTP request template, multiple API calls are executed to start the event ingestion service in AppDynamics. For more information, see the Service Graph Connector for Observability AppDynamics article on the ServiceNow Community site.
-
Configure duplicate detection rules.
- For the Configure duplicate detection rules task in the Duplicate detection rules section, select Configure.
-
In the CMDB Duplicate Row Rules list, set the Active column value for a rule to true to activate the rule.
Nota:To remove fields from being evaluated, add the field names in the Ignore Fields column for a rule. To ignore multiple fields, separate the fields with commas.
- Return to the guided setup page.
- Set the Configure duplicate detection rules task to complete by selecting Mark as Complete.
-
Configure duplicate detection rules.
-
On the left side bar, select the Configure duplicate detection rules icon (
).
- On the Service Graph Connector for Observability - AppDynamics page, in the Duplicate detection rules section, select the task Configure duplicate detection rules.
- On the next page, in the Configure duplicate detection rules section, click Configure.
-
On the CMDB Duplicate Row Rules form, select the rule that you want to activate and update the Active column value to true.
Nota:To remove fields from being evaluated, add the field names in the Ignore Fields column. To ignore multiple fields, separate the fields with a comma in a separated list.
When you're finished, click Mark as Complete.
-
On the left side bar, select the Configure duplicate detection rules icon (
-
Configure advanced settings.
- For the Advanced Settings task in the Advanced section, select Configure.
-
Review and modify the advanced properties.
Tabela 9. Advanced properties Property Description Toggle to populate relationships between tiers Option to enable the import of relationships between AppDynamics tiers in the CI Relationship [cmdb_rel_ci] table. The number of minutes of metrics to fetch in order to generate tier to tier relationships Number of minutes of metrics to fetch for generating tier-to-tier relationships. For example, 60retrieves the last hour's relationships.Toggle to import business transactions from AppDynamics Option to enable the import of business transactions into the Calculated Application Service [cmdb_ci_service_calculated] table. Toggle to populate tags for imported servers Option to enable the import of server tags into the Key Value [cmdb_key_value] table. Toggle to import node data from AppDynamics and map to the cmdb_ci_appl hierarchy Option to enable the import of nodes into the Application [cmdb_ci_appl] table hierarchy. - Select Save.
- Set the Advanced Settings task to complete by selecting Mark as Complete.
-
Configure advanced settings.
-
On the left side bar, click the advanced icon (
).
- On the Service Graph Connector for Observability - AppDynamics page, in the Advanced section, select the task Advanced Settings.
-
In the Advanced Settings section, click Configure.
- Review the set of advanced properties.
Tabela 10. Advanced properties Advanced property Description Toggle to populate relationships between tiers The relationships between tiers will be imported in cmdb_rel_ci. Toggle to import business transactions from AppDynamics The business transactions will be imported into cmdb_ci_service_calculated. Toggle to populate tags for imported servers The server tags will be imported into cmdb_key_value. Toggle to import node data from AppDynamics and map to the cmdb_ci_appl hierarchy The nodes will be imported into cmdb_ci_appl table hierarchy. The performance impact changes based on the selected advanced setting.
- Select the Yes check box to activate each property, as needed.
- Click Save then Mark as Complete.
- Review the set of advanced properties.
-
On the left side bar, click the advanced icon (
-
Set up the SG-AppDynamics Servers and Applications scheduled job available by default.
- For the Configure scheduled job task in the Set up scheduled import jobs section, select Configure.
-
On the Scheduled Data Import form, verify the field values for the SG-AppDynamics Servers and Applications scheduled job and select the Active check box.
For more information, see Schedule a data import.
- Select Update.
- Set the Configure scheduled job task to complete by selecting Mark as Complete.