Getting started with SORACOM Lagoon
このドキュメントでは、ユーザーコンソールから SORACOM Lagoon (以降、Lagoon) でデータを可視化しダッシュボード化して共有する方法を解説します。
Lagoon を使って Harvest と連携しデータの可視化およびダッシュ デバイスのデータをクラウドに保存し、そのデータを API で取得する手順を紹介します。また、ユーザーコンソールでデータを可視化する方法も解説します。
セットアップから動作確認の 2 つのステップに分かれています。
当ガイドの前提は以下のとおりです。
- SORACOM のアカウントを作成済みであること
- SORACOM Air の SIM (Air SIM)、および使用できるデバイスが準備されていること
- SORACOM Harvest でデバイスのデータをクラウドで収集・取得・可視化 までの設定が完了しHarvestにデータが入っている状態であること（同じデータ形式である必要はありません）
※Lagoonでは、サービス提供にあたって一部機能に制限があります。詳しくは SORACOM Lagoon の制限事項 を参照ください。
ステップ 1: Lagoon の利用を開始する
Lagoon は設定を有効化することですぐに開始できます。
SORACOMのユーザーコンソールにルートアカウントでログインし、サイドメニューの「ダッシュボード作成・共有」メニューをクリックします。
Lagoon を有効化する
「SORACOM Lagoonの利用を開始する」ボタンをクリックします。
パスワードを設定します。
このパスワードはSORACOM コンソールのルートアカウントのメールアドレスでLagoonへログインする時に必要なパスワードとなります。
Lagoon へログインする
ルートアカウントでLagoon へログインしダッシュボード設定を行います。
「SORACOM Lagoon にアクセス」ボタンをクリックします。
オペレータアカウントのメールアドレスと先ほど設定したパスワードを入力しログインします。
以上でLagoon の利用を開始しログインできました。
ステップ 2: Lagoon でダッシュボードを作成する
ダッシュボードを作成する
ダッシュボードを作成していきます。
まずは左上の十字ボタンからダッシュボードを作成します。
New dashboardという名前でダッシュボードが作成されパネルの選択画面が表示されます。
まずはパネルからグラフを選択し作成していきます。
空のグラフパネルが作成されました。
パネル上部のプルダウンから編集をクリックします。
「メトリックス」タブにグラフ化したい回線/デバイスの情報を入力していきます。
データソースはデフォルトでHarvest となります。
今回はSORACOM Air 回線で室温、湿度、不快指数を下のようなJSONデータとしてHarvest へ格納しています。
{"temp":27.2,"humi":43.0,"heat":73.8}
利用するリソース種別、回線/デバイス、データを入力するとグラフが表示されます。 今回は室温、湿度の２つのクエリを書いてみます。
なにやら２種類の線が見えます。
タイトルや軸を設定し、もう少し見やすくしていきましょう。
まずは「全般」タブからタイトルを設定します。
「軸」タブから軸の設定を行います。
左のY軸を気温（℃）とし右のY軸を湿度（%）とします。
「表示」タブから２軸の表示設定を行います。 左にある「系列のオーバーライド」を選択し、今回右Y軸に表示したい湿度データのキーと＋ボタンから「Y-axis:2」を選択します。
少し細かいですが気温（temp）と湿度（humi）の凡例が左右に離れてしまっているのが気になります。 「凡例」タブからテーブル表示にチェックをつけることで左下に凡例をまとめてテーブル化できます。 この凡例はダッシュボード上でクリックすることでグラフへの描画ON/OFFを切り替えることができます。
以上でグラフパネルを作成できました。
右上の戻るボタンからダッシュボードの画面へ戻ります。
右上の保存ボタンからダッシュボードに名前をつけて保存します。
以上でLagoon でダッシュボードを作成し保存できました。
ダッシュボードを共有する
次にダッシュボードの共有を行います。 右上の「ダッシュボードを共有」ボタンをクリックしリンクのURLを取得します。
SORACOMのコンソール画面に戻りダッシュボードユーザーを作成します。 「+ユーザー追加」ボタンからLagoon ユーザーの権限、メールアドレス、パスワードを設定します。
- 読み取り専用：ダッシュボードの閲覧が可能なユーザーです。
- 編集可能：ダッシュボードの閲覧と編集が可能なユーザーです。
先ほど手に入れたリンクのURLへアクセスすると再びログイン画面が表示されます。
※同じブラウザで実施するとログイン状態が保持されている場合があるのでキャッシュのクリアまたは別のブラウザにてお試しください。
先ほど追加したLagoon ユーザーのメールアドレスとパスワードを入力すると、先ほど作成したダッシュボードを見ることができました。
以上でLagoon でダッシュボードを作成し保存することができました。
今回は簡単なグラフの作成と共有のみ実施しましたが、Lagoon はOSSのGrafanaをベースに開発を行っており 地図やテーブルといったパネルや、アラートの設定が可能です。ぜひお好みのダッシュボードを作成して見てください。
