mcpField
1
181-java-observability-logging

181-java-observability-logging

github.com/jabrena開発456301 回インストール1 日前に更新
リポジトリ

181-java-observability-logging について

Javaのログフレームワーク、レベル、設定、セキュリティ、監視の実践を扱うスキルです。Javaアプリケーションの可観測性を改善・レビューする開発者向けで、変更前のコンパイルと変更後の全検証を求めます。

主な機能

  1. 01SLF4JとLogbackまたはLog4j2の指針
  2. 02一貫したログレベルとパラメーター化ログ
  3. 03例外処理と機密データの保護
  4. 04環境別設定とログローテーション
  5. 05ログ集約とアラートの推奨事項

活用シーン

  1. 01Javaプロジェクトのログ運用をレビュー
  2. 02安全な構造化アプリケーションログを追加
  3. 03ログ設定とローテーションを改善
  4. 04集中ログ監視とアラートを計画

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/jabrena/plinth --skill 181-java-observability-logging

インストール後、Claude Code で/181-java-observability-loggingを入力して読み込まれたか確認します。

同梱ファイルreferences/181-java-observability-logging.md

詳細

Java ロギングのベストプラクティス

標準化されたフレームワーク、有意義なログレベル、基本的なプラクティス(パラメーター化ロギング、例外処理、機密データを記録しないこと)、明示的な相関コンテキスト、柔軟な設定、セキュリティを考慮したロギング、モニタリング、アラートを取り入れて、効果的な Java ロギングを実装します。

このスキルで扱う内容

  • 標準化されたフレームワークの選定:SLF4J ファサードと Logback または Log4j2
  • 有意義で一貫性のあるログレベル:ERROR、WARN、INFO、DEBUG、TRACE
  • 基本的なプラクティス:パラメーター化ロギング、適切な例外処理、機密データの回避
  • 設定:環境別設定(logback.xml、log4j2.xml)、出力形式、ログローテーション
  • セキュリティ:機密データのマスキング、ログへのアクセス制御、安全な転送、GDPR/HIPAA への準拠
  • ログのモニタリングとアラート:一元的な集約(ELK、Splunk、Loki)、自動アラート

対象範囲: このリファレンスは、各基本領域について例(適切なコードパターン/不適切なコードパターン)をまとめています。該当する例に基づいて推奨事項を適用してください。

制約

ロギングに関する推奨事項を適用する前に、プロジェクトがコンパイルできることを確認してください。コンパイルに失敗した場合は、作業を中断してください。改善を適用した後は、完全な検証を実行してください。

  • 必須: 変更を適用する前に ./mvnw compile または mvn compile を実行してください
  • 安全性: コンパイルに失敗した場合は、直ちに中止してください。問題が解決するまで先に進まないでください
  • 検証: 改善を適用した後に ./mvnw clean verify または mvn clean verify を実行してください
  • 適用前: 各ロギングパターンの詳細な適切な例/不適切な例、制約、安全対策を確認するため、リファレンスを読んでください

このスキルを使用する場面

  • ロギングを改善する
  • ロギングを適用する
  • ロギングをリファクタリングする
  • ロギングのサポートを追加する
  • Java コードの SLF4J 構造化ロギングをレビューする

ワークフロー

  1. ロギングの変更前にプロジェクトをコンパイルする

./mvnw compile または mvn compile を実行し、コンパイルに失敗した場合は直ちに中止してください。

  1. ロギングのリファレンスを読み、現在の可観測性を評価する

references/181-java-observability-logging.md を読み、フレームワークの使用状況、ログレベル、機密データの取り扱い、設定の不足を評価してください。

  1. ロギングと可観測性を改善する

該当する場合は、安全なロギングやモニタリングとの統合を含め、選択したフレームワーク、設定、プラクティスの変更を実装してください。

  1. 完全なビルドで検証する

改善を適用した後に ./mvnw clean verify または mvn clean verify を実行してください。

リファレンス

詳細なガイダンス、例、制約については、references/181-java-observability-logging.md を参照してください。

コメント