Terragrunt日志格式演进与自定义配置指南

背景介绍

Terragrunt作为Terraform的封装工具，其日志输出格式在0.67.0版本经历了重大变更。这一改变旨在提供更清晰的日志区分能力，特别是在处理多模块(run-all)场景时。然而，这一变更也带来了与旧版本兼容性的挑战，特别是对于那些已经建立日志解析管道的用户。

版本变更对比

在0.66.9及更早版本中，Terragrunt的日志输出相对简洁：

ERRO[0001] Error finding AWS credentials...

而从0.67.0开始，默认日志格式变为包含时间戳和日志级别的详细格式：

10:23:42.304 ERROR  Error finding AWS credentials...

兼容性解决方案

临时解决方案

目前用户可以通过组合以下两个参数来近似模拟旧版输出：

1. --terragrunt-log-disable - 禁用Terragrunt特有日志
2. --terragrunt-disable-command-validation - 禁用命令验证

但这种方法存在局限性，例如会隐藏关键的AWS认证错误信息。

推荐方案

更完善的解决方案是使用--terragrunt-forward-tf-stdout参数，它能：

• 保持Terraform/OpenTofu原始输出格式
• 同时显示Terragrunt自身的错误信息
• 不丢失关键认证错误等诊断信息

未来改进方向

Terragrunt团队正在设计更灵活的日志控制系统，计划引入：

1. 预设日志格式选项：

   • pretty：当前默认格式（含时间戳和日志级别）
   • json：JSON结构化日志
   • key-value：键值对格式日志
   • naked：原始输出格式（模拟--terragrunt-forward-tf-stdout）

2. 自定义格式字符串： 通过--terragrunt-pretty-log-format参数支持完全自定义的日志格式

设计考量

这种日志系统的重构基于以下技术考量：

1. 一致性原则：确保plan和run-all plan等命令的日志体验一致
2. 可诊断性：明确区分Terragrunt原生日志和转发的Terraform输出
3. 可扩展性：适应从小规模单模块到复杂多模块的各种使用场景
4. 兼容性：通过参数化配置支持不同用户的偏好需求

最佳实践建议

对于不同场景的用户：

1. CI/CD流水线：考虑使用json格式便于日志分析
2. 交互式调试：pretty格式提供最丰富的上下文信息
3. 已有解析系统：使用naked或自定义格式保持向后兼容
4. 多模块管理：默认格式能更好地区分不同模块的输出

随着这一改进的推进，Terragrunt将能更好地平衡日志的丰富性和灵活性，满足不同用户场景的需求。