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. 01审查 Java 项目的日志实践
  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。

评论

支持 Markdown