Merge pull request #246 from wafuwafu13/plugin-debug-log

Enable to debug env

Author: yseto

Makefile

@@ -34,6 +34,10 @@ linux:
 docker:
 	docker build -t $(BIN) -t $(BIN):$(VERSION) --target container-agent .
 
+.PHONY: docker-with-plugins
+docker-with-plugins:
+	docker build -t $(BIN) -t $(BIN):$(VERSION) --target container-agent-with-plugins .
+
 .PHONY: version
 version:
 	echo $(VERSION)

check/plugin.go

@@ -2,6 +2,7 @@ package check
 
 import (
 	"context"
+	"strings"
 	"time"
 
 	mackerel "github.com/mackerelio/mackerel-client-go"
@@ -28,6 +29,13 @@ func (g *pluginGenerator) Config() mackerel.CheckConfig {
 // Generate generates check report
 func (g *pluginGenerator) Generate(ctx context.Context) (*Result, error) {
 	now := time.Now()
+	var masked_env []string
+	for _, v := range g.Env {
+		key := strings.Split(v, "=")[0]
+		value := strings.Split(v, "=")[1]
+		masked_env = append(masked_env, key+"="+config.MaskEnvValue(value))
+	}
+	logger.Debugf("plugin %s command: %s env: %+v", g.Name, g.Command, masked_env)
 	stdout, stderr, exitCode, err := cmdutil.RunCommand(ctx, g.Command, g.User, g.Env, g.Timeout)
 
 	if stderr != "" {

cmd/mackerel-container-agent/main.go

@@ -6,6 +6,7 @@ import (
 	"github.com/mackerelio/golib/logging"
 
 	"github.com/mackerelio/mackerel-container-agent/agent"
+	"github.com/mackerelio/mackerel-container-agent/config"
 )
 
 const cmdName = "mackerel-container-agent"
@@ -33,6 +34,28 @@ func main() {
 		logging.SetLogLevel(logging.INFO)
 	}
 
+	logger.Debugf("MACKEREL_APIBASE=%s", config.MaskEnvValue(os.Getenv("MACKEREL_APIBASE")))
+	logger.Debugf("MACKEREL_APIKEY=%s", config.MaskEnvValue(os.Getenv("MACKEREL_APIKEY")))
+
+	env := []string{
+		"MACKEREL_AGENT_CONFIG_POLLING_DURATION_MINUTES",
+		"MACKEREL_AGENT_CONFIG",
+		"MACKEREL_AGENT_PLUGIN_META",
+		"MACKEREL_CONTAINER_PLATFORM",
+		"MACKEREL_HOST_STATUS_ON_START",
+		"MACKEREL_IGNORE_CONTAINER",
+		"MACKEREL_KUBERNETES_KUBELET_HOST",
+		"MACKEREL_KUBERNETES_KUBELET_INSECURE_TLS",
+		"MACKEREL_KUBERNETES_KUBELET_READ_ONLY_PORT",
+		"MACKEREL_KUBERNETES_NAMESPACE",
+		"MACKEREL_KUBERNETES_POD_NAME",
+		"MACKEREL_LOG_LEVEL",
+		"MACKEREL_ROLES",
+	}
+	for _, v := range env {
+		logger.Debugf("%s=%s", v, os.Getenv(v))
+	}
+
 	os.Exit(run(os.Args[1:]))
 }
 

config/env.go

@@ -39,3 +39,12 @@ func buildEnv(envMap map[string]string) ([]string, error) {
 	sort.Strings(env)
 	return env, nil
 }
+
+// MaskEnvValue return masked env value ex) FOOBARBAZ -> FOOB***
+func MaskEnvValue(s string) string {
+	if len(s) < 4 {
+		return s
+	} else {
+		return s[:4] + "***"
+	}
+}

config/env_test.go

@@ -0,0 +1,31 @@
+package config
+
+import (
+	"testing"
+)
+
+func TestMaskEnvValue(t *testing.T) {
+	testCases := []struct {
+		envValue string
+		expect   string
+	}{
+		{
+			envValue: "AAA",
+			expect:   "AAA",
+		},
+		{
+			envValue: "BBBBBBBBBBB",
+			expect:   "BBBB***",
+		},
+		{
+			envValue: "CCC CC",
+			expect:   "CCC ***",
+		},
+	}
+
+	for _, tc := range testCases {
+		if MaskEnvValue(tc.envValue) != tc.expect {
+			t.Fatalf("expect %s, actual %s", tc.expect, MaskEnvValue(tc.envValue))
+		}
+	}
+}

metric/plugin.go

@@ -31,6 +31,13 @@ func NewPluginGenerator(p *config.MetricPlugin) Generator {
 // Generate generates metric values
 func (g *pluginGenerator) Generate(ctx context.Context) (Values, error) {
 	env := append(g.Env, pluginMetaEnvName+"=")
+	var masked_env []string
+	for _, v := range env {
+		key := strings.Split(v, "=")[0]
+		value := strings.Split(v, "=")[1]
+		masked_env = append(masked_env, key+"="+config.MaskEnvValue(value))
+	}
+	logger.Debugf("plugin %s command: %s env: %+v", g.Name, g.Command, masked_env)
 	stdout, stderr, _, err := cmdutil.RunCommand(ctx, g.Command, g.User, env, g.Timeout)
 
 	if stderr != "" {