Documentation forSolarWinds Platform

API Poller widget

This SolarWinds Platform topic applies only to SolarWinds SAM.

You can use the API Poller feature to monitor external REST APIs and gather metrics for nodes and applications in your SAM environment, providing an easier way to collect data from a modern application stack. For details, see Use API pollers to monitor metrics via remote APIs in the SAM Administrator Guide.

The API Poller widget appears on the Node Details view if:

  • Your environment includes SAM 2019.4 or later, and
  • At least one API poller is monitoring at least one metric for a node.

The following details appear in this widget:

  • A list of API pollers assigned to the node that are monitoring at least one value.
  • The current status of monitored values.

    The status of a value appears as Unknown until the first successful poll occurs. Alternatively, the monitored value may not be licensed (for example, if no SAM licenses are available).

  • The last metrics returned by the API poller.
  • The metric name and name of the API poller monitoring the metric.

To display all API pollers in your environment, click Settings > All Settings > Manage API Pollers.

Available actions

  • Select a Status to sort metrics monitored by API pollers on the current node.
  • Click a monitored value to display it in PerfStack.
  • Click the name of an API poller to display related metrics in PerfStack.
  • Click Edit to change the title or subtitle of the widget.

To access details about a specific API poller from the Node Details view, hover over the API Poller link in the Management widget and click the API poller name.