Quest Foglight plugin

The Foglight plugin allows you to connect to the Quest Foglight data source, which is a database monitoring tool. See Quest: Foglight Support

What are plugins and data sources?

Plugins connect SquaredUp to your data sources. There are lots of plugins available with new ones being made available regularly, see SquaredUp: Plugins. Plugins can be used to add new data sources from Data sources on the left-hand menu. Most data sources need credentials like an API key, access token or other authentication methods.

On-premises plugins allow you to connect to APIs hosted on-prem.

If there isn't a plugin available for your data source, then you can use the Web API plugin to connect to any HTTP API that returns JSON. Alternatively, you can build and customize your own plugin. Contact us for more information.

How to add a Foglight on-premises data source

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.

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 (no inbound required) to SquaredUp, *.amazonaws.com and Microsoft APIs (Azure Relay).

      • Optional DNS-based restrictions: *.servicebus.windows.net

      • 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 Foglight data source to SquaredUp

Now use the API token to configure the 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. Agent Group:

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

4. Enter your Foglight instance URL

5. To authenticate you can either use an API token OR enter a username and password.

   How to create an API token in Foglight Administration

   Create an API auth token from within Foglight > User Management > Set Auth Token:

   Quest Foglight: How to use Rest API

   Copy the token value and save a note of ready to use in the SquaredUp Foglight plugin form.

6. Ignore Certificate errors:

   If you activate this checkbox the data source will ignore certificate errors when accessing the server. This is useful if you have self-signed certificates.

7. Ignore edges:

   This will disable the graph edge import, useful for large instances where you may not need the graph information or if you re near your edge limit.

8. Install Sample Dashboards:

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

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

10. 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 Foglight 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 also installed with the data source see Tips for using the Foglight Data Streams

How to create a data stream for this data source:

• Create a data stream using the configurable data stream form see Using configurable data streams

Tips for using the Foglight Data Streams

There are eleven global data streams installed with this data source:

All Foglight Alarms

This data stream provides access to all active alarm data. Unlike other data streams it is affected by timeframe.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the All Active Alarms data stream.

Host Alarms

This data stream provides access to Host alarm data for all hosts.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Host Alarms data stream.

Pick between the blocks, table, and scalar visualizations or shape the data.

Host Status

This data stream provides access to Host status data for all hosts.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Host Status data stream.

3. Choose the preferred visualization or shape the data.

Agents Alarms

This data stream provides access to Agent alarm data for all agents.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Agents Alarms data stream.

3. Choose the preferred visualization or shape the data.

Agents Status

This data stream provides access to Agent status data for all agents.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Agents Status data stream.

3. Choose the preferred visualization or shape the data.

AgentManagers Alarms

This data stream provides access to AgentManager alarm data for all agent managers.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the AgentManagers Alarms data stream.

3. Choose the preferred visualization or shape the data.

AgentManagers Status

This data stream provides access to AgentManager status data for all agent managers.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the AgentManagers Status data stream.

3. Choose the preferred visualization or shape the data.

Databases Alarms

This data stream provides access to Database alarm data for all databases.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Databases Alarms data stream.

3. Choose the preferred visualization or shape the data.

Databases Status

This data stream provides access to Database status data for all databases.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Databases Status data stream.

3. Choose the preferred visualization or shape the data.

Tablespaces Alarms

This data stream provides access to Tablespace alarm data for all tablespaces.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Tablespaces Alarms data stream.

3. Choose the preferred visualization or shape the data.

Tablespaces Status

This data stream provides access to Tablespace status data for all tablespaces.

1. Click on Foglight under Data Source and then Global under Data Stream Type.

2. Click on the Tablespaces Status data stream.

3. Choose the preferred visualization or shape the data.

Using configurable data streams

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.

Foglight API Endpoint

This data stream allows users to specify a specific API GET endpoint from which they want to pull data.

1. Scope to a Foglight Entity

2. Select Foglight API Endpoint

3. Enter a Display Name for the new data stream

4. Enter a valid Foglight API GET endpoint (e.g. alarm/current)

Scoped Foglight API Endpoint

This data stream allows for the specification of a specific API endpoint and supports mustache templating, allowing for dynamic customization. E.g. alarm/current/{{sourceId}}

1. Scope to a Foglight Entity

2. Select Scoped Foglight API Endpoint

3. Enter a Display Name for the new data stream

4. Enter a valid Foglight API GET endpoint

5. Define any mustache templating in the endpoint for dynamic customization

Topology Query

This global data stream allows users to configure a query string that will return data from a Foglight Query. This can be used to extend the functionality of the data source, queries such as !DBO_Listener_Status where (aggregateState > 0) (this will show any Listeners that have a non green state) allow someone to track and get status of servers or listeners that we don’t import.

1. Select Topology Query

2. Enter a Display Name for the new data stream

3. Define a Foglight query (e.g. !DBO_Database WHERE alarmAggregateTotalCount > 0)

4. Optionally, set the Maximum Depth parameter to limit the depth of the returned topology.

Scoped Alarms and Status

For all Foglight imported objects there are two data streams, one to get a list of alarms and another to get the current status. (These are useful if someone wishes to focus on a specific few imported items in a tile) not really recommended to use these for large scopes, easier to use the global data streams and filter the results.