システム移行時のログメッセージ引き継ぎで経験したこと【株式会社ライトコード】

※弊社エンジニアの記事になります。

はじめに

長く使っているシステムを運用しつつ、引き継ぎながら新しいシステムにリニューアルしていく、ってことはそこそこあるかと思います。

その時には、運用を出来るだけ止めないとか、旧システムよりも使いやすくしたいとか、など色々と対応すべきことはありますが、今回は旧システムから新システムへのログ出力の引き継ぎでいろいろと起きたことや感じたことを書いていきます。

背景

旧システムをリニューアルするにあたって、出力されていたログメッセージや表示項目も整理して変わることになりました。

それでいて、旧システムの運用チームで今まで対応してきたエラー対応は資料として残っているので、そのまま継続して資料が利用できるようにしてリニューアル後もスムーズにエラー対応したい、なので旧エラーメッセージと新エラーメッセージは紐付けておきたい、といったのが今回の背景となります。

REST-API から gRPCのAPIへ

APIの処理は、旧システムではREST-APIを採用していましたが、リニューアル後はgRPCでのAPI対応となりました。

これによってエラーコードも扱い方が変わってきます。

例えばREST-APIでは、問い合わせた結果が無くてエラー出力する時にHTTPレスポンスのステータスコード「404:NotFound」をレスポンスしていたとします。

gRPCで同じようなことをしたい場合、メソッドの呼び出し自体が成功していると、そのメソッド内でエラーが起きようともHTTPレスポンスのステータスコードは「200:OK」でレスポンスされるため、独自で持っているコードで返却する必要があります。今回の場合だと、「5:NotFound」がそれに該当するかと思います。

考え方として

まずやることとしては、新旧それぞれのシステムのエラーコードの紐付けをするところからかなと思います。

REST-APIで「404:NotFound」で返していたものは、gRPCでは「5:NotFound」で返すように設計するのが良い感じになります。

ただ、処理によってはNotFoundだけど「400:Bad Request」で返す、とか業務内容に合わせてエラーコードを調整していたものもあるかと思います。そこは内容を確認して適宜調整が必要かなと思われます。

このエラーコードの紐付けとメッセージの紐付けが出来れば、新しい方のシステムでも同じようにエラー時の対応が運用側でも出来そうかなと思います。

＜旧システムのレスポンス例＞
{
    code:404
    message:idが見つかりません。検索し直してください。
}

＜新システムのレスポンス例＞
{
    status:200
    code:5
    message:idが見つかりませんでした。
}

ここまでは方針として記載しましたが、実際にはそう簡単にはいかず。。。

以降は実際に対応した時の作業をざっくりと記載します。

…

記事の続きは下のリンクをクリック！

https://rightcode.co.jp/blog/information-technology/system-migration-log-messages-syain

【2024年卒】新卒採用エントリー開始しました！

特設ページはこちら：https://rightcode.co.jp/recruit/entry-2024

※募集は終了致しました。次回の募集までもうしばらくお待ちください

インターン募集！未経験ok、チャレンジ精神ある方求む

メディア運営：https://rightcode.co.jp/recruit/intern-media

社長と一杯飲みながらお話しませんか？（転職者向け）

特設ページはこちら： https://rightcode.co.jp/gohan-sake-president-talk

もっとワクワクしたいあなたへ

現在、ライトコードでは「WEBエンジニア」「スマホアプリエンジニア」「ゲームエンジニア」、「デザイナー」「WEBディレクター」「エンジニアリングマネージャー」「営業」などを積極採用中です！

有名WEBサービスやアプリの受託開発などの企画、開発案件が目白押しの状況です。

• もっと大きなことに挑戦したい！
• エンジニアとしてもっと成長したい！
• モダンな技術に触れたい！

現状に満足していない方は、まずは、エンジニアとしても第一線を走り続ける弊社代表と気軽にお話してみませんか？

ネット上では、ちょっとユルそうな会社に感じると思いますが（笑）、
実は技術力に定評があり、沢山の実績を残している会社ということをお伝えしたいと思っております。

• ライトコードの魅力を知っていただきたい！
• 社風や文化なども知っていただきたい！
• 技術に対して熱意のある方に入社していただきたい！

一度、【Wantedly内の弊社ページ】や【コーポレートサイト】をのぞいてみてください。

【コーポレートサイト】https://rightcode.co.jp/

【採用募集】https://rightcode.co.jp/recruit（こちらからの応募がスムーズ）

【wantedlyぺージ】https://www.wantedly.com/companies/rightcode