メインコンテンツまでスキップ

ワーカープラグイン管理

ワーカープラグインは、組織ごとに1つのサーバー側プログラムをmetatell上で動かす機能です。 管理画面では、ワーカープラグインの登録、シークレットの設定、ログとデータの確認、R2のファイルの管理、ワーカープラグインの削除ができます。

ワーカープラグインの開発方法は、ワーカープラグイン開発を参照してください。

備考

ワーカープラグインを管理できるのは組織管理者だけです。 管理画面の左メニューの「開発者向け」にある「ワーカープラグイン」から操作します。

ワーカープラグインを登録する​

  1. 左メニューの「ワーカープラグイン」を開きます。
  2. 「ワーカープラグインを登録」をクリックします。
  3. ビルドで作成したplugin.zipを選択して登録します。

登録に成功すると「ワーカープラグインを登録しました。」と表示され、デプロイ状態が表示されます。

項目内容
最終デプロイ最後にZIPを登録した日時
互換性の日付wrangler.jsoncのcompatibility_date
互換性フラグwrangler.jsoncのcompatibility_flags

ZIPの内容に問題がある場合は、登録に失敗し、原因が表示されます。 ZIPの条件はZIPと設定を参照してください。

備考

「登録の記録に失敗したため」と表示された場合は、同じZIPをもう一度登録してください。

ワーカープラグインを更新する​

1組織につき登録できるワーカープラグインは1つです。 新しいZIPを登録すると、既存のワーカープラグインを置き換えます。

  1. 「ワーカープラグイン」を開きます。
  2. 「新しいZIPを登録」をクリックします。
  3. 新しいplugin.zipを選択して登録します。

更新してもDurable Objectsのデータとシークレットは残ります。 以前のZIPを登録し直しても、元に戻るのはコードだけで、データは戻りません。 登録したZIPはmetatellに保存されません。以前のバージョンへ戻す場合に備えて、ZIPは手元で保管してください。

シークレットを管理する​

シークレットは、外部APIのキーなどの秘匿情報です。 ワーカープラグインのコードからはenv.名前で参照できます。 シークレットはワーカープラグインを登録した後に設定できます。

シークレットを追加する​

  1. 「ワーカープラグイン」の「シークレット」で「シークレットを追加」をクリックします。
  2. 「名前」と「値」を入力します。
  3. 「登録」をクリックします。

名前には英大文字、数字、_を使えます。先頭に数字は使えません。 次の名前は使えません。

  • PLUGIN_で始まる名前
  • ZIPのwrangler.jsoncで宣言したバインディングと同じ名前

シークレットの値を更新する​

  1. 更新するシークレットの「値を更新」をクリックします。
  2. 新しい値を入力して「更新」をクリックします。

シークレットを削除する​

  1. 削除するシークレットの「削除」をクリックします。
  2. 確認画面で「削除」をクリックします。

シークレットの値は登録後に表示できません。 追加、更新、削除はすぐに反映され、ZIPを登録し直す必要はありません。

コードからの使い方は、シークレットを参照してください。

ログを確認する​

  1. 「ワーカープラグイン」の「ログ」で「ログを見る」をクリックします。
  2. 直近7日間のログが新しい順に表示されます。
  3. 行をクリックすると、ログと例外の詳細を確認できます。

ログは自動で更新されません。最新のログを確認するには「更新」をクリックします。

項目内容
日時実行された日時
結果応答のステータス。正常に終了しなかった場合は「例外」「CPU 時間超過」などの結果
リクエストリクエストのメソッドとパス。Durable Objectsの中の実行には「DO」と表示されます
内容例外、または最初のログ
  • ログはconsoleの出力と例外を、実行1回ごとにまとめて表示します。
  • ログと例外を出力せずに正常に終了した実行は記録されません。すべてのリクエストが表示されるわけではありません。
  • 1組織につき1日10,000実行まで記録されます。上限に達すると、それ以降のログは保存されません。上限は毎日9時（日本時間）にリセットされます。

Durable Objectsのデータを確認する​

ワーカープラグインがDurable Objectsを使っている場合、データの中身を確認できます。

  1. 「ワーカープラグイン」の「Durable Objects」で、確認するクラスをクリックします。
  2. 「インスタンス」を選択します。一度でも起動したインスタンスがID順に表示されます。
  3. 「テーブル」を選択すると、テーブルの行が表示されます。「スキーマを表示」をクリックすると、テーブルの定義を確認できます。

インスタンスを選択した状態で、SQLを実行できます。 実行前に確認画面が表示されます。 結果が多い場合は、先頭の1,000行だけが表示されます。

警告

SQLはワーカープラグインが使っている本番のデータに対して実行されます。 データを変更、削除するSQLは元に戻せません。

R2のバケットを作成する​

R2は、写真や帳票などのファイルを保存するCloudflareのストレージです。 1組織につき1つのバケットを作成できます。

  1. 「ワーカープラグイン」の「R2」で「R2バケットを作成」をクリックします。
  2. 「R2バケットを作成しました。」と表示されます。

バケットはワーカープラグインを登録する前でも作成できます。 ワーカープラグインがバケットを使うには、wrangler.jsoncのr2_bucketsでR2を宣言したZIPを登録する必要があります。 宣言していない場合は、「R2」に「宣言されていません」と表示されます。

警告

r2_bucketsを宣言したZIPは、バケットを作成する前は登録できません。 先にバケットを作成してください。

R2のファイルを管理する​

  1. 「ワーカープラグイン」の「R2」で「ファイルを見る」をクリックします。
  2. バケットのファイルとフォルダーが表示されます。フォルダーをクリックすると、その中のファイルが表示されます。
操作方法
ダウンロードファイルの行のダウンロードのアイコンをクリックします
アップロード「アップロード」をクリックしてファイルを選択します。開いているフォルダーに保存されます
削除ファイルの行の削除のアイコンをクリックし、確認画面で「削除」をクリックします
  • アップロードできるファイルは1つにつき100MBまでです。
  • 同じ名前のファイルをアップロードすると上書きされます。
  • アップロードは、ワーカープラグインがr2_bucketsを宣言しているときだけできます。宣言を外した後も、残ったファイルのダウンロードと削除はできます。

R2のバケットを削除する​

  1. 「ファイルを見る」で開いた画面の「Danger Zone」で「R2バケットを削除」をクリックします。
  2. 確認のため、組織IDを入力します。
  3. 「削除」をクリックします。

ワーカープラグインがr2_bucketsを宣言している間は、バケットを削除できません。 先にr2_bucketsを外したZIPを登録してください。

危険

バケットを削除すると、中のファイルはすべて失われ、元に戻せません。

ワーカープラグインを削除する​

  1. 「ワーカープラグイン」の「Danger Zone」で「ワーカープラグインを削除」をクリックします。
  2. 確認のため、組織IDを入力します。
  3. 「削除」をクリックします。
危険

削除すると、Durable Objectsのインスタンスとデータ、シークレットはすべて失われ、元に戻せません。

R2のバケットとファイルは、ワーカープラグインを削除しても残ります。 不要な場合は、R2のバケットを削除してください。

削除すると、ワーカープラグインへの新しいリクエストは404になります。 確立済みのWebSocketの接続は、削除しても切断されません。

に最終更新