Skip to content

Commit b82ad2f

Browse files
AeternaxMarco Arts
andauthored
correct ISM job_interval description and default (opensearch-project#10545)
* correct job_interval description and default Signed-off-by: Marco Arts <[email protected]> * show correct format for default values Signed-off-by: Marco Arts <[email protected]> --------- Signed-off-by: Marco Arts <[email protected]> Co-authored-by: Marco Arts <[email protected]>
1 parent 37007eb commit b82ad2f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

_im-plugin/ism/settings.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ All settings are available using the OpenSearch `_cluster/settings` operation. N
1616
Setting | Default | Description
1717
:--- | :--- | :---
1818
`plugins.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
19-
`plugins.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
19+
`plugins.index_state_management.job_interval` | 5 | The interval (in minutes) at which the managed index jobs are run.
2020
`plugins.index_state_management.jitter` | 0.6 | A randomized delay that is added to a job's base run time to prevent a surge of activity from all indexes at the same time. A value of 0.6 means a delay of 0-60% of a job interval is added to the base interval. For example, if you have a base interval time of 30 minutes, a value of 0.6 means an amount anywhere between 0 to 18 minutes gets added to your job interval. Maximum is 1, which means an additional interval time of 100%. This maximum cannot exceed `plugins.jobscheduler.jitter_limit`, which also has a default of 0.6. For example, if `plugins.index_state_management.jitter` is set to 0.8, ISM uses `plugins.jobscheduler.jitter_limit` of 0.6 instead.
21-
`plugins.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
22-
`plugins.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indexes).
21+
`plugins.index_state_management.coordinator.sweep_period` | 10m | How often the routine background sweep is run.
22+
`plugins.index_state_management.coordinator.backoff_millis` | 50ms | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indexes).
2323
`plugins.index_state_management.coordinator.backoff_count` | 2 | The count of retries for failures in the `ManagedIndexCoordinator`.
2424
`plugins.index_state_management.history.enabled` | True | Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
25-
`plugins.index_state_management.history.max_docs` | 2,500,000 | The maximum number of documents before rolling over the audit history index.
26-
`plugins.index_state_management.history.max_age` | 24 hours | The maximum age before rolling over the audit history index.
27-
`plugins.index_state_management.history.rollover_check_period` | 8 hours | The time between rollover checks for the audit history index.
28-
`plugins.index_state_management.history.rollover_retention_period` | 30 days | How long audit history indexes are kept.
25+
`plugins.index_state_management.history.max_docs` | 2500000 | The maximum number of documents before rolling over the audit history index.
26+
`plugins.index_state_management.history.max_age` | 24h | The maximum age before rolling over the audit history index.
27+
`plugins.index_state_management.history.rollover_check_period` | 8h | The time between rollover checks for the audit history index.
28+
`plugins.index_state_management.history.rollover_retention_period` | 30d | How long audit history indexes are kept.
2929
`plugins.index_state_management.allow_list` | All actions | List of actions that you can use.

0 commit comments

Comments
 (0)