利用状況レポート

利用状況レポートでは、ワークスペース内で誰が何を使っているかを確認できます。メンバーが開く画面、ダッシュボード、アプリ、ノートブック、再訪するメンバーの人数、次にどこへ移動するかがわかります。メンバーがどの機能を使いこなしているか、どのダッシュボードやアプリが活用されているか、プロセスのどこで離脱が起きているかを把握するのに役立ちます。

IDタブからセキュリティログの隣にある項目として開きます。

閲覧できるユーザー

利用状況レポートには、セキュリティログと同じ権限 identity.security_log.read が必要です。この権限がない場合、ボタンは表示されません。それでもレポートを開いたメンバーには、アクセス権がないことを知らせる通知が表示されます。

レポートでは、メンバー単位の利用状況が2か所に表示されます。ユーザータブと、メンバー ID を含むメンバー別の日別アクティビティおよび初回利用のエクスポートです。それ以外はすべてメンバー全体で集計されます。個々のアクティビティを閲覧すべき人にのみ、この権限を付与してください。

集計対象

利用状況レポートは5つのソースを統合します。ソースから1つを選択するか、すべてのソースのままにします。

ソース	記録される内容
PlaidCloud アプリ	メンバーが開く画面と、アプリ内で行う操作。
Superset	ダッシュボードとチャートの閲覧。
Panelアプリ	アプリへのアクセスと、メンバーが各アプリで過ごした時間。
JupyterHub	メンバーが JupyterHub セッションで過ごした時間。
Jupyter ノートブック	メンバーが開いたノートブックと保存したノートブック。

JupyterHub セッションと Jupyter ノートブックは別々のソースなので、どちらか一方を選択できます。Panelアプリは1つのソースです。ノートブックのイベントは、デフォルトのノートブックイメージで実行されるノートブックについてのみ記録されます。カスタムイメージはイベントを報告しません。

レポートの見方

ウィンドウ上部でソースと日付範囲を選択し、更新を選択します。範囲は過去7日、30日、90日、180日のいずれかです。各タブは初めて開いたときと、ソースや範囲を変更したときに読み込まれます。

概要

選択した範囲の主要な数値です。

数値	意味
アクティブユーザー	何らかのアクティビティがあったメンバー。
新規ユーザー	範囲内で初めて確認されたメンバー。
リピートユーザー	範囲より前に初めて確認された、アクティブなメンバー。
アクティブ時間（分）	概算値です。アクティビティがあった期間ごとに5分として計算します。
イベント	記録されたすべてのもの。
メンバー未紐付けのイベント	メンバーを特定できなかったイベント。イベントとしては数えられますが、ユーザーとしては数えられません。
セッション時間（分）	Panel と JupyterHub のセッション時間。アクティブ時間（分）とは別に集計されます。

利用状況の定着度には、各画面、ダッシュボード、チャート、項目が、そのソース、イベント、ユーザー数、アクティブユーザーに占める割合、イベント数、メンバー未紐付けのイベント数とともに一覧表示されます。月別には、各月のアクティブユーザー、1日あたりの平均ユーザー数、定着率が表示されます。その月がまだ進行中の場合、一部のみが対象の場合、または固定されたスナップショットの場合は、注記が付きます。

アクティビティ

毎日、毎週、毎月の期間別のアクティブユーザーに加え、初回週別の継続率を表示します。継続率では、メンバーが初めて現れた週ごとに、その後の各週に何人が戻ってきたかがわかります。アスタリスクが付いた期間は、全体が範囲内に収まっていません。

パス

画面間で最も多く行われた移動を、移動元、移動先、通過回数として、アプリとソースをまたいで表示します。パスの対象は最大で過去30日間です。

ユーザー

メンバーごとに1行で、名前、ユーザー名、アクティブ日数、イベント数、アクティブ時間（分）、セッション時間（分）、初回確認日時と最終確認日時が表示されます。

エクスポート

サマリーを CSV としてダウンロードします。サマリーと、最大25か月の日付範囲を選択し、CSVをダウンロードを選択します。

サマリー	内容
日別アクティビティ	日、ソース、イベント、件名ごとのユーザー数とイベント数。
メンバー別の日別アクティビティ	同じ内容をメンバーごとにまとめたもの（メンバー ID を含む）。
月別の利用状況	月、ソース、イベント、件名ごとのユーザー数とイベント数。
月間アクティブユーザー	月とソースごとのアクティブユーザー数。
初回利用	各メンバーが各ソースを初めて使用した日時（メンバー ID を含む）。

エクスポートでは、タブの上で選択したソースが使用されます。大きなサマリーは最大50,000行ずつのバッチでダウンロードされ、ウィンドウがそれらを1つのファイルにまとめます。ファイルがウィンドウで構築できるサイズを超える場合は、取得できた分を保存し、ファイルが不完全であることをお知らせします。残りを取得するには、より短い範囲を選択してください。

エクスポートを行うたびに、誰がどのサマリーを、どの範囲で、何行エクスポートしたかがセキュリティログに記録されます。複数のバッチにまたがるサマリーの場合は、バッチごとにエントリが記録されます。

ファネル

メンバーが一連のステップをどれだけ通過するかを確認します。ステップとは、いずれかのソースのイベントで、特定の件名またはすべての件名に対するものです。

ステップを追加を選択し、各ステップのソース、イベント、件名を選択します。ファネルのステップ数は2～6です。
ステップ間の許容時間として、1、6、24、72、168時間のいずれかを選択します。
日付範囲として、7、30、90日のいずれかを選択します。
ファネルを実行を選択します。

結果には、ステップごとに、到達したメンバー数、開始したメンバーに対する割合、そこで止まったメンバー数、前のステップからの所要時間の中央値が表示されます。ステップにはソースを混在させることができるため、PlaidCloud の画面から Superset のダッシュボードまでメンバーの動きを追跡できます。最近のファネルから、以前に実行したファネルを再度開けます。ステップの一覧には、範囲内で記録されたイベントのみが表示されます。

メンバー未紐付けの利用状況

一部のイベントは、PlaidCloud のメンバーに紐付けられません。これらはイベントとメンバー未紐付けのイベントには含まれますが、ユーザー数には含まれません。主なケースは次のとおりです。

PlaidCloud 経由ではなく、Superset 内で作成された Superset アカウント。
埋め込みダッシュボードの閲覧。Superset ユーザーが存在しません。
プラットフォームのログからメンバーを特定できない Panel と JupyterHub のアクティビティ。紐付けはこれらのログに基づくため、ベストエフォートとして扱ってください。

あるソースでメンバー未紐付けの割合が大きい場合、そのソースのユーザー数は実際より少なく表示されています。

履歴の開始時点

履歴は、ワークスペースで利用状況の収集を有効にした時点から始まり、それより前の日や月にはアクティビティが表示されません。データがある最初の月には、一部のみであることを示すマークが付きます。

Panel と JupyterHub はプラットフォームのログから読み取られ、ログは約90日間保持されます。収集を開始すると、この2つのソースでは最大でその期間分の過去の履歴が補完されます。Superset は独自のログから最大180日分を補完します。収集開始時に何もない状態から始まるのは、PlaidCloud アプリだけです。

利用状況レポートは生のイベントを180日間保持します。これが最長の範囲が180日である理由です。また、月次サマリーは25か月間保持します。SCIM や Keycloak など PlaidCloud の外部でメンバーを削除した場合、そのメンバーの生の利用状況は180日後に、初回利用の記録は25か月後に期限切れとなり削除されます。

メンバーの利用状況を消去する

identity.security_log.read 権限を持つワークスペース管理者（またはスーパーユーザー）は、1人のメンバーの利用状況を消去してその収集を停止し、後で消去を解除できます。消去と復元のどちらにも、この権限とロールが必要です。これら2つの操作は REST API からのみ利用できます。

操作	リクエスト
消去	`DELETE /rest/v1/identity/usage/users/{user_id}`
復元	`DELETE /rest/v1/identity/usage/users/{user_id}/erasure`

消去すると、そのメンバーのイベントと初回利用の記録が削除され、その時点からレポートとエクスポートにそのメンバーが含まれなくなります。そのメンバーの利用状況は再び収集されることはなく、後から Panel や JupyterHub のログで読み込まれる履歴も破棄されます。削除をすぐに完了できない場合は、応答でその旨が示され、次回の毎時メンテナンスの実行時に完了します。

復元すると、消去が解除され、新しいアクティビティが再び収集されます。消去されたデータは元に戻りません。

どちらの操作もセキュリティログにエントリが記録されます。