Skip to content

Commit b6e143c

Browse files
aphralGaphralG
authored
Update agent config defaults and format (#959)
* update config defaults and format
1 parent 6f74a21 commit b6e143c

File tree

17 files changed

+327
-163
lines changed

17 files changed

+327
-163
lines changed

‎internal/backoff/backoff.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import (
4848
// Information from https://pkg.go.dev/github.com/cenkalti/backoff/v4#section-readme
4949
func WaitUntil(
5050
ctx context.Context,
51-
backoffSettings *config.CommonSettings,
51+
backoffSettings *config.BackOff,
5252
operation backoff.Operation,
5353
) error {
5454
eb := backoff.NewExponentialBackOff()
@@ -68,7 +68,7 @@ func WaitUntil(
6868
// nolint: ireturn
6969
func WaitUntilWithData[T any](
7070
ctx context.Context,
71-
backoffSettings *config.CommonSettings,
71+
backoffSettings *config.BackOff,
7272
operation backoff.OperationWithData[T],
7373
) (T, error) {
7474
backoffWithContext := Context(ctx, backoffSettings)
@@ -77,7 +77,7 @@ func WaitUntilWithData[T any](
7777
}
7878

7979
// nolint: ireturn
80-
func Context(ctx context.Context, backoffSettings *config.CommonSettings) backoff.BackOffContext {
80+
func Context(ctx context.Context, backoffSettings *config.BackOff) backoff.BackOffContext {
8181
eb := backoff.NewExponentialBackOff()
8282
eb.InitialInterval = backoffSettings.InitialInterval
8383
eb.MaxInterval = backoffSettings.MaxInterval

‎internal/backoff/backoff_test.go‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,16 @@ func TestWaitUntil(t *testing.T) {
8282

8383
for _, test := range tests {
8484
invocations = 0
85-
settings := &config.CommonSettings{
86-
InitialInterval: test.initialInterval,
87-
MaxInterval: test.maxInterval,
88-
MaxElapsedTime: test.maxElapsedTime,
89-
RandomizationFactor: config.DefBackoffRandomizationFactor,
90-
Multiplier: config.DefBackoffMultiplier,
85+
settings := &config.Client{
86+
Backoff: &config.BackOff{
87+
InitialInterval: test.initialInterval,
88+
MaxInterval: test.maxInterval,
89+
MaxElapsedTime: test.maxElapsedTime,
90+
RandomizationFactor: config.DefBackoffRandomizationFactor,
91+
Multiplier: config.DefBackoffMultiplier,
92+
},
9193
}
92-
result := WaitUntil(test.context, settings, test.operation)
94+
result := WaitUntil(test.context, settings.Backoff, test.operation)
9395

9496
if test.expectedError {
9597
assert.Errorf(t, result, test.name)
@@ -164,7 +166,7 @@ func TestWaitUntilWithData(t *testing.T) {
164166
}
165167

166168
for _, test := range tests {
167-
settings := &config.CommonSettings{
169+
settings := &config.BackOff{
168170
InitialInterval: test.initialInterval,
169171
MaxInterval: test.maxInterval,
170172
MaxElapsedTime: test.maxElapsedTime,
@@ -185,7 +187,7 @@ func TestWaitUntilWithData(t *testing.T) {
185187
}
186188

187189
func TestContext(t *testing.T) {
188-
settings := &config.CommonSettings{
190+
settings := &config.BackOff{
189191
InitialInterval: 10 * time.Millisecond,
190192
MaxInterval: 10 * time.Millisecond,
191193
MaxElapsedTime: 10 * time.Millisecond,

‎internal/collector/otel_collector_plugin.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,9 @@ func (oc *Collector) Close(ctx context.Context) error {
203203
oc.service.Shutdown()
204204
oc.cancel()
205205

206-
settings := oc.config.Common
206+
settings := oc.config.Client.Backoff
207207
settings.MaxElapsedTime = maxTimeToWaitForShutdown
208-
err := backoff.WaitUntil(ctx, oc.config.Common, func() error {
208+
err := backoff.WaitUntil(ctx, settings, func() error {
209209
if oc.service.GetState() == otelcol.StateClosed {
210210
return nil
211211
}

‎internal/command/command_service.go‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111
"log/slog"
1212
"sync"
1313
"sync/atomic"
14-
"time"
1514

1615
"github.com/cenkalti/backoff/v4"
1716

@@ -29,7 +28,6 @@ import (
2928
var _ commandService = (*CommandService)(nil)
3029

3130
const (
32-
retryInterval = 5 * time.Second
3331
createConnectionMaxElapsedTime = 0
3432
)
3533

@@ -95,7 +93,7 @@ func (cs *CommandService) UpdateDataPlaneStatus(
9593
Resource: resource,
9694
}
9795

98-
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Common.MaxElapsedTime)
96+
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Client.Backoff.MaxElapsedTime)
9997
defer backoffCancel()
10098

10199
sendDataPlaneStatus := func() (*mpi.UpdateDataPlaneStatusResponse, error) {
@@ -119,7 +117,7 @@ func (cs *CommandService) UpdateDataPlaneStatus(
119117

120118
response, err := backoff.RetryWithData(
121119
sendDataPlaneStatus,
122-
backoffHelpers.Context(backOffCtx, cs.agentConfig.Common),
120+
backoffHelpers.Context(backOffCtx, cs.agentConfig.Client.Backoff),
123121
)
124122
if err != nil {
125123
return err
@@ -145,12 +143,12 @@ func (cs *CommandService) UpdateDataPlaneHealth(ctx context.Context, instanceHea
145143
InstanceHealths: instanceHealths,
146144
}
147145

148-
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Common.MaxElapsedTime)
146+
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Client.Backoff.MaxElapsedTime)
149147
defer backoffCancel()
150148

151149
response, err := backoff.RetryWithData(
152150
cs.dataPlaneHealthCallback(ctx, request),
153-
backoffHelpers.Context(backOffCtx, cs.agentConfig.Common),
151+
backoffHelpers.Context(backOffCtx, cs.agentConfig.Client.Backoff),
154152
)
155153
if err != nil {
156154
return err
@@ -164,12 +162,12 @@ func (cs *CommandService) UpdateDataPlaneHealth(ctx context.Context, instanceHea
164162
func (cs *CommandService) SendDataPlaneResponse(ctx context.Context, response *mpi.DataPlaneResponse) error {
165163
slog.DebugContext(ctx, "Sending data plane response", "response", response)
166164

167-
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Common.MaxElapsedTime)
165+
backOffCtx, backoffCancel := context.WithTimeout(ctx, cs.agentConfig.Client.Backoff.MaxElapsedTime)
168166
defer backoffCancel()
169167

170168
return backoff.Retry(
171169
cs.sendDataPlaneResponseCallback(ctx, response),
172-
backoffHelpers.Context(backOffCtx, cs.agentConfig.Common),
170+
backoffHelpers.Context(backOffCtx, cs.agentConfig.Client.Backoff),
173171
)
174172
}
175173

@@ -184,12 +182,12 @@ func (cs *CommandService) CancelSubscription(ctx context.Context) {
184182
}
185183

186184
func (cs *CommandService) subscribe(ctx context.Context) {
187-
commonSettings := &config.CommonSettings{
188-
InitialInterval: cs.agentConfig.Common.InitialInterval,
189-
MaxInterval: cs.agentConfig.Common.MaxInterval,
185+
commonSettings := &config.BackOff{
186+
InitialInterval: cs.agentConfig.Client.Backoff.InitialInterval,
187+
MaxInterval: cs.agentConfig.Client.Backoff.MaxInterval,
190188
MaxElapsedTime: createConnectionMaxElapsedTime,
191-
RandomizationFactor: cs.agentConfig.Common.RandomizationFactor,
192-
Multiplier: cs.agentConfig.Common.Multiplier,
189+
RandomizationFactor: cs.agentConfig.Client.Backoff.RandomizationFactor,
190+
Multiplier: cs.agentConfig.Client.Backoff.Multiplier,
193191
}
194192

195193
for {
@@ -223,12 +221,12 @@ func (cs *CommandService) CreateConnection(
223221
Resource: resource,
224222
}
225223

226-
commonSettings := &config.CommonSettings{
227-
InitialInterval: cs.agentConfig.Common.InitialInterval,
228-
MaxInterval: cs.agentConfig.Common.MaxInterval,
224+
commonSettings := &config.BackOff{
225+
InitialInterval: cs.agentConfig.Client.Backoff.InitialInterval,
226+
MaxInterval: cs.agentConfig.Client.Backoff.MaxInterval,
229227
MaxElapsedTime: createConnectionMaxElapsedTime,
230-
RandomizationFactor: cs.agentConfig.Common.RandomizationFactor,
231-
Multiplier: cs.agentConfig.Common.Multiplier,
228+
RandomizationFactor: cs.agentConfig.Client.Backoff.RandomizationFactor,
229+
Multiplier: cs.agentConfig.Client.Backoff.Multiplier,
232230
}
233231

234232
slog.DebugContext(ctx, "Sending create connection request", "request", request)

‎internal/config/config.go‎

Lines changed: 91 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import (
1414
"path/filepath"
1515
"slices"
1616
"strings"
17-
"time"
1817

1918
selfsignedcerts "github.com/nginx/agent/v3/pkg/tls"
2019
uuidLibrary "github.com/nginx/agent/v3/pkg/uuid"
@@ -101,7 +100,6 @@ func ResolveConfig() (*Config, error) {
101100
AllowedDirectories: allowedDirs,
102101
Collector: collector,
103102
Command: resolveCommand(),
104-
Common: resolveCommon(),
105103
Watchers: resolveWatchers(),
106104
Features: viperInstance.GetStringSlice(FeaturesKey),
107105
}
@@ -155,7 +153,6 @@ func registerFlags() {
155153
"collection or error monitoring",
156154
)
157155

158-
fs.Duration(ClientTimeoutKey, time.Minute, "Client timeout")
159156
fs.StringSlice(AllowedDirectoriesKey,
160157
DefaultAllowedDirectories(),
161158
"A comma-separated list of paths that you want to grant NGINX Agent read/write access to")
@@ -178,24 +175,6 @@ func registerFlags() {
178175
"How often the NGINX Agent will check for file changes.",
179176
)
180177

181-
fs.Int(
182-
ClientMaxMessageSizeKey,
183-
DefMaxMessageSize,
184-
"The value used, if not 0, for both max_message_send_size and max_message_receive_size",
185-
)
186-
187-
fs.Int(
188-
ClientMaxMessageReceiveSizeKey,
189-
DefMaxMessageRecieveSize,
190-
"Updates the client grpc setting MaxRecvMsgSize with the specific value in MB.",
191-
)
192-
193-
fs.Int(
194-
ClientMaxMessageSendSizeKey,
195-
DefMaxMessageSendSize,
196-
"Updates the client grpc setting MaxSendMsgSize with the specific value in MB.",
197-
)
198-
199178
fs.StringSlice(
200179
FeaturesKey,
201180
DefaultFeatures(),
@@ -204,6 +183,7 @@ func registerFlags() {
204183

205184
registerCommandFlags(fs)
206185
registerCollectorFlags(fs)
186+
registerClientFlags(fs)
207187

208188
fs.SetNormalizeFunc(normalizeFunc)
209189

@@ -218,6 +198,76 @@ func registerFlags() {
218198
})
219199
}
220200

201+
func registerClientFlags(fs *flag.FlagSet) {
202+
// HTTP Flags
203+
fs.Duration(
204+
ClientHTTPTimeoutKey,
205+
DefHTTPTimeout,
206+
"The client HTTP Timeout, value in seconds")
207+
208+
// Backoff Flags
209+
fs.Duration(
210+
ClientBackoffInitialIntervalKey,
211+
DefBackoffInitialInterval,
212+
"The client backoff initial interval, value in seconds")
213+
214+
fs.Duration(
215+
ClientBackoffMaxIntervalKey,
216+
DefBackoffMaxInterval,
217+
"The client backoff max interval, value in seconds")
218+
219+
fs.Duration(
220+
ClientBackoffMaxElapsedTimeKey,
221+
DefBackoffMaxElapsedTime,
222+
"The client backoff max elapsed time, value in seconds")
223+
224+
fs.Float64(
225+
ClientBackoffRandomizationFactorKey,
226+
DefBackoffRandomizationFactor,
227+
"The client backoff randomization factor, value float")
228+
229+
fs.Float64(
230+
ClientBackoffMultiplierKey,
231+
DefBackoffMultiplier,
232+
"The client backoff multiplier, value float")
233+
234+
// GRPC Flags
235+
fs.Duration(
236+
ClientKeepAliveTimeoutKey,
237+
DefGRPCKeepAliveTimeout,
238+
"Updates the client grpc setting, KeepAlive Timeout with the specific value in seconds.",
239+
)
240+
241+
fs.Duration(
242+
ClientKeepAliveTimeKey,
243+
DefGRPCKeepAliveTime,
244+
"Updates the client grpc setting, KeepAlive Time with the specific value in seconds.",
245+
)
246+
247+
fs.Bool(
248+
ClientKeepAlivePermitWithoutStreamKey,
249+
DefGRPCKeepAlivePermitWithoutStream,
250+
"Update the client grpc setting, KeepAlive PermitWithoutStream value")
251+
252+
fs.Int(
253+
ClientGRPCMaxMessageSizeKey,
254+
DefMaxMessageSize,
255+
"The value used, if not 0, for both max_message_send_size and max_message_receive_size",
256+
)
257+
258+
fs.Int(
259+
ClientGRPCMaxMessageReceiveSizeKey,
260+
DefMaxMessageRecieveSize,
261+
"Updates the client grpc setting MaxRecvMsgSize with the specific value in MB.",
262+
)
263+
264+
fs.Int(
265+
ClientGRPCMaxMessageSendSizeKey,
266+
DefMaxMessageSendSize,
267+
"Updates the client grpc setting MaxSendMsgSize with the specific value in MB.",
268+
)
269+
}
270+
221271
func registerCommandFlags(fs *flag.FlagSet) {
222272
fs.String(
223273
CommandServerHostKey,
@@ -418,12 +468,26 @@ func resolveDataPlaneConfig() *DataPlaneConfig {
418468

419469
func resolveClient() *Client {
420470
return &Client{
421-
Timeout: viperInstance.GetDuration(ClientTimeoutKey),
422-
Time: viperInstance.GetDuration(ClientTimeKey),
423-
PermitWithoutStream: viperInstance.GetBool(ClientPermitWithoutStreamKey),
424-
MaxMessageSize: viperInstance.GetInt(ClientMaxMessageSizeKey),
425-
MaxMessageRecieveSize: viperInstance.GetInt(ClientMaxMessageReceiveSizeKey),
426-
MaxMessageSendSize: viperInstance.GetInt(ClientMaxMessageSendSizeKey),
471+
HTTP: &HTTP{
472+
Timeout: viperInstance.GetDuration(ClientHTTPTimeoutKey),
473+
},
474+
Grpc: &GRPC{
475+
KeepAlive: &KeepAlive{
476+
Timeout: viperInstance.GetDuration(ClientKeepAliveTimeoutKey),
477+
Time: viperInstance.GetDuration(ClientKeepAliveTimeKey),
478+
PermitWithoutStream: viperInstance.GetBool(ClientKeepAlivePermitWithoutStreamKey),
479+
},
480+
MaxMessageSize: viperInstance.GetInt(ClientGRPCMaxMessageSizeKey),
481+
MaxMessageReceiveSize: viperInstance.GetInt(ClientGRPCMaxMessageReceiveSizeKey),
482+
MaxMessageSendSize: viperInstance.GetInt(ClientGRPCMaxMessageSendSizeKey),
483+
},
484+
Backoff: &BackOff{
485+
InitialInterval: viperInstance.GetDuration(ClientBackoffInitialIntervalKey),
486+
MaxInterval: viperInstance.GetDuration(ClientBackoffMaxIntervalKey),
487+
MaxElapsedTime: viperInstance.GetDuration(ClientBackoffMaxElapsedTimeKey),
488+
RandomizationFactor: viperInstance.GetFloat64(ClientBackoffRandomizationFactorKey),
489+
Multiplier: viperInstance.GetFloat64(ClientBackoffMultiplierKey),
490+
},
427491
}
428492
}
429493

@@ -686,16 +750,6 @@ func arePrometheusExportTLSSettingsSet() bool {
686750
viperInstance.IsSet(CollectorPrometheusExporterTLSServerNameKey)
687751
}
688752

689-
func resolveCommon() *CommonSettings {
690-
return &CommonSettings{
691-
InitialInterval: DefBackoffInitialInterval,
692-
MaxInterval: DefBackoffMaxInterval,
693-
MaxElapsedTime: DefBackoffMaxElapsedTime,
694-
RandomizationFactor: DefBackoffRandomizationFactor,
695-
Multiplier: DefBackoffMultiplier,
696-
}
697-
}
698-
699753
func resolveWatchers() *Watchers {
700754
return &Watchers{
701755
InstanceWatcher: InstanceWatcher{

0 commit comments

Comments
 (0)