SolarWinds API Example

[Mesverrum]

SolarWinds API

Below example shows about fetching data from the SolarWinds API.

URL : https://github.com/solarwinds/OrionSDK

• Create your new Infinity data source, pick a descriptive sounding name like "SolarWinds" and go to the Authentication tab.
• Choose Basic Authentication.
• Set the username and password for an account that has access to your SolarWinds web console. This account does not require any special permissions and the apply will apply any account restrictions or view limitations that apply to the account.
• For the Allowed hosts you should enter the URL you will use to connect to SolarWinds, this could be an IP, hostname, or DNS name depending on your environment.

• Go to the URL, Headers and Params tab.
• Put in the same URL you used for the allowed hosts and specify the port to connect to the SolarWinds API. For SolarWinds versions newer than 2023 this will usually be 17774, older versions could still be using 17778.

• Go to the Network tab.
• In most cases you will need to set the option to Skip TLS Verify as SolarWinds normally uses a self-signed cert for their API.

• Go to the Health check tab.
• This is optional, but its a good idea to enter in the following URL for a simple way to verify the API is reachable.
• https://YOURSERVER:17774/SolarWinds/InformationService/v3/Json/Query?query=SELECT+TOP+1+Uri+FROM+Orion.Pollers
• At this point you should be able to Save and Test your connection successfully.

Dashboard Panels

• Go to Home > Dashboards > New Dashboard > Add Visualization > Select your SolarWinds data source.
• Make sure the Type is JSON, methos is GET, and set your URL to /SolarWinds/InformationService/v3/Json/Query
• Recommended If you set the parser to Backend you will be able to create Grafana alerts and enable enterprise query caching and other features from this data.
• Expand the Headers, Request params and add a URL Query Param.
• Set the Key to query and for the value paste in whatever valid SWQL query you like.

• This is a quick example of a Grafana recreation of the Node Details view in Orion:

If you want more examples of real world SWQL queries I maintain a collection of queries here, and will be building out some example dashboards that you can just import to get a head start Github/Mesverrum/

[yesoreyeram]

This is really a valuable contribution the community was seeking. Thank you so much for putting this together.

One minor change I would like to do is, in the query instead of default parser I would use backend parser for various reasons such as support for features such as alerting, recorded queries etc.

[Mesverrum]

good to know, i didn't realize the impact of that option but it makes sense that people might want to be able to create recording rules and alerts off this.

[yesoreyeram]

For health check, does all the users have this table?

https://yourserver:17774/SolarWinds/InformationService/v3/Json/Query?query=SELECT+TOP+1+Uri+FROM+Orion.Pollers

or any other queries also replaced based on user setup? ( Sorry. Not much familiar with SW )

[Mesverrum]

yes this is a required table that all environments would have and should be able to respond back quickly, but to be honest i chose it because its the default example in their git repo for executing a simple query.