Skip to content

ログ設計ガイドライン

Log Design Guidelines

はじめに

本ガイドラインは、アプリケーションが出力するログの設計規約をまとめたものである。

免責事項

  • 有志で作成したドキュメントである。フューチャーには多様なプロジェクトが存在し、それぞれの状況に合わせて工夫された開発プロセスや高度な開発支援環境が存在する。本ガイドラインはフューチャーの全ての部署/プロジェクトで適用されているわけではなく、有志が観点を持ち寄って新たに整理したものである
  • 相容れない部分があればその領域を書き換えて利用することを想定している。プロジェクト固有の背景や要件への配慮は、ガイドライン利用者が最終的に判断すること。本ガイドラインに必ず従うことは求めておらず、設計案の提示と、それらの評価観点を利用者に提供することを主目的としている
  • 掲載内容および利用に際して発生した問題、それに伴う損害については、フューチャー株式会社は一切の責務を負わないものとする。掲載している情報は予告なく変更する場合がある

適用範囲・前提条件

  • 対象スコープ
    • アプリケーションが出力するログ(アプリログ)が対象
    • AWS CloudTrailやVPCフローログといった、クラウドサービスやインフラストラクチャ側で出力されるログは対象外
    • 主にバックエンド領域のログを扱う。フロントエンドのログについても一部言及するが、本ガイドラインの主眼にしない
  • 前提条件
    • 実行環境: クラウド利用を前提とする。オンプレミス環境で必要となるファイルベースのログローテーションは考慮しない
    • 出力方式: ログはファイルではなく、標準出力を基本とする

謝辞

このアーキテクチャガイドラインの作成には多くの方々にご協力いただいた。心より感謝申し上げる。

  • 作成者: 真野隼記、八木雅斗、宮崎将太、武田大輝、澁川喜規
  • レビュアー: 募集中

Articles