From b3050ed7b5c99a7219f2fa9928c0984ca9ad2a8f Mon Sep 17 00:00:00 2001 From: EddeCCC Date: Thu, 19 Dec 2024 11:31:44 +0100 Subject: [PATCH] add time-limit to docs --- .../resources/rocks/inspectit/ocelot/config/default/basics.yml | 2 +- .../rocks/inspectit/ocelot/config/default/config-sources.yml | 2 +- .../docs/configuration/agent-command-configuration.md | 1 + .../docs/configuration/external-configuration-sources.md | 2 ++ 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/basics.yml b/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/basics.yml index b1e9959831..19073d2ea3 100644 --- a/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/basics.yml +++ b/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/basics.yml @@ -149,7 +149,7 @@ inspectit: multiplier: 2 # This factor introduces randomness to what the actual wait interval will be. This prevents that a lot of agents will issue requests towards the configuration server at the same time. randomization-factor: 0.1 - # The maximum duration one retry may take + # The maximum duration one retry may take. After the limit is exceeded, the retry will be cancelled. time-limit: 32m log-preloading: diff --git a/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/config-sources.yml b/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/config-sources.yml index 80c5907ef3..ef2ccb5b66 100644 --- a/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/config-sources.yml +++ b/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/config-sources.yml @@ -42,5 +42,5 @@ inspectit: multiplier: 2 # This factor introduces randomness to what the actual wait interval will be. This prevents that a lot of agents will issue requests towards the configuration server at the same time. randomization-factor: 0.1 - # The maximum duration one retry may take + # The maximum duration one retry may take. After the limit is exceeded, the retry will be cancelled. time-limit: 32m diff --git a/inspectit-ocelot-documentation/docs/configuration/agent-command-configuration.md b/inspectit-ocelot-documentation/docs/configuration/agent-command-configuration.md index 5c4c0db28a..90515e07c8 100644 --- a/inspectit-ocelot-documentation/docs/configuration/agent-command-configuration.md +++ b/inspectit-ocelot-documentation/docs/configuration/agent-command-configuration.md @@ -116,6 +116,7 @@ The agent command feature can be more precisely configured to the needs with the | `retry.initial-interval` | `30s` | The initial interval to wait after the first failed attempt. Durations must be greater or equal to 1 ms. | | `retry.multiplier` | `2` | For each retry the last interval to wait is multiplied with this number to calculate the next interval to wait. Decimals must be greater or equal to 1.0. | | `retry.randomization-factor` | `0.1` | This factor introduces randomness to what the actual wait interval will be. This prevents that a lot of agents will issue requests towards the configuration server at the same time. Decimals between 0.0 (exclusive) and 1.0 (inclusive) are allowed. | +| `retry.time-limit` | `32m` | The maximum amount of time one retry may take. After the limit is exceeded, the retry will be cancelled. Durations must be are greater or equal to 1 ms. | In case the specified HTTP endpoint is temporarily not available, inspectit applies by default a retry mechanism with exponential backoff in order to save resources. If Ocelot agent cannot reload the configuration successfully after the diff --git a/inspectit-ocelot-documentation/docs/configuration/external-configuration-sources.md b/inspectit-ocelot-documentation/docs/configuration/external-configuration-sources.md index c5ed7ff91e..14aca59e70 100644 --- a/inspectit-ocelot-documentation/docs/configuration/external-configuration-sources.md +++ b/inspectit-ocelot-documentation/docs/configuration/external-configuration-sources.md @@ -60,6 +60,8 @@ This configuration source can be used when using the [inspectIT Ocelot Configura | `inspectit.config.http.retry.initial-interval` | `30s` | The initial interval to wait after the first failed attempt. Durations must be are greater or equal to 1 ms. | | `inspectit.config.http.retry.multiplier` | `2` | For each retry the last interval to wait is multiplied with this number to calculate the next interval to wait. Decimals must be greater or equal to 1.0. | | `inspectit.config.http.retry.randomization-factor` | `0.1` | This factor introduces randomness to what the actual wait interval will be. This prevents that a lot of agents will issue requests towards the configuration server at the same time. Decimals between 0.0 (exclusive) and 1.0 (inclusive) are allowed. | +| `inspectit.config.http.retry.time-limit` | `32m` | The maximum amount of time one retry may take. After the limit is exceeded, the retry will be cancelled. Durations must be are greater or equal to 1 ms. | + > Due to security reasons, the HTTP-based configuration has the lowest priority, thus, cannot override configuration properties set by different configuration sources.