Get Workspace Usage

説明

ワークスペースの利用状況をプロジェクトのテーブルに書き込みます。導入状況の経時的な追跡、部門やチームごとの利用状況のレポート、独自ダッシュボードの作成、スケジュールされたワークフローでの利用低下の検知に使用できます。数値は利用状況レポートに表示されるものと同じです。

3 つのデータセットは合計のみを保持します。メンバー名を示す行はなく、ノートブックのパスは * に置き換えられます。残りの 4 つ（メンバー、メンバー別の日次、内容、メンバー別のコンテンツ）はレポート用に作られています。メンバー、メンバー別の日次、メンバー別のコンテンツにはメンバーの識別情報（ユーザー ID、ユーザー名、メールアドレス、姓名、セキュリティグループ）が含まれるため、ターゲットテーブルはメンバー一覧と同様に扱ってください。このステップの各実行はセキュリティログに記録されます。

設定

利用状況データ

データセットは、各行に格納する内容を選択します。

データセット	値	1 行の単位	識別情報
項目別 (日別)	`daily_item`	日、領域、イベント、対象	なし
項目別 (月別)	`monthly_item`	月、領域、イベント、対象	なし
月別合計（デフォルト）	`monthly_tenant`	月、領域	なし
メンバー	`members`	ワークスペース内の人	あり
メンバー別の日次	`daily_user`	人、日、領域	あり
内容	`content`	ダッシュボード、アプリ、ノートブック	なし
メンバー別のコンテンツ	`content_user`	人と項目	あり

領域は、行を 1 つの領域に絞り込みます。すべてを含めるには、すべての領域のままにします。

領域	値
すべての領域（デフォルト）	`""`
PlaidCloud アプリ	`plaidclient`
ダッシュボード	`superset`
アプリ	`panel`
アプリ訪問	`panel_visit`
ノートブックサーバー	`jupyterhub`
ノートブック	`jupyter`

この値は、API または AI アシスタントを通じてステップを作成または編集するときに、ステップが保持する値です。

列

項目別 (日別)

day、source、event、subject、events。

項目別 (月別)

month、source、event、subject、users、events、unattributed_events、coverage_start、partial。

月別合計

month、source、active_users、coverage_start、partial。

partial は、履歴が完全には対象とならない月で true になります。coverage_start は収集が開始された日付です。月は、数値が確定する締め日の 3 日後に含まれます。

メンバー列

メンバー、メンバー別の日次、メンバー別のコンテンツは、同じ 7 つの列で始まります。

列	内容
`user_id`	メンバーの ID。
`user_name`	メンバーのユーザー名。
`email`	メンバーのメールアドレス（小文字）。
`first_name`	名。
`last_name`	姓。
`is_active`	メンバーがアクティブな場合は true、無効化されている場合は false。
`groups`	メンバーのセキュリティグループ（`;` 区切り）。

groups には最上位のグループのみが含まれます。サブグループは展開されません。

メンバー

メンバー列に続いて、次の列があります。

列	内容
`first_seen`	日付範囲に関係なく、メンバーが初めて PlaidCloud を使用した日。領域を設定した場合は、その領域で初めて使用した日。
`last_seen`	範囲内でメンバーが最後に活動した日。
`active_days`	範囲内で活動があった日数。
`events`	範囲内のアクティビティイベント数。
`active_minutes`	アクティビティの分数。領域をまたいで重複する分は 1 回として数えます。
`session_minutes`	セッションの分数。
`app_open_minutes`	メンバーが Panel アプリを開いていた分数。

利用状況が消去されたメンバーを除き、すべてのメンバーに行があります。サービスアカウントとエージェントは一覧に含まれません。範囲内にアクティビティがないメンバーは、groups 以降の値が空になります。合計は、その後に削除されたメンバーを除き、利用状況レポートと一致します。

メンバー別の日次

メンバー列に続いて、day、source（領域）、events、active_minutes、session_minutes、first_at、last_at（その日の最初と最後のアクティビティ時刻）があります。

内容

列	内容
`type`	`dashboard`、`panel_app`、`wasm_app`、`notebook` のいずれか。
`subject`	項目の ID。すべてのノートブックが 1 つの行を共有し、ここには `*` が入ります。
`name`	項目の名前。ノートブックの場合は `*`。
`deleted`	項目がその後に削除された場合は true。
`users`	開いたメンバー数。
`opens`	開かれた回数。
`last_used`	最後に使用された日時。
`app_open_minutes`	Panel アプリが開かれていた分数。

メンバー別のコンテンツ

メンバー列に続いて、type、subject、name（内容と同じ）、opens（このメンバーが項目を開いた回数）、last_day（メンバーが最後に使用した日）があります。

メンバーデータセットに関する注意事項

エージェント、サービスアカウント、その後に削除されたメンバーのアクティビティでは、識別列が空になります。削除されたメンバーには user_id のみが残ります。
内容の開かれた回数は、メンバー別のコンテンツの開かれた回数の合計を上回ることがあります。差分は、ダッシュボードの埋め込み表示やゲスト表示など、メンバーに帰属させられない開かれた回数です。内容はこれを数えますが、メンバー別のコンテンツは数えられません。

例：部門別のアクティブ分数

メンバーとメンバー別のコンテンツには、メンバーの email（小文字）が含まれるため、人事テーブルや組織マスターテーブルなど独自のテーブルと結合して、部門別にレポートできます。

データセットをメンバーに設定し、usage_members などのターゲットテーブルを指定して、Get Workspace Usage ステップを追加します。
小文字の email 列が一致する条件で usage_members と組織テーブルを結合する テーブル: 内部結合 ステップを追加します。部門は組織テーブルから、active_minutes 列と events 列は usage_members から保持します。
同じステップで、部門ごとに集計し、active_minutes を合計します。

結果は部門別のアクティブ分数になります。組織テーブルにないメンバーは内部結合から除外されるため、表示したい場合は左結合を使用してください。メンバー別のコンテンツに対して 2 つ目のステップで同様に実行し、部門ごとに opens を合計すると、どの部門がどのダッシュボードやアプリを使っているかをレポートできます。

日付範囲

範囲は、読み取る日数を選択します。

範囲	値	読み取り対象
直近の日数（デフォルトは 30）	`last_days`	本日を含む直近の日数。
前月	`previous_month`	直近の完全な暦月。
月初から本日まで	`month_to_date`	今月 1 日から本日まで。
日付範囲指定	`dates`	開始日から終了日まで。終了日を空にすると本日まで読み取ります。

日数と日付は UTC です。日、開始日、終了日には、数値や YYYY-MM-DD 形式の日付のほか、{report_start} などの変数も指定できます。開始日が終了日より後であってはなりません。

利用状況のターゲット

ターゲットテーブルに結果が書き込まれます。ステップはテーブルの既存の内容を置き換え、行がない場合でも常にデータセットの列を書き込みます。

警告

これらはステップを失敗させません。ステップは何が起きたかを示す警告付きで完了し、テーブルも書き込まれます。

ワークスペースで利用状況の収集がまだ設定されていません。
範囲内に利用状況がありませんでした。
範囲の開始日が保持期間より前だったため、履歴が始まる日に合わせて切り詰められました。日次データは 180 日間、月次データは 25 か月間保持されます。

セキュリティログ

各実行は、データセット、範囲、ターゲットテーブル、ワークフロー、ステップ、実行、書き込まれた行数を記録したエントリをセキュリティログに書き込みます。