プロダクト

Dagu の Web UI を刷新: 1 ページでワークフローを編集して実行

Dagu のワークフローが 1 ページにまとまりました。キャンバスまたは YAML で編集し、実行を開始して、実行、ログ、承認を同じ場所で追えます。保存すると、これまでどおり普通の YAML ファイルに書き込まれます。

Yota Hamada
Share

TL;DR Dagu の Web UI を刷新しました。ワークフローごとに 1 ページにまとまり、キャンバスまたは YAML で編集しながら、実行、ログ、承認を追えます。保存すると、これまでどおり git で管理できる普通の YAML ファイルに書き込まれます。v2.25 の新しい UI は @SCcagg5 さんが設計し、実装しました。dagu upgrade で入手できます。

v2.25 より前は、1 つのワークフローが Latest Run、Spec、Webhook、Notifications、History のタブに分かれていました。ステップを変更して結果を確かめるには、タブを行き来する必要がありました。

UI のほかの部分にも似た問題がありました。見た目も使い勝手も古い管理画面のテンプレートのようで、サイドバーには折りたたみグループが 8 つあり、たいていのページは 2 回クリックして探す必要がありました。v2.20 でその外枠を置き換え、v2.25 でワークフローページを置き換えました。

ワークフローごとに 1 ページ

ページは 3 つの部分でできています。上部のバーには名前、選択中の実行、開始 があります。キャンバスはステップをグラフで描き、その実行での状態を各ステップに示します。下部の アクティビティ には、実行のタイムライン、ステップ、ログと結果があります。

warehouse-refresh のワークフローページ。実行の途中で、snapshot ステップは成功し、3 つの mart ステップが並列で動いている。下の Activity パネルには直近 30 回の実行と、現在の実行のタイムラインが表示されている

別の実行を選ぶまでは、最新の実行が表示されます。URL に実行とステップが記録されるので、チャットに貼ったリンクから同じ画面を開けます。既存の通知に含まれる実行リンクもそのまま使え、このページで開きます。

キャンバスでも YAML でも編集できる

N を押すか、ステップの後ろの + を選ぶと、パレットからステップを追加できます。ステップからステップへドラッグすると、依存関係を追加できます。

キャンバスの横に開いたステップパレット。検索ボックスの下に Run command、HTTP request、Workflow run、Router route などのアクションが並んでいる

キャンバスの横の YAML タブには、ファイル全体が表示されます。バリデーション、スキーマに基づく補完、整形、クイックフィックスが使えます。保存 すると、ファイルに書き込む前に保存済みの版との差分が表示されます。ワークフローは今も YAML ファイルなので、git で管理し、差分でレビューできます。

キャンバスに上から下へ描かれた nightly-etl ワークフローと、その横の YAML タブに表示されたパラメーターとステップ

保存する前にステップを試すこともできます。ステップを実行 はそのステップをすぐに実行し、上流ステップの出力は以前の実行のものを再利用できます。未保存の編集から実行したステップはテスト実行です。記録には残らず、終了から 10 分後に消えます。

実行が失敗したとき

失敗したステップをクリックすると、終了コードと stderr の末尾が表示され、そのまま ステップを再試行 を選べます。ステップは横のタブで開くので、キャンバスは動きません。実行ログ タブでは、失敗したステップの stderr が開きます。

キャンバスで選択した、失敗した post_invoices ステップ。横のパネルに、終了コード 1、stderr の 502 Bad Gateway エラー 3 件、Retry step ボタンが表示されている

履歴 タブには、直近の実行にわたる各ステップの状態が並ぶので、失敗が新しいものかどうかがわかります。ステップ名を選ぶと、成功率と通常の所要時間が表示されます。

nightly-etl の History タブ。ステップと 30 回の実行のグリッドで、ほぼすべて成功している。2 回の実行では validate が失敗し、その後のステップは中止されている

実行が人の対応を待っているときは、キャンバスに通知が表示され、アクション タブに承認や入力フォームがまとまります。

ワークフローページの周辺

  • 概要 は、人の対応が必要なものから表示します。失敗しているワークフローと、入力を待っている実行です。その下に、実行中のものと次に予定されている実行が並びます。コックピット はライブのボードで、新しいビュー で自分のボードを追加できます。
  • 一覧 からは、ワークフローや実行を一覧の上に重ねて開けます。URL はそれぞれ専用です。Up と Down で行を移動でき、ブラウザの戻るボタンで一覧に戻ります。
  • コマンドパレット: ⌘K または Ctrl+K で、任意のワークフローやページへ移動できます。
  • サイドバー: すべてのページに、監視、設定、管理 の見出しの下から直接移動できます。
  • テーマ: UI はシステムのライトまたはダークの設定に従います。
概要の Activity タブ。直近の実行数、失敗 1 件と入力待ち 2 件の Needs attention リスト、実行中のもの、次に予定されている実行、ワークフローごとの過去 24 時間の実行が表示されている

スクリーンショットはデモサーバーのものなので、ワークフローと履歴は架空です。

試してみる

dagu upgrade を実行するか、インストールしたときの方法で更新して、ワークフローを開いてください。各画面の説明は Web UI のドキュメントにあります。使いにくい点があれば、Discord で教えてください。

v2.25 の UI は、@SCcagg5 さんが 31 個のプルリクエストで設計し、実装しました。Dagu の日々の使い心地を変える仕事です。ありがとうございました。

· · ·

Written by

Yota Hamada

Daguプロジェクトのコントリビューター。

More from Yota Hamada