Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a field to specify keepalive interval to OpAMPConnectionSettings #176

Closed
wants to merge 1 commit into from
Closed

Add a field to specify keepalive interval to OpAMPConnectionSettings #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions proto/opamp.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,18 @@ message OpAMPConnectionSettings {
// This field is optional: if omitted the client SHOULD NOT use a client-side certificate.
// This field can be used to perform a client certificate revocation/rotation.
TLSCertificate certificate = 3;

// If the Agent has nothing to deliver to the Server the Client MUST periodically send
// an AgentToServer message where only instance_uid field is set to keep the connection alive.
// This field specify an interval for keepalive messages.
//
// A Polling-based HTTP Client SHOULD use the value as polling interval.
//
// Typically used to avoid intermediaries such as load balancers closing inactive OpAMP connections.
// This filed is optional:
// if omitted, use the client-side configuration.
// if set to zero, the keepalive ability will be disabled.
optional uint64 keepalive_interval_seconds = 4;
}

// The TelemetryConnectionSettings message is a collection of fields which comprise an
Expand Down Expand Up @@ -620,11 +632,11 @@ enum AgentCapabilities {
// the Server via ConnectionSettingsOffers.own_logs field.
// Status: [Beta]
AgentCapabilities_ReportsOwnLogs = 0x00000080;
// The can accept connections settings for OpAMP via
// The Agent can accept connections settings for OpAMP via
// ConnectionSettingsOffers.opamp field.
// Status: [Beta]
AgentCapabilities_AcceptsOpAMPConnectionSettings = 0x00000100;
// The can accept connections settings for other destinations via
// The Agent can accept connections settings for other destinations via
// ConnectionSettingsOffers.other_connections field.
// Status: [Beta]
AgentCapabilities_AcceptsOtherConnectionSettings = 0x00000200;
Expand Down
24 changes: 24 additions & 0 deletions specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Status: [Beta]
- [OpAMPConnectionSettings.destination_endpoint](#opampconnectionsettingsdestination_endpoint)
- [OpAMPConnectionSettings.headers](#opampconnectionsettingsheaders)
- [OpAMPConnectionSettings.certificate](#opampconnectionsettingscertificate)
- [OpAMPConnectionSettings.keepalive_interval_seconds](#opampconnectionsettingskeepalive_interval_seconds)
+ [TelemetryConnectionSettings](#telemetryconnectionsettings)
- [TelemetryConnectionSettings.destination_endpoint](#telemetryconnectionsettingsdestination_endpoint)
- [TelemetryConnectionSettings.headers](#telemetryconnectionsettingsheaders)
Expand Down Expand Up @@ -424,6 +425,15 @@ The WebSocket transport is typically used when it is necessary to have instant
communication ability from the Server to the Agent without waiting for the Client
to poll the Server like it is done when using the HTTP transport (see below).

If the Agent has nothing to deliver to the Server the Client can periodically send
an AgentToServer message where only instance_uid field is set to keep the connection alive.
The keepalive ability is OPTIONAL and the keepalive interval SHOULD be configurable on
the client side. If the client accepts OpAMPConnectionSettings, the keepalive interval SHOULD
be specified by OpAMPConnectionSettings.keepalive_interval_seconds.

If the client accepts OpAMPConnectionSettings, this polling interval SHOULD be specified by
OpAMPConnectionSettings.keepalive_interval_seconds.

### Plain HTTP Transport

The second supported transport for OpAMP protocol is plain HTTP connection. The
Expand All @@ -444,6 +454,8 @@ deliver to the Agent (such as for example a new remote configuration).

The default polling interval when the Agent does not have anything to deliver is 30
seconds. This polling interval SHOULD be configurable on the Client.
If the client accepts OpAMPConnectionSettings, this polling interval SHOULD be specified by
OpAMPConnectionSettings.keepalive_interval_seconds.

When using HTTP transport the sequence of messages is exactly the same as it is
when using the WebSocket transport. The only difference is in the timing:
Expand Down Expand Up @@ -1830,6 +1842,7 @@ message OpAMPConnectionSettings {
string destination_endpoint = 1;
Headers headers = 2;
TLSCertificate certificate = 3;
optional uint64 keepalive_interval_seconds = 4;
}
```

Expand All @@ -1855,6 +1868,17 @@ for this connection.
This field is optional: if omitted the client SHOULD NOT use a client-side certificate.
This field can be used to perform a client certificate revocation/rotation.

##### OpAMPConnectionSettings.keepalive_interval_seconds

If the Agent has nothing to deliver to the Server the Client MUST periodically send
an AgentToServer message where only instance_uid field is set to keep the connection alive.
This field specify an interval for keepalive messages.

A Polling-based HTTP Client SHOULD use the value as polling interval.

Typically used to avoid intermediaries such as load balancers closing inactive OpAMP connections.
This filed is optional: if omitted or set to zero, the keepalive feature will be disabled.

#### TelemetryConnectionSettings

The TelemetryConnectionSettings message is a collection of fields which comprise an
Expand Down
Loading