Dashboards

Dashboards are the central component of Soracom Lagoon. Dashboards can contain multiple Panels, which allows you to visualize a large amount of device data at a glance.

Overview

https://g.lagoon.soracom.io


Creating a Dashboard

  1. Login to the Lagoon Console for your region.

  2. Hover over the menu, then select Dashboard.

    https://g.lagoon.soracom.io

    Create dashboard

A new dashboard will be created, and the first panel will be automatically added so that you can begin configuring your new dashboard immediately.

https://g.lagoon.soracom.io

Add panel


Importing a Dashboard

If you have saved a Lagoon dashboard, you can import its JSON model (or JSON data) in order to restore the dashboard, including any panels and settings.

  1. Login to the Lagoon Console for your region.

  2. Hover over the menu, then select Import.

    https://g.lagoon.soracom.io

    Import dashboard

  3. Click the Upload .json File button, or paste your Lagoon dashboard JSON model (or JSON data) into the Or paste JSON field. Then click the Load button.

    https://g.lagoon.soracom.io

    Import dashboard

Your dashboard will be added automatically.


Dashboard Settings

To access a dashboard's settings, click the Settings button at the top of the dashboard. You will then be able to configure various settings for the dashboard.

General

https://g.lagoon.soracom.io

General settings

General

Time Options

Panel Options

Annotations

Grafana supports annotations in order to add notes directly to dashboard graphs, however with Lagoon you cannot import annotations from external data sources. Annotations must be created manually from within a Lagoon dashboard and are stored inside Lagoon.

More information about annotations can be found in the Grafana: Annotations documentation, however not all annotation features are available in Lagoon.

Variables

Grafana supports dashboard variables in order to create interactive or dynamic dashboards. However, the following limitations apply to dashboard variables within Lagoon:

More information about variables can be found in the Grafana: Variables documentation, however not all variable features are available in Lagoon.

Links

Allows you to add arbitrary links to the top of your dashboard, such as a link to your organization's website or an appropriate contact form, or even to another dashboard.

https://g.lagoon.soracom.io

Links

Versions

Every time you save changes to a dashboard, a new version will be created. You can use this menu to compare different versions in order to determine what settings have been changed, or to restore a previous version.

https://g.lagoon.soracom.io

Versions

JSON Model

The JSON Model menu allows you to view, edit, and save the JSON data associated with the dashboard. This JSON data contains all of the panels, their settings and positions, and additional dashboard settings.

https://g.lagoon.soracom.io


Organizing Dashboards

Lagoon Maker and Lagoon Pro plans allow you to create multiple dashboards, which can be useful for monitoring different projects or environments, separating private and public dashboards, and so on. Lagoon includes a simple folder structure for organizing a large number of dashboards.

  1. Login to the Lagoon Console for your region.

  2. Hover over the menu, then select Manage.

    https://g.lagoon.soracom.io

    Manage dashboards

  3. From the dashboards list, click the Folder button to create a new folder.

    https://g.lagoon.soracom.io

    Create folder

  4. Enter a name for the new folder, then click the Create button.

    https://g.lagoon.soracom.io

    Create folder

A new folder will be created. Now, to move a dashboard to the folder:

  1. Click the for the dashboard you want to organize, then click the Move button.

    https://g.lagoon.soracom.io

    Move dashboard

  2. Select the folder that you created, and click the Move button to confirm.

    Select folder


Sharing a Dashboard

When using Lagoon, you can create a URL link for a dashboard, including a specific time range, in order to share the dashboard with your team or other collaborators.

Anyone who accesses the dashboard using the link will be required to login to Lagoon using a Lagoon User associate with your Soracom account. If you are using Lagoon Pro, the user will also need sufficient privileges in order to view the dashboard.

  1. Login to the Lagoon Console for your region.

  2. Open the dashboard that you want to share.

  3. Click the Share dashboard button.

  4. Select your link preferences, then click the Copy button to copy the link.

    Share dashboard

    • Current time range - Include the current time range in the link, so that users are shown the current data.
    • Template variables - Include template variables in the link.
    • Theme - Specify the dashboard theme to show.

Lagoon also gives you the ability to share a single panel within a dashboard. Refer to the Panels documentation for more information.


Deleting a Dashboard

  1. Login to the Lagoon Console for your region.

  2. Hover over the menu, then select Manage.

    https://g.lagoon.soracom.io

    Manage dashboards

  3. Click the for the dashboard you want to organize, then click the Delete button.

    https://g.lagoon.soracom.io

    Delete dashbaord

  4. Click the Delete button to confirm.