feat: add all bundled otel config to the observe-agent binary instead of relying on files on disk

Author: obs-gh-mattcotter

.goreleaser.yaml

@@ -24,6 +24,16 @@ builds:
       - linux
     ldflags: -s -w -X github.com/observeinc/observe-agent/build.Version={{.Version}}
 
+  - id: docker_build
+    binary: observe-agent
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+    flags:
+      - -tags=docker
+    ldflags: -s -w -X github.com/observeinc/observe-agent/build.Version={{.Version}}
+
   - id: mac_build
     binary: observe-agent
     env:
@@ -59,8 +69,6 @@ archives:
       # The default agent config file and the service file live in config.
       - src: "packaging/linux/config/*"
         dst: "."
-      - src: "packaging/linux/connections/*"
-        dst: "connections"
 
   - id: windows
     formats: ["zip"]
@@ -75,8 +83,6 @@ archives:
     files:
       - src: "packaging/windows/observe-agent.yaml"
         dst: "observe-agent.yaml"
-      - src: "packaging/windows/connections/*"
-        dst: "connections"
 
   - id: macos
     formats: ["zip"]
@@ -120,6 +126,8 @@ changelog:
 nfpms:
   - id: linux
 
+    ids: [linux_build]
+
     package_name: observe-agent
 
     # You can change the file name of the package.
@@ -162,10 +170,6 @@ nfpms:
     # Contents to add to the package.
     # GoReleaser will automatically add the binaries.
     contents:
-      - src: packaging/linux/connections
-        dst: /etc/observe-agent/connections
-        type: tree
-
       - src: packaging/linux/config/observe-agent.yaml
         dst: /etc/observe-agent/observe-agent.yaml
         type: config|noreplace
@@ -200,6 +204,7 @@ dockers:
     use: buildx
     goos: linux
     goarch: amd64
+    ids: [docker_build]
     build_flag_templates:
       - "--platform=linux/amd64"
     extra_files:
@@ -211,6 +216,7 @@ dockers:
     use: buildx
     goos: linux
     goarch: arm64
+    ids: [docker_build]
     build_flag_templates:
       - "--platform=linux/arm64/v8"
     extra_files:

Makefile

@@ -31,7 +31,7 @@ build:
 	go build ./...
 
 docker-image:
-	env GOOS=linux GOARCH=arm64 go build -o observe-agent
+	env GOOS=linux GOARCH=arm64 go build -tags docker -o observe-agent
 	docker build -f packaging/docker/Dockerfile -t observe-agent:dev .
 
 ## test: Runs Go tests across all packages

internal/commands/config/config_test.go

@@ -6,6 +6,7 @@ package config
 import (
 	"bytes"
 	"context"
+	"embed"
 	"os"
 	"path"
 	"path/filepath"
@@ -15,6 +16,7 @@ import (
 
 	"github.com/observeinc/observe-agent/internal/commands/util/logger"
 	"github.com/observeinc/observe-agent/internal/connections"
+	"github.com/observeinc/observe-agent/internal/connections/bundledconfig"
 	"github.com/observeinc/observe-agent/internal/root"
 	"github.com/observeinc/observe-agent/observecol"
 	"github.com/spf13/pflag"
@@ -88,7 +90,8 @@ func runSnapshotTest(t *testing.T, test snapshotTest) {
 
 	// Set the template base dir for all connections
 	for _, conn := range connections.AllConnectionTypes {
-		conn.ApplyOptions(connections.WithConfigFolderPath(getPackagingPath(t, test.packageType, curPath)))
+		// TODO
+		conn.ApplyOptions(connections.WithConfigTemplateOverrides(getTemplateOverrides(t, test.packageType, curPath)))
 	}
 
 	// Set config flags
@@ -111,16 +114,19 @@ func runSnapshotTest(t *testing.T, test snapshotTest) {
 	assert.Equal(t, strings.TrimSpace(string(expected)), strings.TrimSpace(output.String()))
 }
 
-func getPackagingPath(t *testing.T, packageType PackageType, curPath string) string {
-	const packagingPath = "../../../packaging"
+func getTemplateOverrides(t *testing.T, packageType PackageType, curPath string) map[string]embed.FS {
 	switch packageType {
-	case MacOS, Linux, Windows:
-		return filepath.Join(curPath, packagingPath, string(packageType), "connections")
+	case MacOS:
+		return bundledconfig.MacOSTemplateFS
+	case Linux:
+		return bundledconfig.LinuxTemplateFS
+	case Windows:
+		return bundledconfig.WindowsTemplateFS
 	case Docker:
-		return filepath.Join(curPath, packagingPath, "docker/observe-agent/connections")
+		return bundledconfig.DockerTemplateFS
 	default:
 		t.Errorf("Unknown package type: %s", packageType)
-		return ""
+		return nil
 	}
 }
 

internal/commands/status/status.go

@@ -49,7 +49,7 @@ func getStatusFromTemplate(v *viper.Viper) error {
 		return err
 	}
 	t := template.Must(template.New(statusTemplate).
-		Funcs(connections.GetTemplateFuncMap()).
+		Funcs(connections.TemplateFuncMap).
 		ParseFS(statusTemplateFS, statusTemplate))
 	if err := t.ExecuteTemplate(os.Stdout, statusTemplate, data); err != nil {
 		return err

internal/connections/allconnectiontypes.go

@@ -15,7 +15,7 @@ var CommonConnectionType = MakeConnectionType(
 	func(_ *config.AgentConfig) bool {
 		return true
 	},
-	[]CollectorConfigFragment{
+	[]BundledConfigFragment{
 		{
 			enabledCheck: func(_ *config.AgentConfig) bool {
 				// Always include the base connection.
@@ -55,7 +55,7 @@ var HostMonitoringConnectionType = MakeConnectionType(
 	func(agentConfig *config.AgentConfig) bool {
 		return agentConfig.HostMonitoring.Enabled
 	},
-	[]CollectorConfigFragment{
+	[]BundledConfigFragment{
 		{
 			enabledCheck: func(agentConfig *config.AgentConfig) bool {
 				// TODO remove this deprecated template
@@ -89,7 +89,7 @@ var SelfMonitoringConnectionType = MakeConnectionType(
 	func(agentConfig *config.AgentConfig) bool {
 		return agentConfig.SelfMonitoring.Enabled
 	},
-	[]CollectorConfigFragment{
+	[]BundledConfigFragment{
 		{
 			enabledCheck: func(agentConfig *config.AgentConfig) bool {
 				return agentConfig.SelfMonitoring.Enabled

internal/connections/bundledconfig/bundledconfig.go

@@ -0,0 +1,46 @@
+package bundledconfig
+
+import (
+	"embed"
+
+	"github.com/observeinc/observe-agent/internal/connections/bundledconfig/docker"
+	"github.com/observeinc/observe-agent/internal/connections/bundledconfig/linux"
+	"github.com/observeinc/observe-agent/internal/connections/bundledconfig/shared"
+	"github.com/observeinc/observe-agent/internal/connections/bundledconfig/windows"
+)
+
+// TODO break up some of the larger connections in order to share more configs.
+var SharedTemplateFS = map[string]embed.FS{
+	"common/attributes.yaml.tmpl":                shared.AttributesTemplateFS,
+	"common/internal_telemetry.yaml.tmpl":        shared.InternalTelemetryTemplateFS,
+	"common/health_check.yaml.tmpl":              shared.HealthCheckTemplateFS,
+	"common/base.yaml.tmpl":                      shared.BaseTemplateFS,
+	"common/forward.yaml.tmpl":                   shared.ForwardTemplateFS,
+	"host_monitoring/logs.yaml.tmpl":             shared.LogsTemplateFS,
+	"host_monitoring/host_metrics.yaml.tmpl":     shared.HostMetricsTemplateFS,
+	"host_monitoring/host.yaml.tmpl":             shared.HostTemplateFS,
+	"host_monitoring/process_metrics.yaml.tmpl":  shared.ProcessMetricsTemplateFS,
+	"self_monitoring/logs_and_metrics.yaml.tmpl": shared.LogsAndMetricsTemplateFS,
+}
+
+var DockerTemplateFS = map[string]embed.FS{
+	"common/base.yaml.tmpl":                      docker.BaseTemplateFS,
+	"host_monitoring/logs.yaml.tmpl":             docker.LogsTemplateFS,
+	"host_monitoring/host_metrics.yaml.tmpl":     docker.HostMetricsTemplateFS,
+	"host_monitoring/process_metrics.yaml.tmpl":  docker.ProcessMetricsTemplateFS,
+	"self_monitoring/logs_and_metrics.yaml.tmpl": docker.LogsAndMetricsTemplateFS,
+}
+
+var LinuxTemplateFS = map[string]embed.FS{
+	"host_monitoring/logs.yaml.tmpl":             linux.LogsTemplateFS,
+	"host_monitoring/host_metrics.yaml.tmpl":     linux.HostMetricsTemplateFS,
+	"self_monitoring/logs_and_metrics.yaml.tmpl": linux.LogsAndMetricsTemplateFS,
+}
+
+var MacOSTemplateFS = map[string]embed.FS{}
+
+var WindowsTemplateFS = map[string]embed.FS{
+	"common/base.yaml.tmpl":                  windows.BaseTemplateFS,
+	"host_monitoring/logs.yaml.tmpl":         windows.LogsTemplateFS,
+	"host_monitoring/host_metrics.yaml.tmpl": windows.HostMetricsTemplateFS,
+}

packaging/docker/observe-agent/connections/common/base.yaml.tmpl renamed to internal/connections/bundledconfig/docker/common/base.yaml.tmpl

@@ -1,3 +1,4 @@
+{{- /* Forked from the default due to cgroup extensions */ -}}
 extensions:
   file_storage:
     directory: ${env:FILESTORAGE_PATH}

packaging/docker/observe-agent/connections/host_monitoring/host_metrics.yaml.tmpl renamed to internal/connections/bundledconfig/docker/host_monitoring/host_metrics.yaml.tmpl

@@ -1,3 +1,4 @@
+{{- /* Forked from the default due to hostfs root path */ -}}
 receivers:
   hostmetrics/host-monitoring-host:
     collection_interval: 60s
@@ -26,6 +27,7 @@ receivers:
           system.filesystem.utilization:
             enabled: true
       network:
+        {{- /* TODO: add system.network.conntrack metrics, copy from the shared file */}}
       paging:
         metrics:
           system.paging.utilization:

packaging/docker/observe-agent/connections/host_monitoring/logs.yaml.tmpl renamed to internal/connections/bundledconfig/docker/host_monitoring/logs.yaml.tmpl

@@ -1,3 +1,4 @@
+{{- /* Forked from the default due to hostfs root path and journald receiver */ -}}
 receivers:
   filelog/host_monitoring:
     include:

packaging/docker/observe-agent/connections/host_monitoring/process_metrics.yaml.tmpl renamed to internal/connections/bundledconfig/docker/host_monitoring/process_metrics.yaml.tmpl

@@ -1,3 +1,4 @@
+{{- /* Forked from the default due to hostfs root path */ -}}
 receivers:
   hostmetrics/host-monitoring-process:
     collection_interval: 60s