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

List of documentation for data source plugins available

Adding a new data source

Data sources can be added inside a workspace:

  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.

    Alternatively you can filter data sources by selecting a category from the list on the left, for example: CI/CD Tools.

  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. Enter the credentials for your data source. Each data source may have slightly different fields to fill out. See individual data source documentation for more information:

    List of documentation for data source plugins available

  4. Install Sample Dashboards:

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

    This setting will only appear as an option for data sources with sample dashboards.

  5. Select whether you would like to restrict access to the data source.

  6. Click Add.

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

The data source will be added to the current workspace. If sample dashboards exist for a data source, they will automatically be added to that workspace.

Viewing data sources

Once you have added a data source, it will be listed under Data Sources on the left-hand menu, and the overview page will appear. Each data source has a data source overview page, which is a management page showing all the indexed objects.

Each data source overview

A data source overview page will show:

  • Name of the data source

  • Index status of the data source:

    • Connected – everything is working correctly.

    • Failed – the data source configuration failed. Click More Info to find out more about the issue with the data source.

  • When the last object finished indexing – objects are automatically indexed every 12 hours. Admin users can use the Refresh button next to the status to manually index objects.

  • Manage – admin users can use this to manage the data source configuration.

    Editing a data source configuration will change it for all workspaces that use it in SquaredUp.

  • Remove – admin users can use this to remove the data source from the workspace.

    Any dashboard tiles using this data source in the workspace will no longer work.

  • Overview of the objects for the data source

What happens when I add a data source?

Most data sources will add the following to SquaredUp:

Data source settings

Admin users can also manage data sources from Settings > Data Sources. The Settings > Data Sources page provides a single place to manage all of your data sources. You are able to add, edit, index, and delete data sources from this page.

Admin users are able to restrict access to data sources, see Access control. If the admin selects that Everyone can Link to workspace, data sources will appear on the Add a data source page in the Existing section for all other users in that organization. Users will then be able to link the data source to a new workspace.

Data sources are not linked to every workspace by default, it requires a user with the appropriate permissions to link a data source to a workspace. Data sources that are configured from the Settings > Data Sources page are not automatically linked to any workspaces.

Data source troubleshooting

Sometimes data source indexing fails, perhaps due to permissions or changes in the source system. A red indicator next to Settings at the bottom of SquaredUp will let you know if a data source has failed. On the Settings page any data sources that have failed are brought to the top of the list with a red indicator.

  • More info will expand to show you more of the message about the issue.
  • View documentation will take you to the data source article.

  • Report an issue will open an in-app chat window with support.

Some plugins do not support object importing described in Graph Import plugin. Attempting to use the functionality with an incompatible plugin displays the message Plugin does not support graph import.

Have more questions or facing an issue?