chore: improve terraform logging

Author: smintz

main.go

@@ -9,6 +9,7 @@ import (
 	"os/exec"
 	"os/signal"
 	"path/filepath"
+	"strings"
 	"syscall"
 
 	"github.com/avast/retry-go"
@@ -29,15 +30,24 @@ import (
 
 var (
 	logger = hclog.New(&hclog.LoggerOptions{
-		Name:  "eggpack-terraform-plugin",
-		Level: hclog.Info,
+		Name:       "eggpack-terraform-plugin",
+		Level:      hclog.Info,
+		JSONFormat: true,
 	})
 	cliConfig = &config.TerraformPluginConfig{
 		AgentAddress: ":4300",
 		ConfigPath:   "test/main",
+		LogLevel:     config.TerraformPluginConfig_LOG_LEVEL_INFO,
 	}
 )
 
+func tfLogStr() string {
+	if cliConfig.LogAsJson {
+		return "TF_LOG=JSON"
+	}
+	return "TF_LOG=" + strings.TrimPrefix(cliConfig.LogLevel.String(), "LOG_LEVEL_")
+}
+
 func runTerraform(ctx context.Context, key string, tf *dynamic.Message) error {
 	root, err := filepath.Abs(cliConfig.TerraformRoot)
 	if err != nil {
@@ -58,13 +68,19 @@ func runTerraform(ctx context.Context, key string, tf *dynamic.Message) error {
 		return err
 	}
 	l.Info("running terraform init")
-	cmd := exec.Command("terraform", "-chdir="+workDir, "init")
+	cmd := exec.CommandContext(ctx, "terraform", "-chdir="+workDir, "init")
+	cmd.Env = os.Environ()
+	cmd.Env = append(cmd.Env, tfLogStr())
+	cmd.Stderr = os.Stderr
 	if err = cmd.Run(); err != nil {
 		l.Error("failed to run terraform init", "error", err)
 		return err
 	}
 	l.Info("running terraform apply")
-	cmd = exec.Command("terraform", "-chdir="+workDir, "apply", "-auto-approve")
+	cmd = exec.CommandContext(ctx, "terraform", "-chdir="+workDir, "apply", "-auto-approve")
+	cmd.Env = os.Environ()
+	cmd.Env = append(cmd.Env, tfLogStr())
+	cmd.Stderr = os.Stderr
 	if err = cmd.Run(); err != nil {
 		l.Error("failed to run terraform apply", "error", err)
 		return err
@@ -87,6 +103,11 @@ func main() {
 	if flagset.Parse(os.Args[1:]) != nil {
 		logger.Error("failed to parse flag data")
 	}
+	logger = hclog.New(&hclog.LoggerOptions{
+		Name:       "eggpack-terraform-plugin",
+		Level:      hclog.Level(cliConfig.LogLevel),
+		JSONFormat: cliConfig.LogAsJson,
+	})
 
 	parser := &protoparse.Parser{ImportPaths: []string{"src", ""}}
 	descriptors, err := parser.ParseFiles("terraform/v1/terraform.proto")

proto/protoconf_terraform/config/v1/config.pb.go

@@ -8,6 +8,34 @@ message TerraformPluginConfig {
     string agent_address = 1 [json_name = "agent-address"];
     string config_path = 2 [json_name = "config-path"];
     string terraform_root = 3;
+    LogLevel log_level = 4;
+    bool log_as_json = 5;
+
+    enum LogLevel {
+        // NoLevel is a special level used to indicate that no level has been
+        // set and allow for a default to be used.
+        LOG_LEVEL_UNSPECIFIED = 0;
+
+        // Trace is the most verbose level. Intended to be used for the tracing
+        // of actions in code, such as function enters/exits, etc.
+        LOG_LEVEL_TRACE = 1;
+
+        // Debug information for programmer low-level analysis.
+        LOG_LEVEL_DEBUG = 2;
+
+        // Info information about steady state operations.
+        LOG_LEVEL_INFO = 3;
+
+        // Warn information about rare but handled events.
+        LOG_LEVEL_WARN = 4;
+
+        // Error information about unrecoverable events.
+        LOG_LEVEL_ERROR = 5;
+
+        // Off disables all logging output.
+        LOG_LEVEL_OFF = 6;
+
+    }
 }
 
 message SubscriptionConfig {