• ドキュメント
• SORACOM Lagoon Classic
• はじめに

SORACOM Lagoon の仕組み

Lagoon は OSS として提供されている Grafana をベースとしており、データソースとして Harvest に蓄積されたデータを利用します。

全体の構成

以下のようなコンポーネントから構成されています。

ダッシュボード

ダッシュボードは複数のパネルを配置できる一番大きな表示単位です。 Lagoon ではダッシュボード権限管理機能によってダッシュボード単位でユーザーのアクセス権限を設定できます。

パネル

パネルはデータソースに対してクエリーした結果のデータをビジュアライズして表示できます。 Lagoon ではアラート機能によって、パネル単位で取得したデータの監視を行い設定した閾値等のルールに従ってアラートを出すことができます。 利用できるパネルの種類は パネルリファレンス をご確認ください。

データソース

データソースは Lagoon に表示するデータを供給するデータベースです。 Lagoon では Harvest Data のみをデータソースとして設定できます。(画面上 default も表示、選択できますが Harvest Data を参照しています。)

クエリー

クエリーはデータソースからデータを要求するために使用されます。 Lagoon ではデバイス種別、デバイス、データフォーマット、データオブジェクトキーをドロップダウンから選択し、複雑なプログラムを組むことなく設定できます。

デバイス種別

「Air」「LoRa」「Sigfox」「Device」から選択します。 詳細は以下の通りです。

• Air: 3G/LTE 等の SIM を利用して Harvest Data に格納されたデータを参照する場合に選択します。
• LoRa: LoRaWAN デバイスを利用して Harvest Data に格納されたデータを参照する場合に選択します。
• Sigfox: Sigfox デバイスを利用して Harvest Data に格納されたデータを参照する場合に選択します。
• Device: Inventory のデバイス ID とデバイスシークレットを利用して Harvest Data に格納されたデータを参照する場合に選択します。

デバイス

デバイス種別に応じた固有の識別子を選択します。 詳細は以下の通りです。

• Air を選択した場合: IoT SIM の IMSI を選択します。
• LoRa を選択した場合: LoRa device の Device ID を選択します。
• Sigfox を選択した場合:Sigfox device の Device ID を選択します。
• Device を選択した場合: Inventory デバイス ID を選択します。

データフォーマット

利用するデータフォーマットを選択します。 パネルに応じて利用できるデータフォーマットが異なります。 詳細は以下の通りです。

• Standard: 数値データを扱うことができます。
• Table: 数値および文字列データを扱うことができます。
• Map: 地図にデータを表示する為の緯度経度データを扱うことができます。

データオブジェクトキー

Harvest Data に格納されているオブジェクトデータのキーを選択します。 データフォーマットが Map の場合は 「latitude」「longitude」配下のオブジェクトキーを選択します。

機能概要

• ダッシュボード機能: Harvest と連携しデータを可視化できます。1 つのダッシュボードにグラフ、テーブル、ヒートマップ、地図等から選択した複数のパネルを設置し、軸の設定や注釈、バージョン管理等をコーディングなしに設定できます。
• アラート機能: Lagoon で取得したデータの監視を行い設定した閾値等のルールに従ってアラートを出すことができます。通知方法は Email、Slack、Webhook 等から選択できます。
• コラボレーション機能: ユーザーコンソールから Lagoon 利用ユーザーを作成することで、ソラコムのアカウントを保有していないユーザーともダッシュボードを共有できます。利用シーンに応じてダッシュボードの編集が可能な Editor 権限、ダッシュボードの閲覧のみが可能な Viewer 権限を使い分けることができます。
• ダッシュボード権限管理機能: ダッシュボードごとにユーザーのアクセス権限を設定できます。ダッシュボードごとに編集者を分けたい、特定のユーザーには閲覧させたくない。等のユースケースに対応できます。Pro プランのみでご利用いただけます。
• スナップショット機能: ダッシュボードもしくはパネルのスナップショットを取得し有効期限を設定した上で公開できます。アカウントを持たないユーザーに対して一時的にダッシュボードをシェアするユースケースに対応します。Pro プランのみでご利用いただけます。
• 共有リンク: - ダッシュボードもしくはパネルのタイムスケール (時間の範囲) を含めてシェアできます。シェアされたダッシュボード、パネルを参照するには登録された Lagoon ユーザーでログインが必要です。
• カスタムロゴ機能: Lagoon ダッシュボードのロゴを変更できます。エンドユーザーに対してセルフブランディングしたダッシュボードとして公開するユースケースに対応します。Pro プランのみでご利用いただけます。

ダッシュボード機能

Lagoon では、サービス提供にあたって一部機能に制限があります。詳しくは SORACOM Lagoon の制限事項 を参照ください。

利用できる主なパネルは以下の通りです。

• テキストパネル: テキストや HTML を表示します。

• グラフパネル: 複数の系列データを線や棒グラフで表示します。

  

• テーブルパネル: 複数の系列データを表形式で表示します。

  

• シングルスタットパネル: 単一の系列データの要約を表示します。

  

• ヒートマップパネル: 複数の系列データを色で表現します。

  

• ワールドマップパネル: 地図上にデータを表示します。

• クロックパネル: 日付と時刻を表示します。

• SORACOM Map パネル: データに応じて地図上に任意のアイコンや移動ラインを表示できます。

• SORACOM Image パネル: 画像上の任意の場所にデータに応じたアイコンを表示できます。

• SORACOM Dynamic Image パネル: データに応じて表示する画像を動的に変更できます。

• アラートリスト: アラートの一覧を表示します。

  

アラート機能

ダッシュボードに設定したパネルのアラートのタブではアラートの設定を行うことができます。アラート設定ではアラートの評価間隔や条件の設定を行うことができます。

通知ではアラート設定の条件に該当した場合の通知先やメッセージの内容を設定できます。

通知先は通知チャンネルとして Email, Slack, Webhook などから選択できます。

状態履歴ではアラートの状態遷移の履歴を最大 50 件まで確認できます。

コラボレーション機能

設定したダッシュボードはユーザーコンソールで設定したユーザー間で共有できます。

ダッシュボードの共有設定を行うことで、ソラコムアカウントを持たないユーザーに対してダッシュボードを共有できます。

ダッシュボード権限管理機能

Pro プラン ではダッシュボードごとにユーザーのアクセス権限を設定できます。リファレンス: ユーザー権限とダッシュボードのパーミッション を参照してください。

スナップショット機能

ダッシュボードもしくはパネルのスナップショットを取得し有効期限を設定した上で公開できます。

スナップショット機能では、Lagoon アカウントを持たないユーザーに対して一時的にダッシュボードをシェアできます。