Skip to content
This repository has been archived by the owner on Aug 30, 2019. It is now read-only.

internal/config: add DD_APM_ prefixed env. vars duplicates #552

Merged
merged 3 commits into from
Jan 3, 2019
Merged

internal/config: add DD_APM_ prefixed env. vars duplicates #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2fbc7e
internal/config: add DD_APM_ prefixed env. vars duplicates
gbbr Jan 3, 2019
dee53e8
address comments: use ordered sequence for overriding and add tests
gbbr Jan 3, 2019
55c67cc
Merge branch 'master' into gbbr/env
gbbr Jan 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 36 additions & 24 deletions internal/config/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,45 @@ import (
func applyEnv() {
// Warning: do not use BindEnv to bind config variables. They will be overriden
// when using the legacy config loader.
for envKey, cfgKey := range map[string]string{
"DD_SITE": "site",
"DD_API_KEY": "api_key",
"DD_HOSTNAME": "hostname",
"DD_BIND_HOST": "bind_host",
"DD_DOGSTATSD_PORT": "dogstatsd_port",
"DD_LOG_LEVEL": "log_level",
"DD_CONNECTION_LIMIT": "apm_config.connection_limit",
"DD_APM_ENABLED": "apm_config.enabled",
"DD_APM_ENV": "apm_config.env",
"DD_APM_NON_LOCAL_TRAFFIC": "apm_config.apm_non_local_traffic",
"DD_APM_DD_URL": "apm_config.apm_dd_url",
"DD_RECEIVER_PORT": "apm_config.receiver_port",
"DD_MAX_EPS": "apm_config.max_events_per_second",
"DD_MAX_TPS": "apm_config.max_traces_per_second",
"HTTPS_PROXY": "proxy.https",
"DD_PROXY_HTTPS": "proxy.https",
for _, override := range []struct{ env, key string }{
// Core agent:
gbbr marked this conversation as resolved.
Show resolved Hide resolved
{"DD_SITE", "site"},
{"DD_API_KEY", "api_key"},
{"DD_HOSTNAME", "hostname"},
{"DD_BIND_HOST", "bind_host"},
{"DD_DOGSTATSD_PORT", "dogstatsd_port"},
{"DD_LOG_LEVEL", "log_level"},
{"HTTPS_PROXY", "proxy.https"}, // deprecated
{"DD_PROXY_HTTPS", "proxy.https"},

// APM specific:
{"DD_CONNECTION_LIMIT", "apm_config.connection_limit"}, // deprecated
{"DD_APM_CONNECTION_LIMIT", "apm_config.connection_limit"},
{"DD_APM_ENABLED", "apm_config.enabled"},
{"DD_APM_ENV", "apm_config.env"},
{"DD_APM_NON_LOCAL_TRAFFIC", "apm_config.apm_non_local_traffic"},
{"DD_APM_DD_URL", "apm_config.apm_dd_url"},
{"DD_RECEIVER_PORT", "apm_config.receiver_port"}, // deprecated
{"DD_APM_RECEIVER_PORT", "apm_config.receiver_port"},
{"DD_MAX_EPS", "apm_config.max_events_per_second"}, // deprecated
{"DD_APM_MAX_EPS", "apm_config.max_events_per_second"},
{"DD_MAX_TPS", "apm_config.max_traces_per_second"}, // deprecated
{"DD_APM_MAX_TPS", "apm_config.max_traces_per_second"},
} {
if v := os.Getenv(envKey); v != "" {
config.Datadog.Set(cfgKey, v)
if v := os.Getenv(override.env); v != "" {
config.Datadog.Set(override.key, v)
}
}
if v := os.Getenv("DD_IGNORE_RESOURCE"); v != "" {
if r, err := splitString(v, ','); err != nil {
log.Warn("%q value not loaded: %v", "DD_IGNORE_RESOURCE", err)
} else {
config.Datadog.Set("apm_config.ignore_resources", r)
for _, envKey := range []string{
"DD_IGNORE_RESOURCE", // deprecated
"DD_APM_IGNORE_RESOURCES",
} {
if v := os.Getenv(envKey); v != "" {
if r, err := splitString(v, ','); err != nil {
log.Warn("%q value not loaded: %v", envKey, err)
} else {
config.Datadog.Set("apm_config.ignore_resources", r)
}
}
}
if v := os.Getenv("DD_APM_ANALYZED_SPANS"); v != "" {
Expand Down
150 changes: 100 additions & 50 deletions internal/config/env_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"os"
"testing"

"github.com/DataDog/datadog-agent/pkg/config"
log "github.com/cihub/seelog"
"github.com/stretchr/testify/assert"
)
Expand All @@ -14,6 +15,35 @@ func TestMain(m *testing.M) {
}

func TestLoadEnv(t *testing.T) {
t.Run("overrides", func(t *testing.T) {
// tests that newer envs. override deprecated ones
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

for _, tt := range []struct {
envOld, envNew, key string
}{
{"HTTPS_PROXY", "DD_PROXY_HTTPS", "proxy.https"},
{"DD_CONNECTION_LIMIT", "DD_APM_CONNECTION_LIMIT", "apm_config.connection_limit"},
{"DD_RECEIVER_PORT", "DD_APM_RECEIVER_PORT", "apm_config.receiver_port"},
{"DD_MAX_EPS", "DD_MAX_EPS", "apm_config.max_events_per_second"},
{"DD_MAX_TPS", "DD_APM_MAX_TPS", "apm_config.max_traces_per_second"},
{"DD_IGNORE_RESOURCE", "DD_APM_IGNORE_RESOURCES", "apm_config.ignore_resources"},
} {
assert := assert.New(t)
err := os.Setenv(tt.envOld, "1,2,3")
assert.NoError(err)
defer os.Unsetenv(tt.envOld)
err = os.Setenv(tt.envNew, "4,5,6")
assert.NoError(err)
defer os.Unsetenv(tt.envNew)
_, err = Load("./testdata/full.yaml")
assert.NoError(err)
if tt.envNew == "DD_APM_IGNORE_RESOURCES" {
assert.Equal([]string{"4", "5", "6"}, config.Datadog.GetStringSlice(tt.key))
} else {
assert.Equal("4,5,6", config.Datadog.Get(tt.key))
}
}
})

for _, ext := range []string{"yaml", "ini"} {
t.Run(ext, func(t *testing.T) {
env := "DD_API_KEY"
Expand Down Expand Up @@ -104,16 +134,20 @@ func TestLoadEnv(t *testing.T) {
assert.Equal("bindhost.com", cfg.StatsdHost)
})

env = "DD_RECEIVER_PORT"
t.Run(env, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(env, "1234")
assert.NoError(err)
defer os.Unsetenv(env)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(1234, cfg.ReceiverPort)
})
for _, envKey := range []string{
"DD_RECEIVER_PORT", // deprecated
"DD_APM_RECEIVER_PORT",
} {
t.Run(envKey, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(envKey, "1234")
assert.NoError(err)
defer os.Unsetenv(envKey)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(1234, cfg.ReceiverPort)
})
}

env = "DD_DOGSTATSD_PORT"
t.Run(env, func(t *testing.T) {
Expand All @@ -137,16 +171,20 @@ func TestLoadEnv(t *testing.T) {
assert.Equal("0.0.0.0", cfg.ReceiverHost)
})

env = "DD_IGNORE_RESOURCE"
t.Run(env, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(env, "1,2,3")
assert.NoError(err)
defer os.Unsetenv(env)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal([]string{"1", "2", "3"}, cfg.Ignore["resource"])
})
for _, envKey := range []string{
"DD_IGNORE_RESOURCE", // deprecated
"DD_APM_IGNORE_RESOURCES",
} {
t.Run(envKey, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(envKey, "1,2,3")
assert.NoError(err)
defer os.Unsetenv(envKey)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal([]string{"1", "2", "3"}, cfg.Ignore["resource"])
})
}

env = "DD_LOG_LEVEL"
t.Run(env, func(t *testing.T) {
Expand All @@ -173,38 +211,50 @@ func TestLoadEnv(t *testing.T) {
}, cfg.AnalyzedSpansByService)
})

env = "DD_CONNECTION_LIMIT"
t.Run(env, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(env, "50")
assert.NoError(err)
defer os.Unsetenv(env)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(50, cfg.ConnectionLimit)
})
for _, envKey := range []string{
"DD_CONNECTION_LIMIT", // deprecated
"DD_APM_CONNECTION_LIMIT",
} {
t.Run(envKey, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(envKey, "50")
assert.NoError(err)
defer os.Unsetenv(envKey)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(50, cfg.ConnectionLimit)
})
}

env = "DD_MAX_TPS"
t.Run(env, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(env, "6")
assert.NoError(err)
defer os.Unsetenv(env)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(6., cfg.MaxTPS)
})
for _, envKey := range []string{
"DD_MAX_TPS", // deprecated
"DD_APM_MAX_TPS",
} {
t.Run(envKey, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(envKey, "6")
assert.NoError(err)
defer os.Unsetenv(envKey)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(6., cfg.MaxTPS)
})
}

env = "DD_MAX_EPS"
t.Run(env, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(env, "7")
assert.NoError(err)
defer os.Unsetenv(env)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(7., cfg.MaxEPS)
})
for _, envKey := range []string{
"DD_MAX_EPS", // deprecated
"DD_APM_MAX_EPS",
} {
t.Run(envKey, func(t *testing.T) {
assert := assert.New(t)
err := os.Setenv(envKey, "7")
assert.NoError(err)
defer os.Unsetenv(envKey)
cfg, err := Load("./testdata/full." + ext)
assert.NoError(err)
assert.Equal(7., cfg.MaxEPS)
})
}
})
}
}