Usage plugin

The Usage plugin 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 add this plugin, your SquaredUp organization will be added as an organization object you can scope to. When you create a scope with the organization object, you'll see the Data Streams for this plugin.

Where do I find the name of my SquaredUp organization?

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 Usage plugin

1. In SquaredUp browse to Settings > API Keys > Create new API Key. Copy the API key to your clipboard.

2. In SquaredUp browse to Settings > Plugins > Add plugin and search for the plugin.

3. Display Name:

   Enter a name for your plugin. This helps you to identify this plugin in the list of your plugins.

4. API key: Paste the API key here.

5. Leave the checkbox for Automatically create a workspace ticked, this will create a new workspace for this plugin containing out of the box dashboards and scopes.

6. Optionally, select whether you would like to restrict access to this plugin instance. By default, restricted access is set to off.

   Restrict access to this workspace?

   The term plugin here really means plugin instance. For example, a user may configure two instances of the AWS plugin, one for their development environment and one for production. In that case, each plugin instance has its own access control settings.

   By default, Restrict access to this plugin? is set to off. The plugin can be viewed, edited and administered by anyone. If you would like to control who has access to this plugin, switch Restrict access to this plugin? to on.

   Use the Restrict access to this plugin? dropdown to control who has access to the workspace:

   • By default, the user setting the permissions for the plugin will be given Full Control and the Everyone group will be given Link to workspace permissions.

   • Tailor access to the plugin, 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 plugin 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 Cloud. Once the account has been created, they will gain access to the tenant.

   • 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 plugin, regardless of the ACL chosen.

   Plugin access levels

   Access Level:

   Link to workspace	User can link the plugin to any workspace they have at least Editor permissions for. Data from the plugin can then be viewed by anyone with any access to the workspace. User can share the plugin data with anyone they want. User cannot configure the plugin in any way, or delete it.
   Full Control	User can change the plugin configuration, ACL, and delete the plugin.

   See Access control for more information.

7. Click Save.