cppagent icon indicating copy to clipboard operation
cppagent copied to clipboard

Report Agent Software Version

Open rwuthric opened this issue 8 months ago • 4 comments

Maybe it is already the case and I couldn't figure it out, but it would be useful if the Agent could report it's software version (for example as an Application.Version field).

In our use case we deploy several agents across a Docker Swarm Cluster and it would help to have available which version exactly of the agent is in use (we could use it to automate upgrades etc. ...).

rwuthric avatar May 06 '25 21:05 rwuthric

I could add it to the Agent device as a configuration item. I can check it out. I believe it is logged when the agent starts as well.

How would it be best reported for your needs? Via the protocol header (I think it is there) or in the logs?

wsobel avatar May 06 '25 21:05 wsobel

Thank you for the quick answer

I was thinking a DataItem that would be in the Agent Device Stream, similar to the reporting of the Adapter Software version. For example:

<Events>
    <AgentSoftwareVersion dataItemId="agent_software_version" sequence="31" timestamp="2025-05-07T00:54:11.223921Z">2.5.0.4</AgentSoftwareVersion >
</Events>

Indeed, the version is present in the header (for example version="2.5.0.4"). I didn't check that previously.

The benefit we see in having the version further reported in a DataItem is that for the user it would be easy to inspect it from the WebApp of the Agent. Our software framework would as well be able to handle the DataItem in a straight forward way.

rwuthric avatar May 07 '25 01:05 rwuthric

Thank you for the quick answer

I was thinking a DataItem that would be in the Agent Device Stream, similar to the reporting of the Adapter Software version. For example:

<Events>
    <AgentSoftwareVersion dataItemId="agent_software_version" sequence="31" timestamp="2025-05-07T00:54:11.223921Z">2.5.0.4</AgentSoftwareVersion >
</Events>

Indeed, the version is present in the header (for example version="2.5.0.4"). I didn't check that previously.

The benefit we see in having the version further reported in a DataItem is that for the user it would be easy to inspect it from the WebApp of the Agent. Our software framework would as well be able to handle the DataItem in a straight forward way.

it is shown in the webapp... is this not sufficient?

Image

robot-ranger avatar May 30 '25 00:05 robot-ranger

We would need to pass this by the Agent WG and have it approved as a new data item type. Not too hard, but may be in 2.7.

wsobel avatar May 30 '25 00:05 wsobel