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

ランナー認証キャッシュ

ランナーがサーバーに送信するすべてのリクエストにはトークンが含まれており、サーバーは他の処理を行う前に、そのトークンをランナーのレコードに変換する必要があります。ランナーは数秒ごとにポーリングを行い、ジョブの実行中は 1 秒ごとに進捗を報告するため、キャッシュがなければこれらのリクエストのすべてにデータベースクエリが必要になります。ランナーキャッシュは、その大部分にメモリから応答します。

単一ノードの場合、キャッシュは自身のメモリ上に保持されます。HA モードではそれでは不十分です。ノード A でランナーを編集した場合、ノード B が古いレコードを返し続けてはなりません。そのため HA モードではキャッシュは Redis に置かれ、すべてのノードで共有されます。どのノードを経由して行われた変更も、すべてのノードから即座に見えるようになります。

注記

このキャッシュは、ランナーページの キャッシュをクリア 操作とは別のものです。その操作は、ランナー自身にそのマシン上の作業ディレクトリを削除するよう要求するものです。

キャッシュされる内容と期間​

キャッシュされる値は、タグとトークンを除いたランナーのレコードです。トークンが Redis に到達することはありません。キーはトークンの SHA-256 ハッシュから導出され、レコードが保存される前にトークンのフィールドは空にされます。

エントリの有効期間は最長 30 秒です。実際にはそれよりもはるかに早く破棄されます。Semaphore を通じて行われたすべての変更が、キャッシュを即座に無効化するためです。

  • ランナーの作成、更新、削除、再登録、またはプロジェクトの削除は、すべてのノード上の すべての キャッシュ済みランナーを破棄します。
  • ランナーのハートビートは そのランナーの エントリだけを破棄するため、他のエントリに影響を与えることなく、保存されている「最終確認」時刻が最新に保たれます。ハートビートは、runners.offline_timeout_sec の 3 分の 1 (上限 45 秒) の間隔につき最大 1 回書き込まれます。デフォルトのタイムアウトである 120 秒では、40 秒ごとになります。

30 秒の有効期限が意味を持つのは、Semaphore を介さずに行われた変更、たとえば runner テーブルを直接編集した場合やバックアップを復元した場合だけです。

古い書き込みの防止方法​

キャッシュにヒットしなかった検索は、データベースからランナーを読み込んでから保存します。この 2 つのステップの間に、別のノードがランナーを変更する可能性があります。検索が変更前に読み取った内容を決してキャッシュしないように、キャッシュは無効化のたびに増加するカウンターを保持しています。検索はデータベースにアクセスする前に見たカウンターの値を記憶し、その間にカウンターが進んでいた場合、保存は拒否されます。各ステップは Redis 上で 1 つの Lua スクリプトとして実行されるため、カウンターとエントリは一緒に読み書きされます。

Redis キー​

キー型用途
ha:runner:genstring、整数カウンター。キャッシュ全体の無効化でも単一ランナーの無効化でも、無効化のたびに 1 ずつ増加します。
ha:runner:invstring、整数最後に全体の無効化が行われた時点のカウンター値。すべてのエントリキーの一部になっているため、全体の無効化によって既存のすべてのエントリが一度に到達不能になります。その後、それらは自然に期限切れになります。
ha:runner:token:<inv>:<sha256(token)>string、バイナリキャッシュされたランナーのレコード。30 秒後に期限切れになります。
ha:runner:forgot:<sha256(token)>string、整数このランナーの最後のハートビート時点のカウンター値。ハートビートより前に開始された検索は、ハートビート前のレコードを保存できません。30 秒後に期限切れになります。

クラスターダッシュボードは、ha:runner:token:* キーの数をランナーキャッシュのサイズとして表示します。

Redis に問題が発生した場合の動作​

キャッシュが原因でランナーのリクエストが失敗することはありません。すべてのキャッシュ操作は 500 ミリ秒に制限されています。Redis が遅いか到達できない場合、検索はミスとして扱われてデータベースにアクセスし、何も保存されません。注意すべき唯一のケースは、ランナーが変更された瞬間に Redis が停止していて無効化が失敗した場合です。このとき他のノードは、エントリが期限切れになるまで、最長で 30 秒後まで古いレコードを返す可能性があります。この失敗はエラーレベルでログに記録されます。