set APM global labels as a map

elastic · Sep 1, 2023 · 88eb548 · 88eb548
1 parent 3175a13
commit 88eb548
Show file tree

Hide file tree

Showing 3 changed files with 164 additions and 7 deletions.
diff --git a/internal/pkg/core/monitoring/config/config.go b/internal/pkg/core/monitoring/config/config.go
@@ -66,12 +66,12 @@ func DefaultConfig() *MonitoringConfig {
 
 // APMConfig configures APM Tracing.
 type APMConfig struct {
-	Environment  string   `config:"environment"`
-	APIKey       string   `config:"api_key"`
-	SecretToken  string   `config:"secret_token"`
-	Hosts        []string `config:"hosts"`
-	GlobalLabels string   `config:"global_labels"`
-	TLS          APMTLS   `config:"tls"`
+	Environment  string            `config:"environment"`
+	APIKey       string            `config:"api_key"`
+	SecretToken  string            `config:"secret_token"`
+	Hosts        []string          `config:"hosts"`
+	GlobalLabels map[string]string `config:"global_labels"`
+	TLS          APMTLS            `config:"tls"`
 }
 
 // APMTLS contains the configuration options necessary for configuring TLS in

diff --git a/pkg/component/runtime/apm_config_mapper.go b/pkg/component/runtime/apm_config_mapper.go
@@ -5,6 +5,9 @@
 package runtime
 
 import (
+	"sort"
+	"strings"
+
 	"github.com/elastic/elastic-agent-client/v7/pkg/proto"
 
 	"github.com/elastic/elastic-agent/internal/pkg/core/monitoring/config"
@@ -23,7 +26,7 @@ func MapAPMConfig(conf *config.APMConfig) *proto.APMConfig {
 		ApiKey:       conf.APIKey,
 		SecretToken:  conf.SecretToken,
 		Hosts:        append([]string{}, conf.Hosts...),
-		GlobalLabels: conf.GlobalLabels,
+		GlobalLabels: buildGlobalLabelsString(conf.GlobalLabels),
 	}
 
 	if conf.TLS != zeroElasticAPMTLS {
@@ -37,3 +40,31 @@ func MapAPMConfig(conf *config.APMConfig) *proto.APMConfig {
 
 	return &proto.APMConfig{Elastic: elasticAPMConf}
 }
+
+func buildGlobalLabelsString(labels map[string]string) string {
+	const separator = ","
+
+	if len(labels) == 0 {
+		return ""
+	}
+
+	//prepare sorted keys to make output deterministic
+	keys := make([]string, 0, len(labels))
+	for k := range labels {
+		keys = append(keys, k)
+	}
+
+	sort.Strings(keys)
+
+	// create the key=value string
+	buf := new(strings.Builder)
+	for _, k := range keys {
+		if buf.Len() > 0 {
+			buf.WriteString(separator)
+		}
+		buf.WriteString(k)
+		buf.WriteString("=")
+		buf.WriteString(labels[k])
+	}
+	return buf.String()
+}
diff --git a/pkg/component/runtime/apm_config_mapper_test.go b/pkg/component/runtime/apm_config_mapper_test.go
@@ -0,0 +1,126 @@
+package runtime
+
+import (
+	"testing"
+
+	"github.com/elastic/elastic-agent-client/v7/pkg/proto"
+	"github.com/stretchr/testify/assert"
+
+	"github.com/elastic/elastic-agent/internal/pkg/core/monitoring/config"
+)
+
+func TestMapAPMConfig(t *testing.T) {
+	type args struct {
+		conf *config.APMConfig
+	}
+	tests := []struct {
+		name string
+		args args
+		want *proto.APMConfig
+	}{
+		{
+			name: "nil config",
+			args: args{
+				conf: nil,
+			},
+			want: nil,
+		},
+		{
+			name: "full config",
+			args: args{
+				conf: &config.APMConfig{
+					Environment:  "environment",
+					APIKey:       "apikey",
+					SecretToken:  "secrettoken",
+					Hosts:        []string{"host1", "host2"},
+					GlobalLabels: map[string]string{"k1": "v1", "k2": "v2"},
+					TLS: config.APMTLS{
+						SkipVerify:        true,
+						ServerCertificate: "servercertificate",
+						ServerCA:          "serverca",
+					},
+				},
+			},
+			want: &proto.APMConfig{
+				Elastic: &proto.ElasticAPM{
+					Tls: &proto.ElasticAPMTLS{
+						SkipVerify: true,
+						ServerCert: "servercertificate",
+						ServerCa:   "serverca",
+					},
+					Environment:  "environment",
+					ApiKey:       "apikey",
+					SecretToken:  "secrettoken",
+					Hosts:        []string{"host1", "host2"},
+					GlobalLabels: "k1=v1,k2=v2",
+				},
+			},
+		},
+		{
+			name: "config without global labels",
+			args: args{
+				conf: &config.APMConfig{
+					Environment:  "environment",
+					APIKey:       "apikey",
+					SecretToken:  "secrettoken",
+					Hosts:        []string{"host1", "host2"},
+					GlobalLabels: nil,
+					TLS: config.APMTLS{
+						SkipVerify:        true,
+						ServerCertificate: "servercertificate",
+						ServerCA:          "serverca",
+					},
+				},
+			},
+			want: &proto.APMConfig{
+				Elastic: &proto.ElasticAPM{
+					Tls: &proto.ElasticAPMTLS{
+						SkipVerify: true,
+						ServerCert: "servercertificate",
+						ServerCa:   "serverca",
+					},
+					Environment:  "environment",
+					ApiKey:       "apikey",
+					SecretToken:  "secrettoken",
+					Hosts:        []string{"host1", "host2"},
+					GlobalLabels: "",
+				},
+			},
+		},
+		{
+			name: "config without hosts",
+			args: args{
+				conf: &config.APMConfig{
+					Environment:  "environment",
+					APIKey:       "apikey",
+					SecretToken:  "secrettoken",
+					GlobalLabels: map[string]string{"k1": "v1", "k2": "v2"},
+					TLS: config.APMTLS{
+						SkipVerify:        true,
+						ServerCertificate: "servercertificate",
+						ServerCA:          "serverca",
+					},
+				},
+			},
+			want: &proto.APMConfig{
+				Elastic: &proto.ElasticAPM{
+					Tls: &proto.ElasticAPMTLS{
+						SkipVerify: true,
+						ServerCert: "servercertificate",
+						ServerCa:   "serverca",
+					},
+					Environment:  "environment",
+					ApiKey:       "apikey",
+					SecretToken:  "secrettoken",
+					Hosts:        []string{},
+					GlobalLabels: "k1=v1,k2=v2",
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equalf(t, tt.want, MapAPMConfig(tt.args.conf), "MapAPMConfig(%v)", tt.args.conf)
+		})
+	}
+}