SignalFx Developers Guide

Working with Dashboard Groups

Dashboard groups are collections of dashboards with common characteristics that make it desirable to view them together or in sequence.

A dashboard group must contain at least one dashboard. In most cases, a dashboard belongs to one and only one dashboard group, but a dashboard group may contain multiple dashboards. However, user default dashboard groups only contain the automatically-generated user default dashboard. To learn more about dashboards, see the topic Working with Dashboards.

Creating dashboard groups

When you create a new dashboard group using the API, it automatically contains a new dashboard. Similarly, if you create a new dashboard and don’t specify a dashboard group, a new dashboard group that contains the dashboard is created. You can’t add existing dashboards to a new dashboard group when you create the group, but after you create a group you can add new dashboards to it. You can also change the group of an existing dashboard to another existing group.

Managing dashboard groups

To help you design and deploy dashboards, the API provides a way to make a deep copy or clone of an existing dashboard into additional groups. You can clone all dashboards including built-in dashboards and user dashboards. You can also change a cloned dashboard after you’ve created it, because it’s completely separate from the original dashboard. To learn more about cloned dashboards, see Cloning dashboards.

When you delete a dashboard group, the system deletes its dashboards and the charts that belong to those dashboards. Note that this only happens with dashboard groups; when you delete a dashboard using the API, the system turns its charts into orphans rather than deleting them.

You can go directly to a dashboard group created by an API operation using the following URL pattern:

https://app.{REALM}.signalfx.com/#/dashboard/{DASHBOARD_GROUP_ID}

The UI displays the dashboards that belong to the group as linked tabs across the top of the page, directly below the dashboard name:

Dashboard group with three dashboards
Dashboard group with three dashboards

The dashboards also appear in the catalog.

Types of dashboard groups

SignalFx supports three types of dashboard groups, corresponding to the three types of dashboards:

Built-in dashboard groups

Built-in dashboard groups are part of the SignalFx system, and they contain built-in dashboards. You can’t edit a built-in dashboard group, but you can use the API to retrieve its dashboard group object, using the operation GET https://api.{REALM}.signalfx.com/v2/dashboardgroup/{DASHBOARD_GROUP_ID}. You can see the DASHBOARD_GROUP_ID of a group in the web UI.

All built-in dashboard groups have their creator property value set to the system user ID "AAAAAAAAAAA".

Built-in dashboard groups have names and descriptions that indicate their purpose. SignalFx initializes an organization with dashboard groups related to organization settings, as well as dashboard groups that display sample data. When you add an integration to the organization, SignalFx adds the built-in dashboard groups and dashboards for that integration.

User default dashboard groups

As you add users to an organization, the account creation process sets up new dashboard groups and new dashboards for those users. These user default dashboard groups provide a place where users can learn SignalFx, develop dashboards, and modify existing dashboards before releasing them for wider use.

SignalFx creates user default dashboard groups when administrators invite users to an organization. These groups be updated after creation. They are returned by both of the Get Dashboard Group operations:

The user default dashboard group has these properties:

  • Dashboard group name: "USER_NAME’s Dashboard Group"

  • Dashboard group description: "USER_NAME’s Dashboard Group"

  • Creator: User’s ID

  • Dashboards: Array containing the user default dashboard ID

  • Teams: Empty array

Custom dashboard groups

All dashboard groups that you create using the SignalFx API are custom dashboard groups. Use these as production dashboard groups containing dashboards that display monitoring information.

© Copyright 2019 SignalFx.

Third-party license information