Skip to content

fix: allow OTEL_CONFIG_OVERRIDES env var to replace agent config overrides #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2024
Merged

fix: allow OTEL_CONFIG_OVERRIDES env var to replace agent config overrides #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion internal/commands/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ OTEL configuration.`,
fmt.Printf("# ======== computed agent config\n")
fmt.Println(string(viperConfigYaml) + "\n")
agentConfig := viper.ConfigFileUsed()
configFilePaths = append([]string{agentConfig}, configFilePaths...)
if agentConfig != "" {
configFilePaths = append([]string{agentConfig}, configFilePaths...)
}
for _, filePath := range configFilePaths {
file, err := os.ReadFile(filePath)
if err != nil {
Expand Down
5 changes: 1 addition & 4 deletions internal/commands/start/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,10 @@ func SetupAndGetConfigFiles(ctx context.Context) ([]string, func(), error) {
if err != nil {
return nil, nil, err
}
configFilePaths, overridePath, err := connections.GetAllOtelConfigFilePaths(ctx, tmpDir)
cleanup := func() {
if overridePath != "" {
os.Remove(overridePath)
}
os.RemoveAll(tmpDir)
}
configFilePaths, err := connections.GetAllOtelConfigFilePaths(ctx, tmpDir)
if err != nil {
cleanup()
return nil, nil, err
Expand Down
56 changes: 40 additions & 16 deletions internal/connections/confighandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,34 @@ import (
logger "github.com/observeinc/observe-agent/internal/commands/util"
"github.com/observeinc/observe-agent/internal/config"
"github.com/spf13/viper"
"gopkg.in/yaml.v3"
)

func GetAllOtelConfigFilePaths(ctx context.Context, tmpDir string) ([]string, string, error) {
const (
OTEL_OVERRIDE_YAML_KEY = "otel_config_overrides"
)

func GetAllOtelConfigFilePaths(ctx context.Context, tmpDir string) ([]string, error) {
configFilePaths := []string{}
// If the default otel-collector.yaml exists, add it to the list of config files
defaultOtelConfigPath := filepath.Join(GetDefaultConfigFolder(), "otel-collector.yaml")
if _, err := os.Stat(defaultOtelConfigPath); err == nil {
agentConf, err := config.AgentConfigFromViper(viper.GetViper())
if err != nil {
return nil, "", err
return nil, err
}
otelConfigRendered, err := RenderConfigTemplate(ctx, tmpDir, defaultOtelConfigPath, agentConf)
if err != nil {
return nil, "", err
return nil, err
}
configFilePaths = append(configFilePaths, otelConfigRendered)
}
var err error
// Get additional config paths based on connection configs
for _, conn := range AllConnectionTypes {
if viper.IsSet(conn.Name) {
connectionPaths, err := conn.GetConfigFilePaths(ctx, tmpDir)
if err != nil {
return nil, "", err
return nil, err
}
configFilePaths = append(configFilePaths, connectionPaths...)
}
Expand All @@ -44,16 +48,32 @@ func GetAllOtelConfigFilePaths(ctx context.Context, tmpDir string) ([]string, st
configFilePaths = append(configFilePaths, viper.GetString("otelConfigFile"))
}
// Generate override file and include path if overrides provided
var overridePath string
if viper.IsSet("otel_config_overrides") {
overridePath, err = GetOverrideConfigFile(viper.Sub("otel_config_overrides"))
if err != nil {
return configFilePaths, overridePath, err
if viper.IsSet(OTEL_OVERRIDE_YAML_KEY) {
// GetStringMap is more lenient with respect to conversions than Sub, which only handles maps.
overrides := viper.GetStringMap(OTEL_OVERRIDE_YAML_KEY)
if len(overrides) == 0 {
stringData := viper.GetString(OTEL_OVERRIDE_YAML_KEY)
// If this was truly set to empty, then ignore it.
if stringData != "" {
// Viper can handle overrides set in the agent config, or passed in as an env var as a JSON string.
// For consistency, we also want to accept an env var as a YAML string.
err := yaml.Unmarshal([]byte(stringData), &overrides)
Copy link
Collaborator

Choose a reason for hiding this comment

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

does this handle nested configs correctly? we have a different delimiter :: for nested keys

Copy link
Collaborator

Choose a reason for hiding this comment

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

https://opentelemetry.io/docs/collector/configuration/#override-settings similar to how otel does it (this is because there can be periods within a key name in the config so that overloads '.' as the delimiter

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The file in this case if full YAML, this was requested here: https://observeinc.slack.com/archives/C06MM0MSHPA/p1730998713772329?thread_ts=1730939763.831879&cid=C06MM0MSHPA

$ cat tmp.yml 
processors:
  probabilistic_sampler:
    sampling_percentage: 50.0

service:
  pipelines:
    logs/forward:
      receivers: [otlp]
      processors: [probabilistic_sampler]
      exporters: [debug]

if err != nil {
return nil, fmt.Errorf("%s was provided but could not be parsed", OTEL_OVERRIDE_YAML_KEY)
}
}
}
// Only create the config file if there are overrides present (ie ignore empty maps)
if len(overrides) != 0 {
overridePath, err := GetOverrideConfigFile(tmpDir, overrides)
if err != nil {
return nil, err
}
configFilePaths = append(configFilePaths, overridePath)
}
configFilePaths = append(configFilePaths, overridePath)
}
logger.FromCtx(ctx).Debug(fmt.Sprint("Config file paths:", configFilePaths))
return configFilePaths, overridePath, nil
return configFilePaths, nil
}

func SetEnvVars() error {
Expand All @@ -75,14 +95,18 @@ func SetEnvVars() error {
return nil
}

func GetOverrideConfigFile(sub *viper.Viper) (string, error) {
f, err := os.CreateTemp("", "otel-config-overrides-*.yaml")
func GetOverrideConfigFile(tmpDir string, data map[string]any) (string, error) {
f, err := os.CreateTemp(tmpDir, "otel-config-overrides-*.yaml")
if err != nil {
return "", fmt.Errorf("failed to create config file to write to: %w", err)
}
err = sub.WriteConfigAs(f.Name())
contents, err := yaml.Marshal(data)
if err != nil {
return "", fmt.Errorf("failed to marshal otel config overrides: %w", err)
}
_, err = f.Write([]byte(contents))
if err != nil {
return f.Name(), fmt.Errorf("failed to write otel config overrides to file: %w", err)
return "", fmt.Errorf("failed to write otel config overrides to file: %w", err)
}
return f.Name(), nil
}
Expand Down
Loading