solarwinds appoptics apm administrator guide...if you already have an appoptics account, follow...

18
ADMINISTRATOR GUIDE AppOptics APM Version 1.0 Last Updated: Monday, August 19, 2019

Upload: others

Post on 25-Jul-2020

6 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

ADMINISTRATOR GUIDE

AppOptics APMVersion 1.0

Last Updated: Monday, August 19, 2019

Page 2: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

© 2019 SolarWinds Worldwide, LLC. All rights reserved.

This document may not be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the prior written consent of SolarWinds. All right, title, and interest in and to the software, services, and documentation are and shall remain the exclusive property of SolarWinds, its affiliates, and/or its respective licensors.

SOLARWINDS DISCLAIMS ALL WARRANTIES, CONDITIONS, OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON THE DOCUMENTATION, INCLUDING WITHOUT LIMITATION NONINFRINGEMENT, ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY INFORMATION CONTAINED HEREIN. IN NO EVENT SHALL SOLARWINDS, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY, EVEN IF SOLARWINDS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The SolarWinds, SolarWinds & Design, Orion, and THWACK trademarks are the exclusive property of SolarWinds Worldwide, LLC or its affiliates, are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other SolarWinds trademarks, service marks, and logos may be common law marks or are registered or pending registration. All other trademarks mentioned herein are used for identification purposes only and are trademarks of (and may be registered trademarks) of their respective companies.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 2

Page 3: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Table of ContentsIntroduction to SolarWinds AppOptics APM 4

AppOptics APM licensing model 6

Additional resources 6

Integrate AppOptics APM with IIS nodes 7

Use the AppOptics subview 9

Integrate AppOptics APM with additional IIS nodes 12

Remove AppOptics APM from nodes 14

Retrieve an AppOptics APM API token 15

Troubleshoot AppOptics APM integrations 17

page 3

Page 4: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Introduction to SolarWinds AppOptics APMSolarWinds AppOptics APM is a Software-as-a-Service (SaaS)-delivered product that you can integrate with IIS nodes to extend the application monitoring capabilities of SolarWinds SAM. By combining the advanced performance metrics that AppOptics APM provides with SAM's capabilities to monitor application dependencies, transaction times, and overall user experiences, you can better understand why transactions in your applications are slow or failing.

This integration adds an extra layer of information to nodes monitored by AppInsight for IIS that you can use to:

 l Gain a code-level look into your AppInsight for IIS applications. l Monitor the performance of custom IIS-based, .NET applications. l Cross-reference application, server, and infrastructure metrics side-by-side in the same dashboard l Check the status of application stacks and see how tiers of applications interact with each other. l Determine the databases and users that applications send information to. l Identify if issues are network-, server-, or application-related so you can route them to the right

team.

The following chart highlights the benefits of integrating AppOptics APM with IIS nodes monitored in SAM:

SAM APPOPTICS APM

Custom application performance monitoring

Deep application performance visualization & tracing

Application dependency mapping

Hyper-V and ESX health and performance metrics

Server volume monitoring and capacity planning

Server hardware health and performance monitoring

Built-in alerts and reporting

ADMINISTRATOR GUIDE: APPOPTICS APM

page 4

Page 5: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

After adding AppOptics APM to an IIS node, visualizations of key metrics — such as a breakdown of response time into applications, remote calls, and database queries — appear on the subview of the IIS Application Pool Details page.

To get started with your integration, see Integrate AppOptics APM with IIS nodes.

page 5

Page 6: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

AppOptics APM licensing modelAppOptics APM is licensed by the node (that is, each monitored Microsoft IIS server) and the license fee includes a one-year subscription. Host counts for licenses range from 10 to 100, in increments of 10. Larger host counts are available on request.

An AppOptics APM license entitles you to application performance monitoring functionality within SolarWinds AppOptics. To learn about AppOptics licensing for infrastructure monitoring, click here.

To manage licenses for AppOptics APM and other Orion Platform products:

 1. Click Settings > All Settings in the Orion Web Console.

 2. Click License Details in the Details section.

 3. Click License Manager.

You can sort licenses by product name, version, license type, or expiration date. You can also add a license, upgrade a license to a new tier, and activate licenses on new servers. The License Manager on the Orion server controls all licenses for your Orion Platform environment, including scalability engines and High Availability servers.

If you license your product before you install it, click Add/Upgrade License, enter the details, and complete the activation to see the license in the License Manager.

Additional resourcesTo learn more about licenses, see:

 l Orion Platform Administrator Guide l Guide to SolarWinds Product Licenses

ADMINISTRATOR GUIDE: APPOPTICS APM

page 6

Page 7: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Integrate AppOptics APM with IIS nodesThe first time you integrate SolarWinds AppOptics APM with an IIS node monitored in the Orion Platform by SAM, you're prompted to create an AppOptics account or provide credentials for an existing account.

When you add AppOptics APM to a node, IIS services restart on the node and related websites go down.

To integrate AppOptics APM with an IIS node for the first time, follow these steps:

 1. Navigate to Settings > All Settings.

 2. Under Product Specific Settings, click AppOptics APM Deployment Summary.

 3. On the AppOptics APM Deployment Summary page, click Add.

 4. When the Add an Integration wizard appears, click Create a new account.

If you already have an AppOptics APM account, click Go to AppOptics APM Login and follow steps provided in Retrieve an AppOptics APM API token.

page 7

Page 8: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

 5. On the Log In page, provide account details and click Sign Up. The Orion Platform generates a unique API token that provides access to AppOptics APM data and adds it to the Orion database.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 8

Page 9: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

 6. On the Select Nodes page, select the IIS node(s) and click Deploy.

If no nodes appear, check that AppInsight for IIS is configured correctly on the target server. See Configure AppInsight for IIS on nodes and Troubleshooting AppInsight for IIS.

The Orion Platform deploys AppOptics APM agents to nodes and restarts IIS services on remote machines. After a few minutes, AppOptics APM performance metrics appear in relevant SAM widgets such as Top IIS Pools.

Use the AppOptics subviewFor IIS pools on nodes integrated with SolarWinds AppOptics APM, an extra subview is accessible from the AppInsight for IIS Application Pools Details page. Hover over the left menu and click the Subview icon to display the following default widgets:

 l Average Response Time l HTTP (5xx) Error Rate l HTTP Methods l HTTP Status Codes l Requests per second

Within these widgets, you can:

 l Hover over points on graphs to display specific information. l Click the time period hyperlink to select a different range (for example, Last 12 hours or Last 12 days)

or configure a specific time and date range. Graphs show data for the last hour, by default.

page 9

Page 10: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Click Full Data View at the top of the subview to open a browser and log into SolarWinds AppOptics to display additional data, as shown in the following example:

ADMINISTRATOR GUIDE: APPOPTICS APM

page 10

Page 11: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

To learn more about using AppOptics, click here.

page 11

Page 12: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Integrate AppOptics APM with additional IIS nodesThese steps assume that you have a SolarWinds AppOptics account and AppOptics APM is integrated with at least one IIS node monitored by AppInsight, as described in Get Started with SolarWinds AppOptics APM.

When you integrate AppOptics APM with a node, IIS services restart on the node and related websites go down.

 1. Navigate to Settings > All Settings.

 2. Under Product Specific Settings, click AppOptics APM Deployment Summary.

 3. On the AppOptics APM Deployment Summary page, click Add.

 4. On the Select Nodes page, select the IIS nodes you want to integrate with AppOptics APM.

To select multiple nodes, select All or All Pages in the drop-down menu. You can also change the sort order or search for nodes by name.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 12

Page 13: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

If no nodes appear on the Select Nodes page, check that AppInsight for IIS is configured correctly on the target server. See Configure AppInsight for IIS on nodes and Troubleshooting AppInsight for IIS.

 5. Click Deploy.

The Orion Platform deploys agents to nodes and restarts IIS services on nodes. AppOptics APM performance metrics begin to appear in widgets such as IIS Pools with AppOptics APM Data and Top IIS Pools. It may take a few minutes for IIS services to start communicating data to the Orion Web Console.

If the Orion Platform cannot restart IIS services, you may be prompted to restart them manually.

page 13

Page 14: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Remove AppOptics APM from nodesWhen you remove AppOptics APM integration from a node, the Orion Platform:

 l Uninstalls the AppOptics APM agent from the node, l Removes the agent listing from the Orion database,  l Removes the AppOpticsInstrumentation module from the IIS server, and l Restarts Microsoft IIS services.

When IIS services restart on the node, related websites go down.

To remove AppOptics APM integration from a node:

 1. Navigate to Settings > All Settings.

 2. Under Product Specific Settings, click AppOptics Deployment Summary.

 3. On the Summary page, select the nodes where you want to remove AppOptics APM integration.

 4. Click Delete.

If you receive exception errors about loading the AppOptics.Agent file or assembly on the IIS server after removing integration, you may need to remove the AppOpticsinstrumentation module from the server in IIS Manager. See Troubleshoot AppOptics APM integrations for details.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 14

Page 15: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Retrieve an AppOptics APM API tokenSolarWinds AppOptics APM uses unique API tokens to handle secure requests for data sent over HTTPS. The first time you integrate AppOptics APM with an IIS node in the Orion Platform and create an AppOptics account, the Orion Platform generates an API token and adds it to the Orion database automatically,

If you already have an AppOptics account, follow these steps to retrieve an API token:

 1. Log into AppOptics.

 2. Navigate to Settings > API Tokens.

 3. Click the API Token you want to use.

 4. On the Edit API Token page, click the clipboard icon to copy the token to the Windows Clipboard.

page 15

Page 16: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

 5. Return to the Add an Integration wizard in the Orion Web Console and copy the token into the API token field.

 6. Click Apply Token and follow the wizard's onscreen instructions to finish adding AppOptics APM to nodes.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 16

Page 17: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Troubleshoot AppOptics APM integrationsFollowing are issues you may encounter when integrating AppOptics APM with an IIS node in the Orion Platform.

ERROR DESCRIPTION SOLUTION

No nodes appear in the Add an Integration wizard

IIS nodes do not appear on the Select Nodes page of the Add an Integration wizard when you're integrating AppOptics APM with an existing IIS node.

Check the AppInsight for IIS configuration on the target server. See Configure AppInsight for IIS on nodes and Troubleshooting AppInsight for IIS.

Agent failure

Error deploying the AppOptics APM agent

Check the AppOptics APM agent logs stored in C:\ProgramData\SolarWinds\Logs\Remoting.

Internal error

Error accessing the database, which may occur if agent deployment fails

Redeploy the AppOptics agent on the Manage Agents page in the Orion Web Console.

Package does not exist

The AppOptics APM agent package was not found

Re-run the Orion Configuration Wizard. Check that the package is in the default SolarWinds installation location, \Orion\Remoting\RemoteExecutionPackage\SAM.AppOptics.

Timeout Installation took too long Examine logs in these default locations:

 l C:\ProgramData\SolarWinds\Logs\SAM.AppOptics

 l C:\ProgramData\SolarWinds\Logs\Remoting

Installation error

Error during remote installation of the AppOptics APM agent

Examine Remoting Jobs logs in   C:\ProgramData\SolarWinds\Logs\Remoting

Failed to copy files

Error copying files from Orion server to the target server

Examine Remoting Jobs logs in   C:\ProgramData\SolarWinds\Logs\Remoting

page 17

Page 18: SolarWinds AppOptics APM Administrator Guide...If you already have an AppOptics account, follow these steps to retrieve an API token: 1. Log into AppOptics. 2. Navigate to Settings

Missing admin share

Admin share on target server is disabled

Enable an Admin share on the target server.

 1. Ensure that the Orion server and the target server belong to the same Workgroup.

 2. Specify which user(s) can access Administrator Shares (Disk Volumes).

 3. Enable File and Print Sharing through the Windows firewall.

 4. Check to see if you can access the Admin share from another computer.

 5. Add AppInsight for IIS to the node via the Node Details page, or run the Discovery Wizard.

Access denied

Unauthorized access to the target server

Examine Remoting Jobs logs in   C:\ProgramData\SolarWinds\Logs\Remoting

Unknown error

Unrecognized error Examine logs in these default locations:

 l C:\ProgramData\SolarWinds\Logs\SAM.AppOptics

 l C:\ProgramData\SolarWinds\Logs\Remoting

WMI not supported

WMI on the target server is disabled, or the target server is turned off

Enable WMI polling on the target server.

App Pool Error

No application pools exist on the IIS server

Check that AppInsight for IIS is configured correctly on the target server. See Configure AppInsight for IIS on nodes and Troubleshoot AppInsight for IIS.

IIS website error

A Could not load file or assembly 'AppOptics.Agent, Version=3.3.3.0, Culture=neutral, PublicKeyToken=9195cde59f6d12e5' or one of its dependencies. The system cannot find the file specified message appears if the Orion Platform could not remove AppOptics APM from the IIS server.

Follow steps in Uninstalling the Agent on the AppOptics APM website. If that does not work, try this workaround:

 1. Start IIS Manager:

 2. Click the computer name of your IIS server.

 3. Click the Modules icon in the IIS category.

 4. Click the AppOpticsInstrumentation module in the list, and then click Remove.

 5. Restart IIS services.

If exception errors continue after removing the AppOpticsInstrumentation module from the IIS server, remove the module from the website also.

ADMINISTRATOR GUIDE: APPOPTICS APM

page 18