Removed the legacy env var: LOGXI_FORMAT (#17822)

* Removed the legacy env var: LOGXI_FORMAT * Added changelog * Actually filled in the CL * Added the name of legacy env var
hashicorp · Nov 4, 2022 · 4ec2c6a · 4ec2c6a
1 parent f76ef43
commit 4ec2c6a
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 22 deletions.
diff --git a/changelog/17822.txt b/changelog/17822.txt
@@ -0,0 +1,3 @@
+```release-note:change
+logging: Removed legacy environment variable for log format ('LOGXI_FORMAT'), should use 'VAULT_LOG_FORMAT' instead
+```
diff --git a/command/server.go b/command/server.go
@@ -202,12 +202,10 @@ func (c *ServerCommand) Flags() *FlagSets {
 	})
 
 	f.StringVar(&StringVar{
-		Name:    "log-format",
-		Target:  &c.flagLogFormat,
-		Default: notSetValue,
-		// EnvVar can't be just "VAULT_LOG_FORMAT", because more than one env var name is supported
-		// for backwards compatibility reasons.
-		// See github.com/hashicorp/vault/sdk/helper/logging.ParseEnvLogFormat()
+		Name:       "log-format",
+		Target:     &c.flagLogFormat,
+		Default:    notSetValue,
+		EnvVar:     "VAULT_LOG_FORMAT",
 		Completion: complete.PredictSet("standard", "json"),
 		Usage:      `Log format. Supported values are "standard" and "json".`,
 	})

diff --git a/sdk/helper/logging/logging.go b/sdk/helper/logging/logging.go
@@ -60,16 +60,13 @@ func ParseLogFormat(format string) (LogFormat, error) {
 	case "json":
 		return JSONFormat, nil
 	default:
-		return UnspecifiedFormat, fmt.Errorf("Unknown log format: %s", format)
+		return UnspecifiedFormat, fmt.Errorf("unknown log format: %s", format)
 	}
 }
 
 // ParseEnvLogFormat parses the log format from an environment variable.
 func ParseEnvLogFormat() LogFormat {
 	logFormat := os.Getenv("VAULT_LOG_FORMAT")
-	if logFormat == "" {
-		logFormat = os.Getenv("LOGXI_FORMAT")
-	}
 	switch strings.ToLower(logFormat) {
 	case "json", "vault_json", "vault-json", "vaultjson":
 		return JSONFormat

diff --git a/sdk/helper/logging/logging_test.go b/sdk/helper/logging/logging_test.go
@@ -21,7 +21,7 @@ func Test_ParseLogFormat(t *testing.T) {
 		{format: "STANDARD", expected: StandardFormat, expectedErr: nil},
 		{format: "json", expected: JSONFormat, expectedErr: nil},
 		{format: " json ", expected: JSONFormat, expectedErr: nil},
-		{format: "bogus", expected: UnspecifiedFormat, expectedErr: errors.New("Unknown log format: bogus")},
+		{format: "bogus", expected: UnspecifiedFormat, expectedErr: errors.New("unknown log format: bogus")},
 	}
 
 	for _, test := range tests {
@@ -42,17 +42,6 @@ func Test_ParseEnv_VAULT_LOG_FORMAT(t *testing.T) {
 	testParseEnvLogFormat(t, "VAULT_LOG_FORMAT")
 }
 
-func Test_ParseEnv_LOGXI_FORMAT(t *testing.T) {
-	oldVLF := os.Getenv("VAULT_LOG_FORMAT")
-	defer os.Setenv("VAULT_LOG_FORMAT", oldVLF)
-
-	oldLogxi := os.Getenv("LOGXI_FORMAT")
-	defer os.Setenv("LOGXI_FORMAT", oldLogxi)
-
-	os.Setenv("VAULT_LOG_FORMAT", "")
-	testParseEnvLogFormat(t, "LOGXI_FORMAT")
-}
-
 func testParseEnvLogFormat(t *testing.T, name string) {
 	env := []string{
 		"json", "vauLT_Json", "VAULT-JSON", "vaulTJSon",