👋 , I have been trying to get familiar with the spec and the current implementation.

Some sub-messages are always updated for next message about opamp-go HOT 4 CLOSED

open-telemetry commented on June 18, 2024

Some sub-messages are always updated for next message

from opamp-go.

Comments (4)

tigrannajaryan commented on June 18, 2024

the client implementation does it only for RemoteConfigStatus and PackageStatuses not for the EffectiveConfig, AgentHealth and AgentDescription. I was wondering if there was reason behind this?

The client implementation compresses all these messages. See NextMessage.PopPending implementation. Once the message is popped and sent these fields are unset and will be only set in the next message if they are modified via NextMessage.Update.

from opamp-go.

srikanthccv commented on June 18, 2024

Thanks, that was helpful. I think my original question should have been more clear. Should the client push update to NextMessage even if there was no change and schedule send.

I am looking at this implementation b/w SetAgentDescription and SetRemoteConfigStatus.

opamp-go/client/internal/clientcommon.go

Lines 226 to 241 in 63c9165

 // SetAgentDescription sends a status update to the Server with the new AgentDescription 

 // and remembers the AgentDescription in the client state so that it can be sent 

 // to the Server when the Server asks for it. 

 func (c *ClientCommon) SetAgentDescription(descr *protobufs.AgentDescription) error { 

 // store the Agent description to send on reconnect 

 if err := c.ClientSyncedState.SetAgentDescription(descr); err != nil { 

 return err 

 } 

 c.sender.NextMessage().Update( 

 func(msg *protobufs.AgentToServer) { 

 msg.AgentDescription = c.ClientSyncedState.AgentDescription() 

 }, 

 ) 

 c.sender.ScheduleSend() 

 return nil 

 }

opamp-go/client/internal/clientcommon.go

Lines 289 to 314 in 63c9165

 func (c *ClientCommon) SetRemoteConfigStatus(status *protobufs.RemoteConfigStatus) error { 

 if status.LastRemoteConfigHash == nil { 

 return errLastRemoteConfigHashNil 

 } 

 statusChanged := !proto.Equal(c.ClientSyncedState.RemoteConfigStatus(), status) 

 // Remember the new status. 

 if err := c.ClientSyncedState.SetRemoteConfigStatus(status); err != nil { 

 return err 

 } 

 if statusChanged { 

 // Let the Server know about the new status. 

 c.sender.NextMessage().Update( 

 func(msg *protobufs.AgentToServer) { 

 msg.RemoteConfigStatus = c.ClientSyncedState.RemoteConfigStatus() 

 }, 

 ) 

 // TODO: if this call is coming from OnMessage callback don't schedule the send 

 // immediately, wait until the end of OnMessage to send one message only. 

 c.sender.ScheduleSend() 

 } 

 return nil 

 }

from opamp-go.

tigrannajaryan commented on June 18, 2024

Should the client push update to NextMessage even if there was no change and schedule send.

Do you mean the situation when for example SetRemoteConfigStatus is called with a descr parameter that is equal to the current c.ClientSyncedState.AgentDescription()? You are right that in this case a message will be sent to the Server when with AgentDescription field set when actually the field could have been omitted. We can make a deep comparison and avoid sending it, but the Server should be ready for this to happen anyway, so this should not result in any erroneous situation, it will be just unnecessary data sent.

from opamp-go.

srikanthccv commented on June 18, 2024

Thanks for the clarification.

from opamp-go.

Some sub-messages are always updated for next message about opamp-go HOT 4 CLOSED

Comments (4)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	// SetAgentDescription sends a status update to the Server with the new AgentDescription
	// and remembers the AgentDescription in the client state so that it can be sent
	// to the Server when the Server asks for it.
	func (c ClientCommon) SetAgentDescription(descr protobufs.AgentDescription) error {
	// store the Agent description to send on reconnect
	if err := c.ClientSyncedState.SetAgentDescription(descr); err != nil {
	return err
	}
	c.sender.NextMessage().Update(
	func(msg *protobufs.AgentToServer) {
	msg.AgentDescription = c.ClientSyncedState.AgentDescription()
	},
	)
	c.sender.ScheduleSend()
	return nil
	}

	func (c ClientCommon) SetRemoteConfigStatus(status protobufs.RemoteConfigStatus) error {
	if status.LastRemoteConfigHash == nil {
	return errLastRemoteConfigHashNil
	}

	statusChanged := !proto.Equal(c.ClientSyncedState.RemoteConfigStatus(), status)

	// Remember the new status.
	if err := c.ClientSyncedState.SetRemoteConfigStatus(status); err != nil {
	return err
	}

	if statusChanged {
	// Let the Server know about the new status.
	c.sender.NextMessage().Update(
	func(msg *protobufs.AgentToServer) {
	msg.RemoteConfigStatus = c.ClientSyncedState.RemoteConfigStatus()
	},
	)
	// TODO: if this call is coming from OnMessage callback don't schedule the send
	// immediately, wait until the end of OnMessage to send one message only.
	c.sender.ScheduleSend()
	}

	return nil
	}