如何在自定义Terraform Provider中获取Terraform版本用于错误输出？

核心逻辑 #

Terraform的Provider SDK会在Provider初始化阶段自动传递当前运行的Terraform版本信息，你只需要在Provider配置阶段捕获并保存这个版本号，后续遇到异常时将其拼接进错误消息即可。

基于terraform-plugin-sdk/v2的实现步骤 #

1. 定义客户端结构体存储版本

在Provider代码中定义一个客户端结构体，用来保存Terraform版本（以及其他业务所需的配置字段）：

type MyProviderClient struct {
    TerraformVersion string
    // 其他配置字段，比如API密钥、服务端点等
}

2. 在Configure阶段捕获版本

实现Provider的ConfigureContextFunc，从请求参数中提取Terraform版本并保存到客户端：

func providerConfigure(ctx context.Context, req *schema.ConnRequest, resp *schema.ConnResponse) {
    // 从ConnRequest中直接获取Terraform版本
    client := &MyProviderClient{
        TerraformVersion: req.TerraformVersion,
        // 初始化其他业务配置
    }
    resp.ResourceData.Set("client", client)
}

3. 异常时拼接版本到错误信息

在资源的Create/Read/Update/Delete等操作中，一旦出现错误，从客户端结构体取出版本号拼接进诊断信息：

func resourceMyResourceCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
    client := meta.(*MyProviderClient)
    var diags diag.Diagnostics

    // 模拟业务操作失败场景
    err := someBusinessOperation()
    if err != nil {
        diags = append(diags, diag.Diagnostic{
            Severity: diag.Error,
            Summary:  "资源创建失败",
            Detail: fmt.Sprintf("执行业务操作出错: %v\n运行的Terraform版本: %s", err, client.TerraformVersion),
        })
        return diags
    }

    // 正常业务逻辑...
    return diags
}

基于terraform-plugin-framework的实现（新SDK） #

如果使用较新的terraform-plugin-framework，步骤类似：

1. 定义Provider结构体

type MyProvider struct {
    TerraformVersion string
}

2. 在Configure阶段保存版本

func (p *MyProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) {
    // 直接从请求中获取并保存Terraform版本
    p.TerraformVersion = req.TerraformVersion
    // 初始化其他业务配置
}

3. 异常时输出带版本的错误

在资源操作方法中，通过Provider实例获取版本并拼接错误信息：

func (r *MyResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
    var data MyResourceModel
    resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
    if resp.Diagnostics.HasError() {
        return
    }

    provider, ok := req.ProviderData.(*MyProvider)
    if !ok {
        resp.Diagnostics.AddError(
            "Provider类型错误",
            "无法获取Provider实例，无法读取Terraform版本",
        )
        return
    }

    // 模拟业务失败场景
    err := someBusinessOperation()
    if err != nil {
        resp.Diagnostics.AddError(
            "资源创建失败",
            fmt.Sprintf("执行业务操作出错: %v\nTerraform版本: %s", err, provider.TerraformVersion),
        )
        return
    }

    // 正常业务逻辑...
    resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}

最终效果 #

当Provider抛出错误时，Terraform会将包含版本信息的错误输出到标准错误，示例如下：

Error: 资源创建失败

  with myprovider_my_resource.example,
  on main.tf line 10, in resource "myprovider_my_resource" "example":
  10: resource "myprovider_my_resource" "example" {

执行业务操作出错: 连接超时
Terraform版本: 1.5.7

用户可以直接复制这段信息发送给支持团队。

内容的提问来源于stack exchange，提问作者Phyxx