Soracom

Users

ドキュメント

Snapshot 機能

Snapshot 機能を利用すると、任意の第三者に Dashboard や Panel を公開できます。ある時点における Dashboard や Panelのレイアウトおよび表示していたデータを「Snapshot」として保存し、閲覧用の URL を発行します。なお、Automatically Update (自動更新) オプションを有効にして作成した Snapshot は、それを表示している間、最新のデータを反映したものに定期的に更新されます。

  • Snapshot 機能は Pro プランのみで利用できます。
  • Snapshot の Automatically Update オプションは、Public beta です。
注意

Dashboard や Panel と異なり、Snapshot は認証なしでアクセスできます。Snapshot を作成する際は、Dashboard や Panel に公開できる情報のみが含まれているかを十分に確認してください。Snapshot に認証を付けることはできません。メールアドレス / パスワードで保護した状態で Dashboard や Panel の内容を第三者に公開するには、SORACOM Lagoon ユーザー のメールアドレス / パスワードを発行のうえ、以下の手順で共有してください。

Snapshot の時間範囲の設定

Snapshot では、設定した時間範囲のデータを共有できます。Snapshot を作成する前に、対象の Dashboard で表示する時間範囲を設定 して、共有する時間範囲を設定してください。

Automatically Update オプションを有効にする場合の注意

下記のような時間範囲を設定して Automatically Update オプションが有効な Snapshot を作成した場合、Snapshot を正しく動作させるために Dashboard や Panel の時間範囲が自動的に変更されます。

  • Dashboard で表示する時間範囲を設定する ときに [Absolute time range] を設定している場合、過去 6 時間 (Last 6 hours) に変更されます。
  • 過去 24 時間を超える時間範囲 (例: 過去 7 日間など) を設定している場合、過去 24 時間 (Last 24 hours) に変更されます。

Snapshot を作成する

Dashboard の場合は、Dashboard のヘッダーの アイコンをクリックし、[Snapshot] タブで作成できます。また、Panel の場合は、Panel のタイトル → [ (Share)] の順にクリックし、[Snapshot] タブで作成できます。

以下について設定し、[Snapshot] をクリックして作成します。

設定項目名設定内容
Snapshot nameSnapshot 名
ExpireSnapshot の有効期限。Never は無制限
Automatically UpdateAutomatically Update (自動更新) オプション
Timeout (seconds)Snapshot 作成にかかる時間のタイムアウト値 (Automatically Update オプションが無効の時のみ設定可能)

[Copy Link] をクリックして Snapshot の URL をコピーします。この URL へはメールアドレス / パスワード認証なしにアクセスできます。

Automatically Update オプションの有効化

[Automatically Update] にて、Automatically Update オプションを有効・無効にできます。Automatically Update オプションを有効とすることで、定期的に最新データを反映した Snapshot へ更新されます。

Snapshot の管理

Lagoon コンソールにログイン し、サイドバーの アイコンから [Snapshots] をクリックして Snapshot 管理画面を開きます。当画面で Snapshot 一覧の確認や Snapshot の削除ができます。

Auto-Updating が付いている Snapshot は Automatically Update オプションが有効になっています。

Snapshot の削除

Snapshot 管理画面で各 Snapshot の行に表示されている [x] アイコンをクリックすると Snapshot を削除できます。

Snapshot の注意点

  • Snapshot では画面左上のロゴは非表示となります。カスタムの ロゴ を設定している場合も同様です。
  • Snapshot では CSV のダウンロードなど Inspect 機能 は利用できません。
  • Snapshot では、Panel に設定した Harvest Files の画像は表示されません。

Automatically Update オプションの注意点

  • Automatically Update オプションが有効な Snapshot を表示している間、ブラウザは基本的に 60 秒間隔で自動的に Snapshot を再読み込みします。実際の更新間隔はスナップショットや通信の状態などによって多少前後します。
  • Snapshot はサーバーに保存したキャッシュデータを表示しています。キャッシュの有効期間は 60 秒です。
  • 古くなった Snapshot はブラウザからのリクエストに対して非同期で更新されています。そのため、ブラウザに最新の Snapshot が表示されるまで 60 秒以上かかる場合があります。
  • Automatically Update オプションを有効とした Snapshot へアクセスした際、最新データが表示されるまでに初回は 2 分程度待つ場合もあります。
  • Automatically Update オプションを有効とした Snapshot は、対象の Dashboard や Panel を削除するとデータが更新されなくなります。
  • Snapshot 作成後に Automatically Update オプションの有効・無効は変更できません。新規に Snapshot を作成してください。

Snapshot の既知の問題

  • Panel や Query の数が制限を超えている Dashboard の Snapshot を作成しようとするとエラーになります。Dashboard で Panel や Query の数を減らしてから、再作成してください。
  • Panel や Query の数が制限に収まっていても、データ点数が多かったり、データサイズが大きい Dashboard は Snapshot の更新処理がタイムアウトすることがあります。Snapshot が更新されない場合は、データ量を減らすために時間範囲を短くするか、Panel や Query の数を減らしてください。