feat: add config option to set service explorer attributes

Author: obs-gh-mattcotter

integration/scripts/test_configure.py

@@ -2,12 +2,20 @@
 import utils as u
 
 
-@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 {} --cloud_resource_detectors ec2'.format(
+def init_config_command(env_vars: dict) -> str:
+    return "init-config --token {} --observe_url {} --cloud_resource_detectors ec2 --resource_attributes deployment.environment=test".format(
         env_vars["observe_token"], env_vars["observe_url"]
     )
 
+
+def run_init_config_common(remote_host: u.Host, init_command: str) -> None:
+    # Print the config to be used first
+    result = remote_host.run_command(init_command + " --print")
+    print("Setting agent config:\n{}\n".format("=" * 21))
+    u.print_remote_result(result)
+    if result.exited != 0 or result.stderr:
+        raise ValueError("❌ Error in init-config print")
+
     # Set up correct config with observe url and token
     result = remote_host.run_command(init_command)
     if result.exited != 0 or result.stderr:
@@ -16,30 +24,25 @@ 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 {} --cloud_resource_detectors ec2".format(
-        docker_prefix, env_vars["observe_token"], env_vars["observe_url"]
+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_command(env_vars)
     )
+    run_init_config_common(remote_host, init_command)
 
-    # Set up correct config with observe url and token
-    result = remote_host.run_command(init_command)
-    if result.exited != 0 or result.stderr:
-        u.print_remote_result(result)
-        raise ValueError("❌ Error in init-config")
+
+@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 = docker_prefix + " " + init_config_command(env_vars)
+    run_init_config_common(remote_host, init_command)
 
 
 @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 {} --cloud_resource_detectors ec2".format(
-        env_vars["observe_token"], env_vars["observe_url"]
-    )
-
-    # Set up correct config with observe url and token
-    result = remote_host.run_command(init_command)
-    if result.exited != 0 or result.stderr:
-        u.print_remote_result(result)
-        raise ValueError("❌ Error in init-config")
+    init_command = "sudo observe-agent " + init_config_command(env_vars)
+    run_init_config_common(remote_host, init_command)
 
 
 if __name__ == "__main__":

integration/scripts/test_start.py

@@ -21,15 +21,16 @@ def _check_status_loop(
     Returns:
         bool: agent_status
     """
-
+    sleep_seconds = 1.5
     agent_status = False
+    time.sleep(sleep_seconds)
     for _ in range(start_timeout):
         metrics_dict = defaultdict(list)
         try:
             result = remote_host.run_command(status_command)
         except Exception as e:
             print("Ignoring exception: ", e)
-            time.sleep(1)
+            time.sleep(sleep_seconds)
             continue
         for line in result.stdout.splitlines():
             if ":" in line:
@@ -47,7 +48,7 @@ def _check_status_loop(
                 _ + 1, start_timeout
             )
         )
-        time.sleep(1)
+        time.sleep(sleep_seconds)
     return agent_status
 
 
@@ -65,7 +66,7 @@ def run_test_windows(remote_host: u.Host, env_vars: dict) -> None:
     # status
     start_command = r".\start_agent_windows.ps1"
     status_command = r'Get-Service ObserveAgent;Set-Location "${Env:Programfiles}\Observe\observe-agent"; ./observe-agent status'
-    start_timeout = 30  # how long to wait for observe-agent to start
+    start_timeout = 10  # how many times to check for the running agent
 
     # Get windows home dir paths for consistency
     home_dir = r"/C:/Users/{}".format(env_vars["user"])  # for user in sftp
@@ -82,7 +83,7 @@ def run_test_windows(remote_host: u.Host, env_vars: dict) -> None:
     )  # Eg: sftp to /C:/Users/Adminstrator/install_windows.ps1
     # Run start_agent script
     result = remote_host.run_command(start_command)
-    print(result)
+    u.print_remote_result(result)
 
     if (
         result.stderr
@@ -99,11 +100,12 @@ def run_test_windows(remote_host: u.Host, env_vars: dict) -> None:
 def run_test_docker(remote_host: u.Host, env_vars: dict) -> None:
     docker_prefix = u.get_docker_prefix(remote_host, True)
     start_command = "start"
-    start_timeout = 30  # how long to wait for observe-agent to start
+    start_timeout = 10  # how many times to check for the running agent
 
     # Start Observe Agent
     result = remote_host.run_command(docker_prefix + " " + start_command)
     if result.stderr:
+        u.print_remote_result(result)
         u.die("❌ Error starting observe-agent container")
     else:
         print("✅ Observe Agent started successfully: " + result.stdout)
@@ -131,14 +133,19 @@ def run_test_linux(remote_host: u.Host, env_vars: dict) -> None:
 
     start_command = "sudo systemctl enable --now observe-agent"
     status_command = "observe-agent status"
-    start_timeout = 30  # how long to wait for observe-agent to start
+    start_timeout = 10  # how many times to check for the running agent
 
     # Start Observe Agent
-    remote_host.run_command(start_command)
+    result = remote_host.run_command(start_command)
+    u.print_remote_result(result)
 
     # Check Agent Status
     agent_status = _check_status_loop(remote_host, start_timeout, status_command)
     if not agent_status:
+        # If the agent never started up, try running start to see what the error is. Use unsafe because we expect a non-zero exit code.
+        u.print_remote_result(
+            remote_host.run_command_unsafe("timeout 10s sudo observe-agent start")
+        )
         u.die("❌ Error in Observe Agent Status Test ")
 
 

integration/scripts/utils.py

@@ -168,12 +168,7 @@ def _get_connection(self) -> Connection:
         )
 
     def run_command(self, command) -> Result:
-        try:
-            with self._get_connection() as connection:
-                print("Running `{0}` on {1}".format(command, self.host_ip))
-                result = connection.run(command, warn=True, hide=True)
-        except (socket_error, AuthenticationException) as exc:
-            self._raise_authentication_err(exc)
+        result = self.run_command_unsafe(command)
 
         if result.failed:
             raise ExampleException(
@@ -188,6 +183,16 @@ def run_command(self, command) -> Result:
 
         return result
 
+    def run_command_unsafe(self, command) -> Result:
+        try:
+            with self._get_connection() as connection:
+                print("Running `{0}` on {1}".format(command, self.host_ip))
+                result = connection.run(command, warn=True, hide=True)
+        except (socket_error, AuthenticationException) as exc:
+            self._raise_authentication_err(exc)
+
+        return result
+
     def put_file(self, local_path, remote_path) -> None:
         try:
             with self._get_connection() as connection:

internal/commands/initconfig/initconfig.go

@@ -18,6 +18,7 @@ var (
 	token                                   string
 	observe_url                             string
 	cloud_resource_detectors                []string
+	resource_attributes                     map[string]string
 	self_monitoring_enabled                 bool
 	host_monitoring_enabled                 bool
 	host_monitoring_logs_enabled            bool
@@ -83,6 +84,9 @@ func RegisterConfigFlags(cmd *cobra.Command, v *viper.Viper) {
 	cmd.PersistentFlags().StringSliceVar(&cloud_resource_detectors, "cloud_resource_detectors", []string{}, "The cloud environments from which to detect resources")
 	v.BindPFlag("cloud_resource_detectors", cmd.PersistentFlags().Lookup("cloud_resource_detectors"))
 
+	cmd.PersistentFlags().StringToStringVar(&resource_attributes, "resource_attributes", map[string]string{}, "The cloud environments from which to detect resources")
+	v.BindPFlag("resource_attributes", cmd.PersistentFlags().Lookup("resource_attributes"))
+
 	cmd.PersistentFlags().BoolVar(&self_monitoring_enabled, "self_monitoring::enabled", true, "Enable self monitoring")
 	v.BindPFlag("self_monitoring::enabled", cmd.PersistentFlags().Lookup("self_monitoring::enabled"))
 	v.SetDefault("self_monitoring::enabled", true)

internal/config/configschema.go

@@ -73,6 +73,8 @@ type AgentConfig struct {
 	ObserveURL             string                  `yaml:"observe_url" mapstructure:"observe_url"`
 	CloudResourceDetectors []string                `yaml:"cloud_resource_detectors,omitempty" mapstructure:"cloud_resource_detectors"`
 	Debug                  bool                    `yaml:"debug,omitempty" mapstructure:"debug"`
+	Attributes             map[string]string       `yaml:"attributes,omitempty" mapstructure:"attributes"`
+	ResourceAttributes     map[string]string       `yaml:"resource_attributes,omitempty" mapstructure:"resource_attributes"`
 	HealthCheck            HealthCheckConfig       `yaml:"health_check" mapstructure:"health_check"`
 	Forwarding             ForwardingConfig        `yaml:"forwarding" mapstructure:"forwarding"`
 	InternalTelemetry      InternalTelemetryConfig `yaml:"internal_telemetry" mapstructure:"internal_telemetry"`
@@ -81,6 +83,14 @@ type AgentConfig struct {
 	OtelConfigOverrides    map[string]any          `yaml:"otel_config_overrides,omitempty" mapstructure:"otel_config_overrides"`
 }
 
+func (config *AgentConfig) HasAttributes() bool {
+	return len(config.Attributes) > 0
+}
+
+func (config *AgentConfig) HasResourceAttributes() bool {
+	return len(config.ResourceAttributes) > 0
+}
+
 func SetViperDefaults(v *viper.Viper, separator string) {
 	var config AgentConfig
 	defaults.SetDefaults(&config)

internal/connections/allconnectiontypes.go

@@ -23,6 +23,12 @@ var CommonConnectionType = MakeConnectionType(
 			},
 			colConfigFilePath: "base.yaml.tmpl",
 		},
+		{
+			enabledCheck: func(agentConfig *config.AgentConfig) bool {
+				return agentConfig.HasAttributes() || agentConfig.HasResourceAttributes()
+			},
+			colConfigFilePath: "attributes.yaml.tmpl",
+		},
 		{
 			enabledCheck: func(agentConfig *config.AgentConfig) bool {
 				return agentConfig.Forwarding.Enabled

packaging/docker/observe-agent/connections/common/attributes.yaml.tmpl

@@ -0,0 +1,19 @@
+processors:
+  {{- if .HasAttributes }}
+  attributes/observe_global_attributes:
+    actions:
+    {{- range $key, $value := .Attributes }}
+      - key: {{ $key }}
+        value: {{ $value }}
+        action: insert
+    {{- end }}
+  {{- end }}
+  {{- if .HasResourceAttributes }}
+  resource/observe_global_resource_attributes:
+    attributes:
+    {{- range $key, $value := .ResourceAttributes }}
+      - key: {{ $key }}
+        value: {{ $value }}
+        action: insert
+    {{- end }}
+  {{- end }}

packaging/docker/observe-agent/connections/common/base.yaml.tmpl

@@ -38,7 +38,7 @@ processors:
         host.id:
           enabled: false
         os.type:
-           enabled: true
+          enabled: true
         host.arch:
           enabled: true
         host.name:

packaging/docker/observe-agent/connections/common/forward.yaml.tmpl

@@ -23,15 +23,41 @@ service:
   pipelines:
     metrics/forward:
       receivers: [otlp]
-      processors: [resourcedetection, resourcedetection/cloud, deltatocumulative, batch]
+      processors:
+        - resourcedetection
+        - resourcedetection/cloud
+        - deltatocumulative
+        {{- if .HasAttributes }}
+        - attributes/observe_global_attributes
+        {{- end }}
+        {{- if .HasResourceAttributes }}
+        - resource/observe_global_resource_attributes
+        {{- end }}
+        - batch
       exporters: [prometheusremotewrite/observe]
 
     logs/forward:
       receivers: [otlp]
-      processors: [resourcedetection, resourcedetection/cloud]
+      processors:
+        - resourcedetection
+        - resourcedetection/cloud
+        {{- if .HasAttributes }}
+        - attributes/observe_global_attributes
+        {{- end }}
+        {{- if .HasResourceAttributes }}
+        - resource/observe_global_resource_attributes
+        {{- end }}
       exporters: [otlphttp/observe, count]
 
     traces/forward:
       receivers: [otlp]
-      processors: [resourcedetection, resourcedetection/cloud]
+      processors:
+        - resourcedetection
+        - resourcedetection/cloud
+        {{- if .HasAttributes }}
+        - attributes/observe_global_attributes
+        {{- end }}
+        {{- if .HasResourceAttributes }}
+        - resource/observe_global_resource_attributes
+        {{- end }}
       exporters: [otlphttp/observetracing]

packaging/docker/observe-agent/connections/host_monitoring/host.yaml.tmpl

@@ -8,6 +8,16 @@ receivers:
 service:
   pipelines:
     metrics/agent-filestats:
-       receivers: [filestats/agent]
-       processors: [resourcedetection, resourcedetection/cloud]
-       exporters: [prometheusremotewrite/observe]
+      receivers: [filestats/agent]
+      processors:
+        - memory_limiter
+        - resourcedetection
+        - resourcedetection/cloud
+        {{- if .HasAttributes }}
+        - attributes/observe_global_attributes
+        {{- end }}
+        {{- if .HasResourceAttributes }}
+        - resource/observe_global_resource_attributes
+        {{- end }}
+        - batch
+      exporters: [prometheusremotewrite/observe]