You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: install-and-configure/install-on-prem-platform/advanced-configuration.md
+34-6Lines changed: 34 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -38,12 +38,14 @@ Steadybit requires a PostgresSQL 15 database.
38
38
|`STEADYBIT_DB_WEB_ENABLED`|| <p>Enable Http Endpoint for Database export<br><strong>Default:</strong> <code>true</code></p> |
39
39
40
40
#### RDS Machine Requirements
41
-
The workload is bound by the database CPU on peaks.
42
41
43
-
If you have ~100k targets simultaneously in the platform, we recommend a burstable instance with four vCPU (e.g., db.t4g.xlarge). Regarding disk size, 20 GB should be enough capacity for the start (as extending on AWS should not be a problem).
42
+
The workload is bound by the database CPU on peaks.
44
43
45
-
If you choose a smaller instance for cost savings, the target ingestion will be slower, so it will take a bit longer until the target data in the platform is consistent.
44
+
If you have ~100k targets simultaneously in the platform, we recommend a burstable instance with four vCPU (e.g., db.t4g.xlarge). Regarding disk size, 20 GB
45
+
should be enough capacity for the start (as extending on AWS should not be a problem).
46
46
47
+
If you choose a smaller instance for cost savings, the target ingestion will be slower, so it will take a bit longer until the target data in the platform is
48
+
consistent.
47
49
48
50
### Message Broker Configuration
49
51
@@ -120,8 +122,8 @@ the `authorization_code` grant type. The callback URL is `https://<host>/oauth2/
120
122
> The first user to login will be assigned the `ADMIN` role, all other will be assigned the `USER` role. The roles can
121
123
> be changed by an admin user via the UI.
122
124
123
-
Be aware to configure your ingress / loadbalancer to set the `X-Forwarded-Proto` and `x-forwarded-for` header. Otherwise the correct redirect URL will not be generated.
124
-
125
+
Be aware to configure your ingress / loadbalancer to set the `X-Forwarded-Proto` and `x-forwarded-for` header. Otherwise the correct redirect URL will not be
|`STEADYBIT_EXPERIMENT_EXECUTION_MAXIMUM_DURATION`| The maximum total duration of an experiment. Default is `12h`|
190
192
|`STEADYBIT_EXPERIMENT_EXECUTION_EXPERIMENT_TIMEOUT`| The time after which the experiment execution should time out after the estimated duration is reached. Default is `15m`|
191
193
|`STEADYBIT_EXPERIMENT_EXECUTION_PREPARATION_TIMEOUT`| The time after which the experiment execution should time out if not all agents are prepared. Default is `60s`|
192
-
|`STEADYBIT_EXPERIMENT_EXECUTION_STEP_START_TIMEOUT`| The time after which an experiment step should time out if not started after triggering. Default is `180s`|
194
+
|`STEADYBIT_EXPERIMENT_EXECUTION_STEP_START_TIMEOUT`| The time after which an experiment step should time out if not started after triggering. Default is `180s`|
195
+
196
+
### Data Retention Settings
197
+
198
+
All retention settings are defined in a duration string. The duration string is a sequence of decimal numbers, each with a unit suffix, you can find
|`STEADYBIT_EXTERNAL_VENDOR_AMPLITUDE_LOCAL_STORAGE_RETENTION_PERIOD`| Max Age of Amplitude Tracking Events. (If Amplitude is enabled and the `mode` has set to `LOCAL_STORAGE`) |`amplitude_local_event`|`365d`|
204
+
|`STEADYBIT_EXTERNAL_VENDOR_AMPLITUDE_LOCAL_STORAGE_RETENTION_CRON`| -- Cron String for the cleanup job |`amplitude_local_event`|`0 15 5 1/1 * ? *` (every day at 5:15) |
205
+
|`STEADYBIT_AUDITLOG_RETENTION_PERIOD`| Max Age of Audit Logs. |`audit_log`|`90d`|
206
+
|`STEADYBIT_AUDITLOG_RETENTION_CRON`| -- Cron String for the cleanup job |`audit_log`|`0 20 5 1/1 * ? *` (every day at 5:20) |
207
+
|`STEADYBIT_EXPERIMENT_EXECUTION_ARTIFACT_RETENTION_PERIOD`| Max Age of Experiment Execution Artifacts. |`execution_artifact`| Keep until the execution is deleted |
208
+
|`STEADYBIT_EXPERIMENT_EXECUTION_ARTIFACT_RETENTION_CRON`| -- Cron String for the cleanup job |`execution_artifact`||
209
+
|`STEADYBIT_EXPERIMENT_EXECUTION_LOG_RETENTION_PERIOD`| Max Age of Experiment Execution Logs. |`execution_log_event`| Keep until the execution is deleted |
210
+
|`STEADYBIT_EXPERIMENT_EXECUTION_LOG_RETENTION_CRON`| -- Cron String for the cleanup job |`execution_log_event`||
211
+
|`STEADYBIT_EXPERIMENT_EXECUTION_METRIC_RETENTION_PERIOD`| Max Age of Experiment Execution Metrics. |`execution_metric_event`| Keep until the execution is deleted |
212
+
|`STEADYBIT_EXPERIMENT_EXECUTION_METRIC_RETENTION_CRON`| -- Cron String for the cleanup job |`execution_metric_event`||
213
+
|`STEADYBIT_EXPERIMENT_EXECUTION_SPAN_RETENTION_PERIOD`| Max Age of Experiment Execution Spans. |`execution_spans`|`28d`|
214
+
|`STEADYBIT_EXPERIMENT_EXECUTION_SPAN_RETENTION_CRON`| -- Cron String for the cleanup job |`execution_spans`|`0 25 5 1/1 * ? *` (every day at 5:25) |
215
+
|`STEADYBIT_EXPERIMENT_EXECUTION_RETENTION_PERIOD`| Max Age of Experiment Executions. |`experiment_execution` and more | No cleanup by default |
216
+
|`STEADYBIT_EXPERIMENT_EXECUTION_RETENTION_CRON`| -- Cron String for the cleanup job |`experiment_execution` and more ||
217
+
|`STEADYBIT_METRIC_RETENTION_PERIOD`| Max Age of Metrics. |`metric`|`365d`|
218
+
|`STEADYBIT_METRIC_RETENTION_CRON`| -- Cron String for the cleanup job |`metric`|`0 35 5 1/1 * ? *` (every day at 5:35) |
219
+
|`STEADYBIT_TARGETS_STATS_RETENTION_PERIOD`| Max Age of Target Stats. |`target_stats`|`7d`|
220
+
|`STEADYBIT_TARGETS_STATS_RETENTION_CRON`| -- Cron String for the cleanup job |`target_stats`|`0 30 5 1/1 * ? *` (every day at 5:30) |
0 commit comments