API poller use case: Monitor AppOptics services
This use case shows how to apply the SolarWinds AppOptics Monitored Services API poller template to a node and start collecting metrics from the AppOptics API.
Before you begin
- Review available documentation.
- See API poller requirements to make sure you have what you'll need, including a node to host the remote API URL. For this use case, we created an external node named appoptics.com that recognizes an application endpoint,
AppOptics. - See AppOptics API documentation to learn about API request requirements, endpoints, and so on. For example, API requests required Basic Authorization, HTTPS, and an AppOptics token.
- See the SAM API Poller Template Reference to learn about template requirements and default metrics.
- See API poller requirements to make sure you have what you'll need, including a node to host the remote API URL. For this use case, we created an external node named appoptics.com that recognizes an application endpoint,
- Gather AppOptics organization credentials. You'll need them to copy an API token from AppOptics to SAM. For steps, see Retrieve a SolarWinds Cloud Token to integrate AppOptics with SAM.
Assign an API poller template to a node
- Navigate to the Node Details view.
-
In the Management widget, click API Poller Management > Assign.
- SolarWinds recommends using Firefox, Chrome, or Microsoft Edge to use the wizard.
-
On the Choose API Pollers page of the Assign API Pollers wizard, select the SolarWinds AppOptics Monitored Services template and click Next.
-
On the Authorization page of the wizard:
-
Select Basic Authorization.
-
Click New credential. In the dialog box that appears, add a Credential name, enter an AppOptics API token as the Username, and click Save. No password is required.
- Add a Credential name.
- Click Assign Pollers.
-
-
After you apply the API poller to the node, click the API Poller template link.
The API poller appears, along with a list of monitored values.
- (Optional) Click Configure to edit settings for the template, such as Name, Description, and credentials.
- Use the Edit and Delete icons to modify monitoring for the Average response time metric.
- When finished, click Save to return to the Node Details view.
When you return to the Node Details view, the API Poller widget shows the new pollers. Wait 2 minutes for polling to occur. After monitored metrics appear, you can see the latest metrics received in the API Poller widget, click the Performance Analyzer link in the Management widget to display data in PerfStack, or access metrics from SolarWinds Platform Maps that include the node.