Skip to content

Commit

Permalink
Clarify top-level ComponentHealth is for the Agent; set status to beta
Browse files Browse the repository at this point in the history
mwear committed Oct 10, 2023
1 parent 3514e22 commit f3bbf8a
Showing 2 changed files with 12 additions and 3 deletions.
7 changes: 5 additions & 2 deletions proto/opamp.proto
Original file line number Diff line number Diff line change
@@ -46,8 +46,10 @@ message AgentToServer {
// This field MUST be always set.
uint64 capabilities = 4;

// The current health of the Agent.
// May be omitted if nothing changed since last AgentToServer message.
// The current health of the Agent and sub-components. The top-level ComponentHealth represents
// the health of the Agent overall. May be omitted if nothing changed since last AgentToServer
// message.
// Status: [Beta]
ComponentHealth health = 5;

// The current effective configuration of the Agent. The effective configuration is
@@ -622,6 +624,7 @@ enum AgentCapabilities {
}

// The health of the Agent and sub-components
// Status: [Beta]
message ComponentHealth {
// Set to true if the component is up and healthy.
bool healthy = 1;
8 changes: 7 additions & 1 deletion specification.md
Original file line number Diff line number Diff line change
@@ -563,7 +563,11 @@ enum AgentCapabilities {

##### AgentToServer.health

The current health of the Agent and sub-components. See [ComponentHealth message](#componenthealth-message).
Status: [Beta]

The current health of the Agent and sub-components. The top-level ComponentHealth
represents the health of the Agent overall. May be omitted if nothing changed since last
AgentToServer message. See [ComponentHealth message](#componenthealth-message).
May be omitted if nothing changed since last AgentToServer message.

##### AgentToServer.effective_config
@@ -1074,6 +1078,8 @@ The following attributes SHOULD be included:

#### ComponentHealth Message

Status: [Beta]

The ComponentHealth message has the following structure:

```protobuf

0 comments on commit f3bbf8a

Please sign in to comment.