Terragrunt日志格式定制：简化terraform命令显示

Terragrunt作为Terraform的包装工具，在大型基础设施项目中广受欢迎。它提供了灵活的日志格式定制功能，允许用户根据需求调整日志输出格式。本文将重点介绍如何通过日志格式定制来简化terraform命令的显示。

日志格式定制需求背景

在实际使用Terragrunt时，用户经常会看到类似init -reconfigure -backend=false这样的完整命令输出。虽然这些信息对于调试很有帮助，但在日常操作中，用户可能只需要知道当前执行的是哪个terraform命令阶段（如init、plan或apply），而不需要关心具体的参数细节。

解决方案：%tf-command占位符

最新版本的Terragrunt(v0.71.2)引入了%tf-command占位符，专门用于解决这个问题。与原有的%tf-command-args不同，这个新的占位符只会显示terraform的基础命令名称，而不会包含任何参数。

使用方法

要使用这个功能，只需在运行terragrunt命令时指定--terragrunt-log-custom-format参数，并在格式字符串中包含%tf-command：

terragrunt apply --terragrunt-log-custom-format "[%tf-command] %message"

这样配置后，日志输出将只显示[apply]而不是完整的apply -auto-approve等详细信息。

实际应用场景

1. 简化日志阅读：在CI/CD流水线中，开发者可以快速识别当前执行阶段
2. 减少视觉干扰：当参数较多时，避免日志行过长影响可读性
3. 统一日志格式：在多环境部署时保持日志格式一致性

高级配置建议

对于团队协作项目，建议在terragrunt配置文件中预设日志格式：

terraform {
  extra_arguments "custom_logs" {
    commands = ["init", "plan", "apply"]
    arguments = ["-terragrunt-log-custom-format", "[%tf-command] %message"]
  }
}

这种配置方式可以确保团队所有成员使用相同的日志格式，无需每次手动指定参数。

总结

Terragrunt的日志格式定制功能为基础设施管理提供了更好的可观察性。通过使用新的%tf-command占位符，用户可以更清晰地了解terraform命令的执行流程，同时保持日志的简洁性。这一改进特别适合需要频繁查看日志的大型项目或自动化部署场景。