【入門編】 SCRIPT DEBUGコマンド – Redis

こんにちは！Redisの奥深い世界へようこそ。
今日は、Redisを使いこなす上で避けて通れない、けれどちょっと難しそうに見える「Lua（ルア）スクリプトのデバッグ」についてお話ししますね。

「えっ、デバッグ？なんだか難しそう……」なんて身構えなくて大丈夫ですよ。
ここをクリアすれば、あなたのRedisスキルは一段とレベルアップします。先輩と一緒に、一歩ずつ紐解いていきましょう！

—

なぜRedisでデバッグが必要なの？

まず、Redisの基本的なおさらいをしましょう。
Redisは、データをメモリ上に置いて超高速に処理してくれる、いわば「超特急のデータ保管庫」です。通常は、1つひとつの命令（コマンド）を順番に処理していきます。

しかし、「この処理と、あの処理をセットで、一瞬で終わらせたい！」という時がありますよね。そんな時に使うのが、Redisの中で小さなプログラムを動かせる「Luaスクリプト」という機能です。

イメージとしては、「スーパーのレジで、複数の商品をまとめてカゴに入れ、一気に会計を済ませる裏技」のようなものです。

ただ、この裏技（スクリプト）の中に間違い（バグ）があったらどうなるでしょう？
プログラムが途中で止まってしまったり、予期しない動きをしたりして、超特急のレジ全体が大渋滞を起こしてしまいます。そんな時、「どこでつまずいたのか？」をレントゲン写真のように透視して調べる機能が、今回主役となる `SCRIPT DEBUG` コマンド なんです。

—

魔法のレンズ：`SCRIPT DEBUG` の3つのモード

`SCRIPT DEBUG` は、Luaスクリプトの実行中に「ここで止めたい！」「1行ずつ様子を見たい！」という時に使います。モードは大きく分けて3つあります。

1. `YES`（同期デバッグモード）

スクリプトを1行ずつ止めながら、まるで紙芝居をめくるようにじっくり確認するモードです。

2. `SYNC`（非同期…ではなく、同期の別名…と言いたいところですが、実際には「Redis全体を止めずに、このセッションだけデバッグする」ための強力なモードです）

実務では主に `YES` や、後述の `NO` を使います。

3. `NO`（デバッグ終了）

「もうバグは見つかったから、通常運転に戻して！」という時のモードです。

日常の例えで言うなら、「動くおもちゃの分解キット」です。普通に遊ぶと一瞬で通り過ぎてしまう動きを、`SCRIPT DEBUG YES` を使うことで、スローモーションでギアがかみ合う瞬間を観察できるわけです。

—

実際にやってみよう！

百聞は一見に如かず。実際にデバッグの雰囲気を体験してみましょう。

ステップ1：デバッグモードをONにする

まずは、Redisに「これからスクリプトの細部をチェックするよ」と伝えます。

デバッグモードを有効にする（同期モード）
127.0.0.1:6379> SCRIPT DEBUG YES
OK

これで準備完了です。

ステップ2：怪しいスクリプトを実行してみる

例えば、「足し算をするだけの簡単なLuaスクリプト」を動かしてみましょう。

2つの数字を足すだけのスクリプトをその場で実行
127.0.0.1:6379> EVAL “local a = 10; local b = 20; return a + b” 0

このコマンドを叩いた瞬間、通常のRedisなら一瞬で「30」と返ってくるところですが、デバッグモードがONになっていると、画面がピタッと止まります。（正確には、開発用のターミナル側にデバッグのプロンプトが表示され、開発者の指示を待ちます）

ステップ3：1行ずつ進める（ステップ実行）

デバッグ画面では、以下のような操作ができます。

`s` （Step）：次の1行を実行する
`n` （Next）：関数を飛ばして次へ進む
`c` （Continue）：最後まで一気に走らせる

変数 `a` に本当に「10」が入っているか、変数 `b` は「20」か、自分の目で確かめながら進められるので、バグを見つけるのが劇的に楽になります。

ステップ4：終わったら必ず元に戻す！

ここが一番重要なポイントです。
デバッグが終わったら、必ずデバッグモードをOFFにしてください。ONのままにしておくと、Redis全体のパフォーマンスに影響が出たり、他の人の処理を邪魔してしまったりします。

デバッグモードを終了する
127.0.0.1:6379> SCRIPT DEBUG NO
OK

「使ったら片付ける」、エンジニアの基本ですね！

—

実務での心構えと注意点

最後に、現役のシニアエンジニアからのアドバイスです。

本番環境（プロダクション）では絶対に `SCRIPT DEBUG YES` を使わないこと！

なぜなら、デバッグモードが動いている間、Redisはそのセッションの処理に集中してしまい、他のユーザーからのリクエストを待たせてしまうことがあるからです。デバッグは必ず、自分の手元にある開発用（ローカル）の環境で行いましょう。

困ったらまず `SCRIPT DEBUG NO`

「なんかRedisの様子がおかしいぞ？」と思ったら、うっかりデバッグモードが有効になっていないか確認するのも、トラブルシューティングの定石です。

—

いかがでしたか？
`SCRIPT DEBUG` は、一見するととっつきにくいコマンドですが、「プログラムの中を覗き見して、お医者さんのように診察する道具」だと分かれば、怖くありませんよね。

ここをクリアできれば、複雑なデータ操作もRedisで自由自在に扱えるようになります。
あなたのRedisマスターへの道順は、確実に進んでいますよ。自信を持って、次のステップへ進みましょう！