Usage plugin
For more information about what this plugin does and the data streams it retrieves, see:
The Usage plugin allows you to add a data source that lets you keep track of your SquaredUp usage. It comes with data streams that enable you to display stats like number of workspaces, number of dashboards, number of data queries, number of users, etc.
When you click on your user profile
, you can see the name of your organization on top of the menu:
Tip: Data Streams that are named "metric" (like "Number of objects indexed metric") adapt to the dashboard timeframe and give you a history of usage over time.
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.
Configuring the data source
In SquaredUp, browse to Settings > API Keys > Create new API Key. Copy the API key to your clipboard.
Display Name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- API key:
Paste the API key here. The API key must come from the SquaredUp organization you want to get usage data about. - API Base URL:
Optionally, specify the SquaredUp API Base URL you want to use. This value defaults to the API Base URL of the region where the data source is added. The default can be overridden to specify the API Base URL of a different region.
For example, a SquaredUp organization in the US region can specify the European SquaredUp Base URL to get usage data about a SquaredUp organization in the European region, or vice versa. 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 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.