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
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, which gives you access to their corresponding Data Streams and Objects when creating Dashboards. Most data sources need credentials like an API key, access token or other authentication methods.
On-prem 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 the data source
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.
This is an on-prem data source.
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.
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 adding 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 Sample Dashboards:
Select whether you would like to install sample dashboards with the data source. By default, this is set to on.Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.
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:
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.
- 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
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.
Data streams
The following data streams are installed with this plugin.
This data stream provides access to all active alarm data. Unlike other data streams it is affected by timeframe.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the All Active Alarms data stream.
This data stream provides access to Host alarm data for all hosts.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Host Alarms data stream.
- Pick between the blocks, table, and scalar visualizations or shape the data.
This data stream provides access to Host status data for all hosts.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Host Status data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Agent alarm data for all agents.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Agents Alarms data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Agent status data for all agents.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Agents Status data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to AgentManager alarm data for all agent managers.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the AgentManagers Alarms data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to AgentManager status data for all agent managers.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the AgentManagers Status data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Database alarm data for all databases.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Databases Alarms data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Database status data for all databases.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Databases Status data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Tablespace alarm data for all tablespaces.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Tablespaces Alarms data stream.
- Choose the preferred visualization or shape the data.
This data stream provides access to Tablespace status data for all tablespaces.
- Click on Foglight under Data Source and then Global under Data Stream Type.
- Click on the Tablespaces Status data stream.
- Choose the preferred visualization or shape the data.
This data stream allows users to specify a specific API GET endpoint from which they want to pull data.
- Scope to a Foglight Entity
- Select Foglight API Endpoint
- Enter a Display Name for the new data stream
- Enter a valid Foglight API GET endpoint (e.g.
alarm/current)
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}}
- Scope to a Foglight Entity
- Select Scoped Foglight API Endpoint
- Enter a Display Name for the new data stream
- Enter a valid Foglight API GET endpoint
- Define any mustache templating in the endpoint for dynamic customization
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.
- Select Topology Query
- Enter a Display Name for the new data stream
- Define a Foglight query (e.g.
!DBO_Database WHERE alarmAggregateTotalCount > 0) - Optionally, set the Maximum Depth parameter to limit the depth of the returned topology.
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.