From 6f10b4ccfa5673b6202cf9c3ce6e6bb85aba39dc Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Thu, 28 Jul 2022 15:07:06 -0400 Subject: [PATCH] Use ReportsRemoteConfig capability Implements spec change https://github.com/open-telemetry/opamp-spec/pull/115 --- client/clientimpl_test.go | 2 +- client/internal/clientcommon.go | 5 +++++ internal/examples/agent/agent/agent.go | 1 + internal/examples/server/data/agent.go | 2 +- .../supervisor/supervisor/supervisor.go | 1 + internal/proto/opamp.proto | 2 ++ protobufs/opamp.pb.go | 18 ++++++++++++------ 7 files changed, 23 insertions(+), 8 deletions(-) diff --git a/client/clientimpl_test.go b/client/clientimpl_test.go index 226b0e66..100dc630 100644 --- a/client/clientimpl_test.go +++ b/client/clientimpl_test.go @@ -915,7 +915,7 @@ func verifyRemoteConfigUpdate(t *testing.T, successCase bool, expectStatus *prot } }, }, - Capabilities: protobufs.AgentCapabilities_AcceptsRemoteConfig, + Capabilities: protobufs.AgentCapabilities_AcceptsRemoteConfig | protobufs.AgentCapabilities_ReportsRemoteConfig, } prepareClient(t, &settings, client) diff --git a/client/internal/clientcommon.go b/client/internal/clientcommon.go index bc8211f5..c734abfa 100644 --- a/client/internal/clientcommon.go +++ b/client/internal/clientcommon.go @@ -16,6 +16,7 @@ var ( ErrAgentDescriptionNoAttributes = errors.New("AgentDescription has no attributes defined") ErrAgentHealthMissing = errors.New("AgentHealth is nil") ErrReportsEffectiveConfigNotSet = errors.New("ReportsEffectiveConfig capability is not set") + ErrReportsRemoteConfigNotSet = errors.New("ReportsRemoteConfig capability is not set") ErrPackagesStateProviderNotSet = errors.New("PackagesStateProvider must be set") ErrAcceptsPackagesNotSet = errors.New("AcceptsPackages and ReportsPackageStatuses must be set") @@ -293,6 +294,10 @@ func (c *ClientCommon) UpdateEffectiveConfig(ctx context.Context) error { // It also remembers the new RemoteConfigStatus in the client state so that it can be // sent to the Server when the Server asks for it. func (c *ClientCommon) SetRemoteConfigStatus(status *protobufs.RemoteConfigStatus) error { + if c.Capabilities&protobufs.AgentCapabilities_ReportsRemoteConfig == 0 { + return ErrReportsRemoteConfigNotSet + } + if status.LastRemoteConfigHash == nil { return errLastRemoteConfigHashNil } diff --git a/internal/examples/agent/agent/agent.go b/internal/examples/agent/agent/agent.go index fbfc2741..65987a52 100644 --- a/internal/examples/agent/agent/agent.go +++ b/internal/examples/agent/agent/agent.go @@ -104,6 +104,7 @@ func (agent *Agent) start() error { }, RemoteConfigStatus: agent.remoteConfigStatus, Capabilities: protobufs.AgentCapabilities_AcceptsRemoteConfig | + protobufs.AgentCapabilities_ReportsRemoteConfig | protobufs.AgentCapabilities_ReportsEffectiveConfig | protobufs.AgentCapabilities_ReportsOwnMetrics, } diff --git a/internal/examples/server/data/agent.go b/internal/examples/server/data/agent.go index f684632f..cf53f371 100644 --- a/internal/examples/server/data/agent.go +++ b/internal/examples/server/data/agent.go @@ -211,7 +211,7 @@ func (agent *Agent) processStatusUpdate( // Check if any fields were omitted in the status report. effectiveConfigOmitted := agent.hasCapability(protobufs.AgentCapabilities_ReportsEffectiveConfig) && newStatus.EffectiveConfig == nil packageStatusesOmitted := agent.hasCapability(protobufs.AgentCapabilities_ReportsPackageStatuses) && newStatus.PackageStatuses == nil - remoteConfigStatusOmitted := agent.hasCapability(protobufs.AgentCapabilities_AcceptsRemoteConfig) && newStatus.RemoteConfigStatus == nil + remoteConfigStatusOmitted := agent.hasCapability(protobufs.AgentCapabilities_ReportsRemoteConfig) && newStatus.RemoteConfigStatus == nil healthOmitted := agent.hasCapability(protobufs.AgentCapabilities_ReportsHealth) && newStatus.Health == nil // True if the status was not fully reported. diff --git a/internal/examples/supervisor/supervisor/supervisor.go b/internal/examples/supervisor/supervisor/supervisor.go index 161e1a48..0b8f6305 100644 --- a/internal/examples/supervisor/supervisor/supervisor.go +++ b/internal/examples/supervisor/supervisor/supervisor.go @@ -152,6 +152,7 @@ func (s *Supervisor) startOpAMP() error { OnMessageFunc: s.onMessage, }, Capabilities: protobufs.AgentCapabilities_AcceptsRemoteConfig | + protobufs.AgentCapabilities_ReportsRemoteConfig | protobufs.AgentCapabilities_ReportsEffectiveConfig | protobufs.AgentCapabilities_ReportsOwnMetrics | protobufs.AgentCapabilities_ReportsHealth, diff --git a/internal/proto/opamp.proto b/internal/proto/opamp.proto index 851a7e78..61ed289f 100644 --- a/internal/proto/opamp.proto +++ b/internal/proto/opamp.proto @@ -540,6 +540,8 @@ enum AgentCapabilities { AcceptsRestartCommand = 0x00000400; // The Agent will report Health via AgentToServer.health field. ReportsHealth = 0x00000800; + // The Agent will report RemoteConfig status via AgentToServer.remote_config_status field. + ReportsRemoteConfig = 0x00001000; // Add new capabilities here, continuing with the least significant unused bit. } diff --git a/protobufs/opamp.pb.go b/protobufs/opamp.pb.go index ca75af21..273e8c04 100644 --- a/protobufs/opamp.pb.go +++ b/protobufs/opamp.pb.go @@ -140,6 +140,8 @@ const ( AgentCapabilities_AcceptsRestartCommand AgentCapabilities = 1024 // The Agent will report Health via AgentToServer.health field. AgentCapabilities_ReportsHealth AgentCapabilities = 2048 + // The Agent will report RemoteConfig status via AgentToServer.remote_config_status field. + AgentCapabilities_ReportsRemoteConfig AgentCapabilities = 4096 ) // Enum value maps for AgentCapabilities. @@ -158,6 +160,7 @@ var ( 512: "AcceptsOtherConnectionSettings", 1024: "AcceptsRestartCommand", 2048: "ReportsHealth", + 4096: "ReportsRemoteConfig", } AgentCapabilities_value = map[string]int32{ "UnspecifiedAgentCapability": 0, @@ -173,6 +176,7 @@ var ( "AcceptsOtherConnectionSettings": 512, "AcceptsRestartCommand": 1024, "ReportsHealth": 2048, + "ReportsRemoteConfig": 4096, } ) @@ -2957,7 +2961,7 @@ var file_opamp_proto_rawDesc = []byte{ 0x63, 0x63, 0x65, 0x70, 0x74, 0x73, 0x50, 0x61, 0x63, 0x6b, 0x61, 0x67, 0x65, 0x73, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x10, 0x10, 0x12, 0x1c, 0x0a, 0x18, 0x4f, 0x66, 0x66, 0x65, 0x72, 0x73, 0x43, 0x6f, 0x6e, 0x6e, 0x65, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, - 0x67, 0x73, 0x10, 0x20, 0x2a, 0xe8, 0x02, 0x0a, 0x11, 0x41, 0x67, 0x65, 0x6e, 0x74, 0x43, 0x61, + 0x67, 0x73, 0x10, 0x20, 0x2a, 0x82, 0x03, 0x0a, 0x11, 0x41, 0x67, 0x65, 0x6e, 0x74, 0x43, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x69, 0x65, 0x73, 0x12, 0x1e, 0x0a, 0x1a, 0x55, 0x6e, 0x73, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x65, 0x64, 0x41, 0x67, 0x65, 0x6e, 0x74, 0x43, 0x61, 0x70, 0x61, 0x62, 0x69, 0x6c, 0x69, 0x74, 0x79, 0x10, 0x00, 0x12, 0x11, 0x0a, 0x0d, 0x52, 0x65, @@ -2979,11 +2983,13 @@ var file_opamp_proto_rawDesc = []byte{ 0x74, 0x69, 0x6f, 0x6e, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x10, 0x80, 0x04, 0x12, 0x1a, 0x0a, 0x15, 0x41, 0x63, 0x63, 0x65, 0x70, 0x74, 0x73, 0x52, 0x65, 0x73, 0x74, 0x61, 0x72, 0x74, 0x43, 0x6f, 0x6d, 0x6d, 0x61, 0x6e, 0x64, 0x10, 0x80, 0x08, 0x12, 0x12, 0x0a, 0x0d, 0x52, - 0x65, 0x70, 0x6f, 0x72, 0x74, 0x73, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x10, 0x80, 0x10, 0x42, - 0x2e, 0x5a, 0x2c, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x6f, 0x70, - 0x65, 0x6e, 0x2d, 0x74, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x74, 0x72, 0x79, 0x2f, 0x6f, 0x70, 0x61, - 0x6d, 0x70, 0x2d, 0x67, 0x6f, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x73, 0x62, - 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x65, 0x70, 0x6f, 0x72, 0x74, 0x73, 0x48, 0x65, 0x61, 0x6c, 0x74, 0x68, 0x10, 0x80, 0x10, 0x12, + 0x18, 0x0a, 0x13, 0x52, 0x65, 0x70, 0x6f, 0x72, 0x74, 0x73, 0x52, 0x65, 0x6d, 0x6f, 0x74, 0x65, + 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x10, 0x80, 0x20, 0x42, 0x2e, 0x5a, 0x2c, 0x67, 0x69, 0x74, + 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x6f, 0x70, 0x65, 0x6e, 0x2d, 0x74, 0x65, 0x6c, + 0x65, 0x6d, 0x65, 0x74, 0x72, 0x79, 0x2f, 0x6f, 0x70, 0x61, 0x6d, 0x70, 0x2d, 0x67, 0x6f, 0x2f, + 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x73, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, + 0x33, } var (