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

Foglight

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.

You can also add a data source by clicking Add data source on the Settings > Data Sources page, but pre-built dashboards are not added when using this method.

An on-prem data source connects a service running on your internal network to SquaredUp. It requires an agent installed on a machine that has access to your internal network.

Before you start

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.
Agent Group:
Select the Agent Group that contains the agent(s) you want to use.
Instance URL:
Enter your Foglight instance URL.
To authenticate you can either use an API token OR enter a username and password.
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.
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.
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.
Install Dashboards:
Select whether you would like to install pre-built dashboards and perspectives with the data source. By default, this is set to on.

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 data source 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	Permissions
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.

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

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.

The following data streams are installed with this plugin.

Data streams	Description
Agent Alarms	Lists Alarms for all Agents
Agent Status	Lists all agents and their details with status
AgentManager Alarms	Lists Alarms for Agent Managers
AgentManager Status	Lists all agent managers and their details with status
Alarms	Lists current alarms for selected scope
All Active Alarms	Lists all current alarms
Database Alarms	Lists Alarms for Databases
Database Status	Lists all databases and their details with status
Health Status	Lists health status of supplied objects
Host Alarms	Lists Alarms for all Hosts
Host Status	Lists all hosts and their details with status
Status	Lists agents and their details with status
Tablespace Alarms	Lists Alarms for all DBO Tablespaces
Tablespace Status	Lists all DBO tablespaces and their details with status

Configurable data streams

The following data streams have configurable Parameters.

Data stream	Description	Parameters
Foglight API Endpoint	This data stream allows you to specify a specific API GET endpoint to pull data from
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}}.`	API Endpoint: Supply an API Endpoint. For example, `alarm/current`.
Topology Query	Configure a topology query and return data from Foglight. The query of topology objects is one of the functionalities provided by Foglight REST APIs. See the Foglight REST APIs documentation.	Topology Query: Enter a topology querty. For example, `!DBO_Listener_Status where (aggregateState > 0)` Maximum Depth: Optionally, specify the maximum depth of the topology query (usually `0` or `1`).

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket