Investigate EXTRA_VALUE_AT_END Key Appearing in Various Log Entries

[bflad]

terraform-plugin-log version

v0.2.1

Relevant provider source code

Noticed with tfsdklog usage of protocol logging, may also happen with tfsdk usage.

Expected Behavior

Log entries should not extraneously contain the EXTRA_VALUE_AT_END key, which is injected by hc-log when it detects unpaired (key without value) With usage, unless there is in fact an unpaired thing.

Actual Behavior

Entries such as:

{
    "@caller": "/Users/bflad/go/pkg/mod/github.com/hashicorp/terraform-plugin-go@v0.7.0/internal/logging/protocol.go:21",
    "@level": "trace",
    "@message": "Received request",
    "@module": "sdk.proto",
    "@timestamp": "2022-02-04T16:28:52.602080-05:00",
    "EXTRA_VALUE_AT_END": null,
    "tf_proto_version": "5.2",
    "tf_provider_addr": "",
    "tf_req_id": "a24b8a29-628a-01c2-0516-08b260627109",
    "tf_rpc": "GetProviderSchema"
}

This could be caused by a bug in hc-log, a bug in this Go module, or buggy SDK/provider logger implementations. Let's rule out the first two. 😄

Steps to Reproduce

TF_LOG_SDK_PROTO=trace terraform apply from a provider using terraform-plugin-go@v0.7.0.

[bflad]

With non-JSON output, we can see EXTRA_VALUE_AT_END including information sent with some With() usage:

2022-02-07T15:00:17.921-0500 [TRACE] sdk.proto: Received request: tf_proto_version=5.2 tf_provider_addr=registry.terraform.io/hashicorp/corner tf_req_id=aa835f88-3865-62d8-b5f5-029820bf6cc6 tf_rpc=GetProviderSchema EXTRA_VALUE_AT_END=[]
2022-02-07T15:00:17.921-0500 [TRACE] sdk.proto: Calling downstream: tf_proto_version=5.2 tf_provider_addr=registry.terraform.io/hashicorp/corner tf_req_id=aa835f88-3865-62d8-b5f5-029820bf6cc6 tf_rpc=GetProviderSchema EXTRA_VALUE_AT_END=[]
2022-02-07T15:00:17.921-0500 [TRACE] sdk.helper_schema: Getting provider schema: tf_provider_addr=registry.terraform.io/hashicorp/corner tf_req_id=aa835f88-3865-62d8-b5f5-029820bf6cc6 tf_rpc=GetProviderSchema EXTRA_VALUE_AT_END=[]
2022-02-07T15:00:17.921-0500 [TRACE] sdk.helper_schema: Found resource type: tf_provider_addr=registry.terraform.io/hashicorp/corner tf_req_id=aa835f88-3865-62d8-b5f5-029820bf6cc6 tf_rpc=GetProviderSchema EXTRA_VALUE_AT_END=[tf_resource_type, corner_user_cty]

[bflad]

This is due to errant log helper functions which accept args ...interface{} but pass args (without the ... suffix). We likely should still improve the methods to require a map[string]interface{} so keys will always be paired with values

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.