後で困らないログの出し方を設計するプロンプトです。 機能を作るとき、障害対応で情報が足りなかったあとに。ログは事故が起きてから足すのでは遅いので、「後で何を知りたくなるか」から逆算させます。個人情報を出さない線引きも同時に決めさせます。
プロンプト
0 回コピー
以下の処理について、ログ出力を設計してください。 # 出力形式 ## 1. 事故が起きたときに知りたいこと - [知りたいこと] / それが無いと何が分からないか ## 2. 出すログ | 場所(処理のどこ) | レベル | 出す内容 | 1で挙げたどれに対応するか | |---|---|---|---| ## 3. 出してはいけない情報 - [項目] / 代わりに何を出すか(例:メールアドレスそのものではなく、識別できない形の値) ## 4. 出さないと決めたもの - [項目] / 出さない理由(量が多すぎる/後から復元できる) ## 5. 正常時にも出すべきもの - 異常時だけのログでは、いつから壊れていたかが分からない。正常系で最低限残すもの # 制約 - 全部の行にログを入れる設計にしない。多いログは無いのと同じ。 - ログの文言に、その時点の変数名だけを並べない。何が起きたかが読める文にする。 - 個人情報・認証情報・トークンをログに出す設計を書かない。 - 「必要に応じて」と書かない。出すか出さないかを決める。 # 処理の内容 (コードでも、処理の流れの説明でもよい) # 誰がこのログを読むか (例:自分だけ / 運用担当 / 障害時に初めて見る人)