Skip to content
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

Jump to bottom

fix: fix whitespace typo when customizing CloudResourceDetectors #136

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: fix whitespace typo when customizing CloudResourceDetectors #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b20f984
fix: fix whitespace typo when customizing CloudResourceDetectors
obs-gh-mattcotter Nov 23, 2024
043bad2
fix unit test
obs-gh-mattcotter Nov 23, 2024
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
6 changes: 3 additions & 3 deletions integration/scripts/test_configure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

@u.print_test_decorator
def run_test_windows(remote_host: u.Host, env_vars: dict) -> None:
init_command = r'Set-Location "C:\Program Files\Observe\observe-agent"; ./observe-agent init-config --token {} --observe_url {}'.format(
init_command = r'Set-Location "C:\Program Files\Observe\observe-agent"; ./observe-agent init-config --token {} --observe_url {} --cloud_resource_detectors ec2'.format(
env_vars["observe_token"], env_vars["observe_url"]
)

Expand All @@ -18,7 +18,7 @@ def run_test_windows(remote_host: u.Host, env_vars: dict) -> None:
@u.print_test_decorator
def run_test_docker(remote_host: u.Host, env_vars: dict) -> None:
docker_prefix = u.get_docker_prefix(remote_host, False)
init_command = "{} init-config --token {} --observe_url {}".format(
init_command = "{} init-config --token {} --observe_url {} --cloud_resource_detectors ec2".format(
docker_prefix, env_vars["observe_token"], env_vars["observe_url"]
)

Expand All @@ -31,7 +31,7 @@ def run_test_docker(remote_host: u.Host, env_vars: dict) -> None:

@u.print_test_decorator
def run_test_linux(remote_host: u.Host, env_vars: dict) -> None:
init_command = "sudo observe-agent init-config --token {} --observe_url {}".format(
init_command = "sudo observe-agent init-config --token {} --observe_url {} --cloud_resource_detectors ec2".format(
env_vars["observe_token"], env_vars["observe_url"]
)

Expand Down
48 changes: 27 additions & 21 deletions internal/commands/initconfig/initconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ var (
config_path string
token string
observe_url string
cloud_resource_detectors []string
self_monitoring_enabled bool
host_monitoring_enabled bool
host_monitoring_logs_enabled bool
Expand All @@ -33,6 +34,7 @@ const configTemplate = "observe-agent.tmpl"
type FlatAgentConfig struct {
Token string
ObserveURL string
CloudResourceDetectors []string
SelfMonitoring_Enabled bool
HostMonitoring_Enabled bool
HostMonitoring_LogsEnabled bool
Expand All @@ -41,29 +43,30 @@ type FlatAgentConfig struct {
HostMonitoring_Metrics_ProcessEnabled bool
}

func NewConfigureCmd() *cobra.Command {
func NewConfigureCmd(v *viper.Viper) *cobra.Command {
return &cobra.Command{
Use: "init-config",
Short: "Initialize agent configuration",
Long: `This command takes in parameters and creates an initialized observe agent configuration file. Will overwrite existing config file and should only be used to initialize.`,
RunE: func(cmd *cobra.Command, args []string) error {
configValues := FlatAgentConfig{
Token: viper.GetString("token"),
ObserveURL: viper.GetString("observe_url"),
SelfMonitoring_Enabled: viper.GetBool("self_monitoring::enabled"),
HostMonitoring_Enabled: viper.GetBool("host_monitoring::enabled"),
HostMonitoring_LogsEnabled: viper.GetBool("host_monitoring::logs::enabled"),
HostMonitoring_Metrics_HostEnabled: viper.GetBool("host_monitoring::metrics::host::enabled"),
HostMonitoring_Metrics_ProcessEnabled: viper.GetBool("host_monitoring::metrics::process::enabled"),
Token: v.GetString("token"),
ObserveURL: v.GetString("observe_url"),
CloudResourceDetectors: v.GetStringSlice("cloud_resource_detectors"),
SelfMonitoring_Enabled: v.GetBool("self_monitoring::enabled"),
HostMonitoring_Enabled: v.GetBool("host_monitoring::enabled"),
HostMonitoring_LogsEnabled: v.GetBool("host_monitoring::logs::enabled"),
HostMonitoring_Metrics_HostEnabled: v.GetBool("host_monitoring::metrics::host::enabled"),
HostMonitoring_Metrics_ProcessEnabled: v.GetBool("host_monitoring::metrics::process::enabled"),
}
if configValues.HostMonitoring_LogsEnabled {
configValues.HostMonitoring_LogsInclude = viper.GetStringSlice("host_monitoring::logs::include")
configValues.HostMonitoring_LogsInclude = v.GetStringSlice("host_monitoring::logs::include")
}
var outputPath string
if config_path != "" {
outputPath = config_path
} else {
outputPath = viper.ConfigFileUsed()
outputPath = v.ConfigFileUsed()
}
f, err := os.Create(outputPath)
if err != nil {
Expand All @@ -81,27 +84,30 @@ func NewConfigureCmd() *cobra.Command {
}

func init() {
configureCmd := NewConfigureCmd()
RegisterConfigFlags(configureCmd)
v := viper.GetViper()
configureCmd := NewConfigureCmd(v)
RegisterConfigFlags(configureCmd, v)
root.RootCmd.AddCommand(configureCmd)
}

func RegisterConfigFlags(cmd *cobra.Command) {
func RegisterConfigFlags(cmd *cobra.Command, v *viper.Viper) {
cmd.Flags().StringVarP(&config_path, "config_path", "", "", "Path to write config output file to")
cmd.PersistentFlags().StringVar(&token, "token", "", "Observe token")
cmd.PersistentFlags().StringVar(&observe_url, "observe_url", "", "Observe data collection url")
cmd.PersistentFlags().StringSliceVar(&cloud_resource_detectors, "cloud_resource_detectors", []string{}, "Cloud resource detectors")
cmd.PersistentFlags().BoolVar(&self_monitoring_enabled, "self_monitoring::enabled", true, "Enable self monitoring")
cmd.PersistentFlags().BoolVar(&host_monitoring_enabled, "host_monitoring::enabled", true, "Enable host monitoring")
cmd.PersistentFlags().BoolVar(&host_monitoring_logs_enabled, "host_monitoring::logs::enabled", true, "Enable host monitoring logs")
cmd.PersistentFlags().StringSliceVar(&host_monitoring_logs_include, "host_monitoring::logs::include", nil, "Set host monitoring log include paths")
cmd.PersistentFlags().BoolVar(&host_monitoring_metrics_host_enabled, "host_monitoring::metrics::host::enabled", true, "Enable host monitoring host metrics")
cmd.PersistentFlags().BoolVar(&host_monitoring_metrics_process_enabled, "host_monitoring::metrics::process::enabled", false, "Enable host monitoring process metrics")
viper.BindPFlag("token", cmd.PersistentFlags().Lookup("token"))
viper.BindPFlag("observe_url", cmd.PersistentFlags().Lookup("observe_url"))
viper.BindPFlag("self_monitoring::enabled", cmd.PersistentFlags().Lookup("self_monitoring::enabled"))
viper.BindPFlag("host_monitoring::enabled", cmd.PersistentFlags().Lookup("host_monitoring::enabled"))
viper.BindPFlag("host_monitoring::logs::enabled", cmd.PersistentFlags().Lookup("host_monitoring::logs::enabled"))
viper.BindPFlag("host_monitoring::logs::include", cmd.PersistentFlags().Lookup("host_monitoring::logs::include"))
viper.BindPFlag("host_monitoring::metrics::host::enabled", cmd.PersistentFlags().Lookup("host_monitoring::metrics::host::enabled"))
viper.BindPFlag("host_monitoring::metrics::process::enabled", cmd.PersistentFlags().Lookup("host_monitoring::metrics::process::enabled"))
v.BindPFlag("token", cmd.PersistentFlags().Lookup("token"))
v.BindPFlag("observe_url", cmd.PersistentFlags().Lookup("observe_url"))
v.BindPFlag("cloud_resource_detectors", cmd.PersistentFlags().Lookup("cloud_resource_detectors"))
v.BindPFlag("self_monitoring::enabled", cmd.PersistentFlags().Lookup("self_monitoring::enabled"))
v.BindPFlag("host_monitoring::enabled", cmd.PersistentFlags().Lookup("host_monitoring::enabled"))
v.BindPFlag("host_monitoring::logs::enabled", cmd.PersistentFlags().Lookup("host_monitoring::logs::enabled"))
v.BindPFlag("host_monitoring::logs::include", cmd.PersistentFlags().Lookup("host_monitoring::logs::include"))
v.BindPFlag("host_monitoring::metrics::host::enabled", cmd.PersistentFlags().Lookup("host_monitoring::metrics::host::enabled"))
v.BindPFlag("host_monitoring::metrics::process::enabled", cmd.PersistentFlags().Lookup("host_monitoring::metrics::process::enabled"))
}
6 changes: 4 additions & 2 deletions internal/commands/initconfig/initconfig_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"testing"

"github.com/observeinc/observe-agent/internal/config"
"github.com/spf13/viper"
"github.com/stretchr/testify/assert"
"gopkg.in/yaml.v2"
)
Expand Down Expand Up @@ -67,8 +68,9 @@ func Test_InitConfigCommand(t *testing.T) {
expectErr: "",
},
}
initConfigCmd := NewConfigureCmd()
RegisterConfigFlags(initConfigCmd)
v := viper.New()
initConfigCmd := NewConfigureCmd(v)
RegisterConfigFlags(initConfigCmd, v)
for _, tc := range testcases {
initConfigCmd.SetArgs(tc.args)
err := initConfigCmd.Execute()
Expand Down
7 changes: 7 additions & 0 deletions internal/commands/initconfig/observe-agent.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ observe_url: {{ .ObserveURL }}
# Debug mode - Sets agent log level to debug
debug: false

{{ if .CloudResourceDetectors -}}
cloud_resource_detectors:
{{- range .CloudResourceDetectors }}
- {{ . }}
{{- end }}
{{- end }}

self_monitoring:
enabled: {{ .SelfMonitoring_Enabled }}

Expand Down
2 changes: 1 addition & 1 deletion internal/connections/templatefuncs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func TplInlineArray[T any](arr []T) string {
for i := range arr {
strs[i] = TmplValueToYaml(arr[i])
}
return "[" + strings.Join(strs, ",") + "]"
return "[" + strings.Join(strs, ", ") + "]"
}

func TmplValueToYaml(value any) string {
Expand Down
6 changes: 3 additions & 3 deletions internal/connections/templatefuncs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ func TestTmplValueToYaml(t *testing.T) {

func TestTplInlineArray(t *testing.T) {
strSlice := []string{"a", "b", "c", "y"}
assert.Equal(t, "[a,b,c,\"y\"]", TplInlineArray(strSlice))
assert.Equal(t, "[a, b, c, \"y\"]", TplInlineArray(strSlice))

intSlice := []int{1, 2, 3}
assert.Equal(t, "[1,2,3]", TplInlineArray(intSlice))
assert.Equal(t, "[1, 2, 3]", TplInlineArray(intSlice))

strIntSlice := []any{"a", 1, "b", 2}
assert.Equal(t, "[a,1,b,2]", TplInlineArray(strIntSlice))
assert.Equal(t, "[a, 1, b, 2]", TplInlineArray(strIntSlice))
}

func TestTplToYaml(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion internal/connections/test/testHelloWorld.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
string: hello world
in-line-array: [1,2,3]
in-line-array: [1, 2, 3]
multi-line-array:
- 4
- 5
Expand Down
2 changes: 1 addition & 1 deletion packaging/docker/observe-agent/otel-collector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ processors:
resourcedetection/cloud:
detectors:
{{- if .CloudResourceDetectors }}
{{- inlineArrayStr .CloudResourceDetectors }}
{{- " " }}{{ inlineArrayStr .CloudResourceDetectors }}
{{- else }} ["gcp", "ecs", "ec2", "azure"]
{{- end }}
timeout: 2s
Expand Down
2 changes: 1 addition & 1 deletion packaging/linux/etc/observe-agent/otel-collector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ processors:
resourcedetection/cloud:
detectors:
{{- if .CloudResourceDetectors }}
{{- inlineArrayStr .CloudResourceDetectors }}
{{- " " }}{{ inlineArrayStr .CloudResourceDetectors }}
{{- else }} ["gcp", "ecs", "ec2", "azure"]
{{- end }}
timeout: 2s
Expand Down
2 changes: 1 addition & 1 deletion packaging/macos/config/otel-collector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ processors:
resourcedetection/cloud:
detectors:
{{- if .CloudResourceDetectors }}
{{- inlineArrayStr .CloudResourceDetectors }}
{{- " " }}{{ inlineArrayStr .CloudResourceDetectors }}
{{- else }} ["gcp", "ecs", "ec2", "azure"]
{{- end }}
timeout: 2s
Expand Down
2 changes: 1 addition & 1 deletion packaging/windows/config/otel-collector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ processors:
resourcedetection/cloud:
detectors:
{{- if .CloudResourceDetectors }}
{{- inlineArrayStr .CloudResourceDetectors }}
{{- " " }}{{ inlineArrayStr .CloudResourceDetectors }}
{{- else }} ["gcp", "ecs", "ec2", "azure"]
{{- end }}
timeout: 2s
Expand Down
Loading