diff --git a/proto/opamp.proto b/proto/opamp.proto index 127d349..946b594 100644 --- a/proto/opamp.proto +++ b/proto/opamp.proto @@ -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; diff --git a/specification.md b/specification.md index 59d4fc2..bdfa67e 100644 --- a/specification.md +++ b/specification.md @@ -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