Update Spec to include ServerToAgentCommand #64
Conversation
* Updated ServerToAgent message protobuf, ServerCapabilities enum * Formatting typo, fixed AgentCapabilites, closed open questions * Documented entire ServerToAgentCommand message * Update specification.md Co-authored-by: Andy Keller <andykellr@users.noreply.github.com> Co-authored-by: Andy Keller <andykellr@users.noreply.github.com>
|
|
| @@ -2423,7 +2453,7 @@ TBD | |||
| * Do we need to define OpenTelemetry semantic conventions for reporting typical | |||
| collection Agent-specific metrics (e.g. input/processing/output data rates, | |||
| throughput, latency, etc)? | |||
| * Do we need a capability for the Server to order the Agent to restart? | |||
| * ~~Do we need a capability for the Server to order the Agent to restart?~~ Added. | |||
specification.md
Outdated
| ```protobuf | ||
| // ServerToAgentCommand is sent from the server to the agent to request that the agent | ||
| // perform a command. | ||
| message ServerToAgentCommand { | ||
| enum CommandType { | ||
| // The agent should restart. This request will be ignored if the agent does not | ||
| // support restart. | ||
| Restart = 0; | ||
|
|
||
| // The agent should shutdown. This request will be ignored if the agent does not | ||
| // support shutdown. Shutdown is permanent and the agent will no longer be running | ||
| // or connected to the management server. | ||
| Shutdown = 1; | ||
| } | ||
| CommandType type = 1; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Can we move this to a separate section like all other messages are?
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
|
@open-telemetry/opamp-spec-approvers please review. |
specification.md
Outdated
| // The agent should shutdown. This request will be ignored if the agent does not | ||
| // support shutdown. Shutdown is permanent and the agent will no longer be running | ||
| // or connected to the management server. | ||
| Shutdown = 1; |
There was a problem hiding this comment.
I thought a bit more about this and it is not quite clear how this can be implemented by an Agent. Typically the Agent is installed in a way that autostarts it on system start, right? So do we expect the shutdown to disable the autostart? Is this even doable in typical use-cases when the user that the Agent runs with is not the root?
There was a problem hiding this comment.
Eventually when there is a working supervisor connected to OpAMP, this could signal that the collector should stop and free up some resources, leaving only the supervisor running. This could be used to pause collection of metrics without modifying the configuration. To resume collection of metrics, a restart command would start the collector.
|
@dsvanlani Discussed this in the workgroup. There does not seem to be a consensus around what it means to "shutdown" an Agent. Can you clarify the semantics of the operation or perhaps remove it from this PR, so that we can merge "restart" command quickly and continue thinking about shutdown in a follow up PR. |
|
@tigrannajaryan I removed the "shutdown" command from this PR. Happy to wait for further discussion. |
|
@dsvanlani please rebase from main and resolve the conflicts so that I can merge. |
* Add support for detached signatures (open-telemetry#69) Resolves open-telemetry#65 - Added signature field to DownloadableFile message. - Added a short explanation about how the signature field can be used for detached signatures. * Set instance_uid by Server on conflict or request for generation (open-telemetry#63) This is a first approach towards open-telemetry#56 It assumes that Agent's `instance_uid` can always be updated by Server (since resolving potential issues with conflicts is important). There's a gap with multiplexed websocket connections which perhaps could be handled by adding Agent capability flag indicating if overrides can be accepted or not Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Co-authored-by: Przemek Maciolek <58699843+pmm-sumo@users.noreply.github.com>
|
@tigrannajaryan I went ahead and rebased to cleanup the commit history - I'm not sure why the UI isn't reflecting the single commit. |
Resolves #22
ServerToAgentCommandintoServerToAgentMessage.ServerToAgentCommand