Solarwinds Orion plugin
For more information about what this plugin does and the data streams it retrieves, see:
Monitor key metrics and states from your SolarWinds environment.
An on-prem data source connects a service running in your internal network to SquaredUp. They require an agent installed on a machine that has access to your internal network.
To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.
Before you start
The Solarwinds data source requires a user account (username and password) to access the Solarwinds API. The user account is created and managed under Settings > All Settings > User Accounts > Manage Accounts in the Solarwinds console. Creating a user with default permissions (i.e. no admin rights) is usually sufficient.
Configuring and deploying an agent
If you have already created an agent in SquaredUp that you can use for this data source, you can skip this step and choose the agent group you want to use while Configuring the data source.
See one of the following, depending on your platform type:
Configuring the data source
Display Name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- Server URL:
Enter the URL to your Solarwinds environment in the following format:
https://server.domain.name. - Server Port:
If you don't use the default port 17778, enter your port here. If you use the default port 17778, you don't need to change this field. - Username and Password:
Enter your username and password for your Solarwinds environment.The Solarwinds data source requires a user account (username and password) to access the Solarwinds API. The user account is created and managed under Settings > All Settings > User Accounts > Manage Accounts in the Solarwinds console. Creating a user with default permissions (i.e. no admin rights) is usually sufficient.
- Agent Group:
Select the Agent Group that contains the agent(s) you want to use. Install Sample Dashboards:
Select whether you would like to install sample dashboards with the data source. By default, this is set to on.You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.
Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See Access control for more information.The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.
By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.
Use the Restrict access to this data source dropdown to control who has access to the workspace:
- By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.
- Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
- If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.
- At least one user or group must be given Full Control.
- Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.
Access Level:
See Access control for more information.
Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method. If this process fails, see Testing and troubleshooting for assistance with the corresponding errors.
Next steps
Data streams
The following data streams are installed with this plugin.
Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.
While creating a tile you can tweak data streams by grouping or aggregating specific columns.
Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.
Data streams can be either global or scoped:
- Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
- A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").
See Data Streams for more information.
This data stream calls the /SolarWinds/InformationService/v3/Json/Query endpoint with a pre-set query, and allows you to enter a custom node type and metric.
- Scope to a SolarWinds item that supports metrics.
- Select + Metric from the data stream list.
- Enter a Display Name for the new data stream.
- Enter a Node Type, for example:
Nodes. - Enter a Metric, for example:
CPULoad.
This data stream calls the /SolarWinds/InformationService/v3/Json/Query endpoint with a pre-set query, and allows you to enter a custom node type.
- Scope to a SolarWinds item that supports health states.
- Select + Health State from the data stream list.
- Enter a Display Name for the new data stream.
- Enter a Node Type, for example:
Nodes.
This data stream calls the /SolarWinds/InformationService/v3/Json/Query endpoint with a with a dynamic query, and allows you to select the properties that you want returned for each node. This data stream returns a node property, such as a name or the last known value.
- Scope to a SolarWinds data source.
- Select + Node Properties from the data stream list.
- Enter a Display Name for the new data stream.
- Select a Category, for example:
Server. - Select a Vendor, for example:
Windows. - Select a Machine Type, for example:
Windows 2019 Server. - Optionally, select any Additional Properties to return, for example: Contact.
- Set a Name Filter.
%means match anything, for example:%Server%– will match anything with a name that has Server in it.%Server– will match anything with a name that ends with Server.Server%– will match anything with a name that starts with Server.
This data stream is customizable and can be edited to suit your needs from Settings > Advanced > Data Streams. For example, if you want to return memory in bytes, change the shape of the value to bytes.
This data stream calls the /SolarWinds/InformationService/v3/Json/Query endpoint with a with a dynamic query, and allows you to select the metrics that you want to be returned.
- Scope to a SolarWinds data source.
- Select + Node Metrics from the data stream list.
- Enter a Display Name for the new data stream.
- Select a Category, for example:
Server. - Select a Vendor, for example:
Windows. - Select a Machine Type, for example:
Windows 2019 Server. - Set a Name Filter.
%means match anything, for example:%Server%– will match anything with a name that has Server in it.%Server– will match anything with a name that ends with Server.Server%– will match anything with a name that starts with Server.
- Select a Metric Table from the dropdown, for example: CPU/Memory History.
- Select a Timestamp Property from the dropdown, for example: Date Time.
- Select a Value Property from the dropdown, for example: Average Memory Used.
This data stream is customizable and can be edited to suit your needs from Settings > Advanced > Data Streams.
These data streams call the /SolarWinds/InformationService/v3/Json/Query endpoint with a with a dynamic query, and allow you to select the metrics that you want to be returned.
- Scope to a SolarWinds data source.
- Select + Host Metrics, + Interface Metrics or + Volume Metrics from the data stream list.
- Enter a Display Name for the new data stream.
- Select a Metric Table from the dropdown, for example: CPU/Memory History.
- Select a Timestamp Property from the dropdown, for example: Date Time.
- Select a Value Property from the dropdown, for example: Minimum CPU. Load.
This data stream is customizable and can be edited to suit your needs from Settings > Advanced > Data Streams.
Writing a custom data stream (advanced users)
This entry point calls the /SolarWinds/InformationService/v3/Json/Query endpoint, and allows you to enter a custom SWQL query. See SolarWinds: Use SolarWinds Query Language (SWQL) in the Orion Platform
A good starter JSON for this data stream is as follows:
{
"name": "customSwql",
"dataSourceConfig": {},
"rowPath": ["results"],
"matches": {
"sourceType": { "type": "equals", "value": "SolarWinds Host" }
},
"metadata": []
}This is the SWQL query that is performed on the scoped item. It can be added to the dataSourceConfig like so:
"dataSourceConfig": {
"swql": "SELECT something FROM somewhere WHERE something like something"
}