Solarwinds Orion plugin

Visit our website to see the data that you can access if you use this plugin to add the data source to SquaredUp:

SolarWinds

Monitor key metrics and states from your SolarWinds environment.

Note: This data source is an on-premises data source.

What is an on-premises data source?

An on-premises 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.

Prerequisites

• 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.

How to add a Solarwinds data source

Configure and deploy 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 adding the data source.

Deploying an agent

1. Create a unique API key for your agent and add the agent to an agent group in SquaredUp.

   You create an API key by creating an agent in SquaredUp:
   

   1. Go to Settings > Relay and add an Agent.

   2. Give the new agent a name and a description that helps you identify where the agent is installed. For example:
      Name: server1.domain.local

      Description: Test server in production domain

   3. Choose the Agent Group for this agent:

      1. If you already have agent groups, assign it to an existing group and click create.

      2. If you don't have any agent groups yet or want to assign the new agent to a new group, leave the Agent Groups field empty and click create. Then create the agent group by clicking on Add Agent Group and select the new agent in the Agents field for the new group.

   4. After you created the agent, the API key for this agent will be shown to you. Copy the key and store it until you inserted the key into the configuration of the agent you want to deploy on your machine.

      The API key will only be displayed to you once. If you lose this API key, you need to generate a new one (by creating a new agent) and any references to the old API key in the configuration of the agent you deployed on your machine will need to be updated.

   5. The agent status will show as gray until the next stage of configuring the service is completed successfully.

2. Deploy the agent on a machine that has access to the service the data source connects to.

   1. Download the latest release of the SquaredUp agent zip file, by clicking the download icon under Options next to the agent you have just added.

      Prerequisites for agents

      • The agent needs to run on a Windows machine that has access to the entry point for the on-premises data source.

      • Make sure the agent is able to make outbound connections on port 443 to SquaredUp (api.squaredup.com), *.amazonaws.com and Microsoft Azure Relay (*.servicebus.windows.net) - this may include firewall rules and proxy server allow lists.

      • If a Proxy is required, set a system environment variable named ALL_PROXY with the location of the proxy server, as modern .Net applications do not use the proxy as shown in netsh.

        The proxy server may be a hostname or IP address (optionally followed by a colon and port number) or it may be a http URL (optionally including a username and password for proxy authentication). A proxy URL must be started with http, not https, and cannot include any text after the hostname, IP, or port. If the agent is running as a service, you will need to restart it, and may need to restart the server itself in some cases in order to apply the environment variable.

      • For information about Relay Agent versions see Release Notes - Relay Agent

   2. On a Windows machine, with access to the entry point your data source needs to use, extract the downloaded zip file.

   3. In the folder of the extracted zip file, open PowerShell as an administrator and run the following command:

      Copy

      ./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceSuffix "name" -ServiceAccount domain\username

      Parameters to replace:

      -ApiKey "key"	Mandatory	Replace key with the API key you created for the agent in SquaredUp
      -AsService	Recommended	Run the agent as a service on the machine
      -ServiceSuffix "name"	Optional	To change the default service name of squpagent replace name with your new service name.
      -ServiceAccount domain\username	Optional	To run the agent as a domain service account (for example, for the SCOM data source), provide the username as domain\username and it will prompt for the password when it sets up the service
      -InstallPath	Optional	Specify a folder location for where the agent will be installed. If this is not specified then the agent will be installed in the folder where the zip file is extracted.

      Consider restricting access to the folder where the agent is installed to prevent anyone from updating or viewing the configuration files.

   Running the agent as a domain service account

   By default, the SquaredUp agent service uses the local system identity, but this can be changed to a domain service account if required, for example for the SCOM data source.

   • Configure a domain service account using the installation script, for example:

     ./Install-SQUPAgent.ps1 -ApiKey "key" -AsService -ServiceAccount domain\username

     where key is the API key, and domain\username is the domain service account

   • Alternatively, in Services > SquaredUp Cloud Agent > Properties select the account on the Log On tab.

   • Use a dedicated user account for the agent's service identity. Create a special service account for this domain service account, do not use an existing user account.

   • The account (typically a service account) needs to have the log on as a service permission.

   4. Adjust any permissions for the service and start the service.

      How to start the agent service

      You can start the agent service from Services > SquaredUp Cloud Agent, or using PowerShell using either:

      Start-Service -Name <ServiceName>

      Where <ServiceName> should be replaced with the service name shown in brackets in the upgrade script output (or Properties of the service).

      For example:

      Start-Service -Name squpagent

      or

      Start-Service -DisplayName <DisplayName>

      Where <DisplayName> should be replaced with the service name shown before the brackets in the upgrade script output (or Properties of the service).

      How to find the agent folder location or Service name in Properties

      Look at the Properties of the SquaredUp Cloud Agent service:

      1. On the server running the agent, open Services

      2. Scroll down to the SquaredUp Cloud Agent in the list

      3. Right-click on the SquaredUp Cloud Agent service and then Properties

      4. Here you can see the Service name, Display name and Path to the agent folder.

      5. You can also start or stop the service from here.

   5. Check the agent status in SquaredUp  Settings > Relay

For more information see Configuring an agent for on-premises data sources

Add a Solarwinds data source in SquaredUp

1. 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.

2. Display Name:

   Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

3. Server URL:

   Enter the URL to your Solarwinds environment in the following format:

   https://server.domain.name

4. 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.

5. 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.

6. Agent Group:

   Select the Agent Group that contains the agent(s) you want to use.

7. Install Sample Dashboards:

   Select whether you would like to install sample dashboards with the data source. By default, this is set to on.

8. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

   Restrict access to this data source

   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.

   Data source access levels

   Access Level:

   Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
   Full Control	User can change the data source configuration, ACL, and delete the data source.

   See Access control for more information.

9. Click Test and add to validate the data source configuration.

   Testing outcomes

   • Testing passed – a success message will be displayed and then the configuration will be saved.

   • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   You can edit any data source configurations at any time from Settings > Data Sources.

   You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Using the Solarwinds data streams

What is a data stream?

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").

Data streams are installed with this data source.

How to create a data stream for this data source:

• Create a data stream using the configurable data stream (simplest option) see Creating a data stream using a configurable data stream

• Write a custom data stream (advanced use) see Writing a custom data stream (advanced users)

Creating a data stream using a configurable data stream

What is a configurable data stream?

A configurable data stream allows you to easily create new data streams specific to your needs, by entering information into a form, such as metric names or queries. Configurable data streams have a cog icon next to their name in the tile editor.

Any data stream you create can be edited by clicking the edit button (pencil) next to it in the tile editor, and also from Settings > Advanced > Data Streams.

Metric

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.

1. Scope to a SolarWinds item that supports metrics

2. Select + Metric from the data stream list

3. Enter a Display Name for the new data stream

4. Enter a Node Type, for example: Nodes

5. Enter a Metric, for example: CPULoad

Health State

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.

1. Scope to a SolarWinds item that supports health states

2. Select + Health State from the data stream list

3. Enter a Display Name for the new data stream

4. Enter a Node Type, for example: Nodes

Node Properties

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.

1. Scope to a SolarWinds data source.

2. Select + Node Properties from the data stream list

3. Enter a Display Name for the new data stream

4. Select a Category, for example: Server

5. Select a Vendor, for example: Windows

6. Select a Machine Type, for example: Windows 2019 Server

7. Optionally, select any Additional Properties to return, for example: Contact

8. 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.

9. Click Save.

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.

Node Metrics

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.

1. Scope to a SolarWinds data source.

2. Select + Node Metrics from the data stream list

3. Enter a Display Name for the new data stream

4. Select a Category, for example: Server

5. Select a Vendor, for example: Windows

6. Select a Machine Type, for example: Windows 2019 Server

7. 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.

8. Select a Metric Table from the dropdown, for example: CPU/Memory History

9. Select a Timestamp Property from the dropdown, for example: Date Time

10. Select a Value Property from the dropdown, for example: Average Memory Used

11. Click Save.

This data stream is customizable and can be edited to suit your needs from Settings > Advanced > Data Streams.

Host/Interface/Volume Metrics

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.

1. Scope to a SolarWinds data source.

2. Select + Host Metrics, + Interface Metrics or + Volume Metrics from the data stream list

3. Enter a Display Name for the new data stream

4. Select a Metric Table from the dropdown, for example: CPU/Memory History

5. Select a Timestamp Property from the dropdown, for example: Date Time

6. Select a Value Property from the dropdown, for example: Minimum CPU Load

7. Click Save

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)

Custom SWQL

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": []
}

SWQL

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"
}