luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

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
This commit is contained in:
Peter Wilson 2022-11-04 22:16:18 +00:00 committed by GitHub
parent f138d35f8a
commit 469c102fd3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelog/17822.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:change
logging: Removed legacy environment variable for log format ('LOGXI_FORMAT'), should use 'VAULT_LOG_FORMAT' instead
```

4
command/server.go
View File

@ -205,9 +205,7 @@ func (c *ServerCommand) Flags() *FlagSets {
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()
EnvVar: "VAULT_LOG_FORMAT",
Completion: complete.PredictSet("standard", "json"),
Usage: `Log format. Supported values are "standard" and "json".`,
})

5
sdk/helper/logging/logging.go
View File

@ -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

13
sdk/helper/logging/logging_test.go
View File

@ -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",