From 469c102fd3b19f209ae75ee8472fb8a256ffb153 Mon Sep 17 00:00:00 2001 From: Peter Wilson Date: Fri, 4 Nov 2022 22:16:18 +0000 Subject: [PATCH] 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 --- changelog/17822.txt | 3 +++ command/server.go | 10 ++++------ sdk/helper/logging/logging.go | 5 +---- sdk/helper/logging/logging_test.go | 13 +------------ 4 files changed, 9 insertions(+), 22 deletions(-) create mode 100644 changelog/17822.txt diff --git a/changelog/17822.txt b/changelog/17822.txt new file mode 100644 index 000000000..5c39b3c53 --- /dev/null +++ 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 index ee824cc13..ee5b13340 100644 --- 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 index 211a545e3..25de5a781 100644 --- 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 index 3a860d199..91e204b09 100644 --- 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",