Rename opampAgent fields for clarity

Author: jade-guiton-dd

extension/opampextension/opamp_agent.go

@@ -56,12 +56,12 @@ type opampAgent struct {
 	cfg    *Config
 	logger *zap.Logger
 
-	agentType       string
-	agentVersion    string
-	agentInstanceID string
-	resourceAttrs   map[string]string
+	serviceName       string
+	serviceVersion    string
+	serviceInstanceID string
+	resourceAttrs     map[string]string
 
-	instanceID uuid.UUID
+	instanceUID uuid.UUID
 
 	eclk            sync.RWMutex
 	effectiveConfig *confmap.Conf
@@ -134,7 +134,7 @@ func (o *opampAgent) Start(ctx context.Context, host component.Host) error {
 		HeaderFunc:     headerFunc,
 		TLSConfig:      tls,
 		OpAMPServerURL: o.cfg.Server.GetEndpoint(),
-		InstanceUid:    types.InstanceUid(o.instanceID),
+		InstanceUid:    types.InstanceUid(o.instanceUID),
 		Callbacks: types.Callbacks{
 			OnConnect: func(_ context.Context) {
 				o.logger.Debug("Connected to the OpAMP server")
@@ -283,24 +283,24 @@ func (o *opampAgent) updateEffectiveConfig(conf *confmap.Conf) {
 }
 
 func newOpampAgent(cfg *Config, set extension.Settings) (*opampAgent, error) {
-	agentType := set.BuildInfo.Command
+	serviceName := set.BuildInfo.Command
 
 	sn, ok := set.Resource.Attributes().Get(string(conventions.ServiceNameKey))
 	if ok {
-		agentType = sn.AsString()
+		serviceName = sn.AsString()
 	}
 
-	agentVersion := set.BuildInfo.Version
+	serviceVersion := set.BuildInfo.Version
 
 	sv, ok := set.Resource.Attributes().Get(string(conventions.ServiceVersionKey))
 	if ok {
-		agentVersion = sv.AsString()
+		serviceVersion = sv.AsString()
 	}
 
-	agentInstanceID := ""
+	serviceInstanceID := ""
 
 	if sid, ok := set.Resource.Attributes().Get(string(conventions.ServiceInstanceIDKey)); ok {
-		agentInstanceID = sid.Str()
+		serviceInstanceID = sid.Str()
 	}
 
 	var uid uuid.UUID
@@ -328,10 +328,10 @@ func newOpampAgent(cfg *Config, set extension.Settings) (*opampAgent, error) {
 	agent := &opampAgent{
 		cfg:                      cfg,
 		logger:                   set.Logger,
-		agentType:                agentType,
-		agentVersion:             agentVersion,
-		agentInstanceID:          agentInstanceID,
-		instanceID:               uid,
+		serviceName:              serviceName,
+		serviceVersion:           serviceVersion,
+		serviceInstanceID:        serviceInstanceID,
+		instanceUID:              uid,
 		capabilities:             cfg.Capabilities,
 		opampClient:              opampClient,
 		resourceAttrs:            resourceAttrs,
@@ -381,9 +381,9 @@ func (o *opampAgent) createAgentDescription() error {
 	description := getOSDescription(o.logger)
 
 	ident := []*protobufs.KeyValue{
-		stringKeyValue(string(conventions.ServiceInstanceIDKey), o.agentInstanceID),
-		stringKeyValue(string(conventions.ServiceNameKey), o.agentType),
-		stringKeyValue(string(conventions.ServiceVersionKey), o.agentVersion),
+		stringKeyValue(string(conventions.ServiceInstanceIDKey), o.serviceInstanceID),
+		stringKeyValue(string(conventions.ServiceNameKey), o.serviceName),
+		stringKeyValue(string(conventions.ServiceVersionKey), o.serviceVersion),
 	}
 
 	// Initially construct using a map to properly deduplicate any keys that
@@ -425,9 +425,9 @@ func (o *opampAgent) createAgentDescription() error {
 
 func (o *opampAgent) updateAgentIdentity(instanceID uuid.UUID) {
 	o.logger.Debug("OpAMP agent identity is being changed",
-		zap.String("old_id", o.instanceID.String()),
+		zap.String("old_id", o.instanceUID.String()),
 		zap.String("new_id", instanceID.String()))
-	o.instanceID = instanceID
+	o.instanceUID = instanceID
 }
 
 func (o *opampAgent) composeEffectiveConfig() *protobufs.EffectiveConfig {

extension/opampextension/opamp_agent_test.go

@@ -41,9 +41,9 @@ func TestNewOpampAgent(t *testing.T) {
 	set.BuildInfo = component.BuildInfo{Version: "test version", Command: "otelcoltest"}
 	o, err := newOpampAgent(cfg.(*Config), set)
 	assert.NoError(t, err)
-	assert.Equal(t, "otelcoltest", o.agentType)
-	assert.Equal(t, "test version", o.agentVersion)
-	assert.NotEmpty(t, o.instanceID.String())
+	assert.Equal(t, "otelcoltest", o.serviceName)
+	assert.Equal(t, "test version", o.serviceVersion)
+	assert.NotEmpty(t, o.instanceUID.String())
 	assert.True(t, o.capabilities.ReportsEffectiveConfig)
 	assert.True(t, o.capabilities.ReportsHealth)
 	assert.Empty(t, o.effectiveConfig)
@@ -60,9 +60,9 @@ func TestNewOpampAgentAttributes(t *testing.T) {
 	set.Resource.Attributes().PutStr("service.instance.id", "f8999bc1-4c9b-4619-9bae-7f009d2411ec")
 	o, err := newOpampAgent(cfg.(*Config), set)
 	assert.NoError(t, err)
-	assert.Equal(t, "otelcol-distro", o.agentType)
-	assert.Equal(t, "distro.0", o.agentVersion)
-	assert.Equal(t, "f8999bc1-4c9b-4619-9bae-7f009d2411ec", o.agentInstanceID)
+	assert.Equal(t, "otelcol-distro", o.serviceName)
+	assert.Equal(t, "distro.0", o.serviceVersion)
+	assert.Equal(t, "f8999bc1-4c9b-4619-9bae-7f009d2411ec", o.serviceInstanceID)
 	assert.NoError(t, o.Shutdown(t.Context()))
 }
 
@@ -196,14 +196,14 @@ func TestUpdateAgentIdentity(t *testing.T) {
 	o, err := newOpampAgent(cfg.(*Config), set)
 	assert.NoError(t, err)
 
-	olduid := o.instanceID
+	olduid := o.instanceUID
 	assert.NotEmpty(t, olduid.String())
 
 	uid := uuid.Must(uuid.NewV7())
 	assert.NotEqual(t, uid, olduid)
 
 	o.updateAgentIdentity(uid)
-	assert.Equal(t, o.instanceID, uid)
+	assert.Equal(t, o.instanceUID, uid)
 	assert.NoError(t, o.Shutdown(t.Context()))
 }
 
@@ -990,9 +990,9 @@ func newTestOpampAgent(cfg *Config, set extension.Settings, mockOpampClient *moc
 	o := &opampAgent{
 		cfg:                      cfg,
 		logger:                   set.Logger,
-		agentType:                set.BuildInfo.Command,
-		agentVersion:             set.BuildInfo.Version,
-		instanceID:               uid,
+		serviceName:              set.BuildInfo.Command,
+		serviceVersion:           set.BuildInfo.Version,
+		instanceUID:              uid,
 		capabilities:             cfg.Capabilities,
 		opampClient:              mockOpampClient,
 		statusSubscriptionWg:     &sync.WaitGroup{},