ISM settings

We don’t recommend changing these settings; the defaults should work well for most use cases.

Index State Management (ISM) stores its configuration in the .opendistro-ism-config index. Don’t modify this index without using the ISM API operations.

All settings are available using the OpenSearch _cluster/settings operation. None require a restart, and all can be marked persistent or transient.

SettingDefaultDescription
plugins.index_state_management.enabledTrueSpecifies whether ISM is enabled or not.
plugins.index_state_management.job_interval5 minutesThe interval at which the managed index jobs are run.
plugins.index_state_management.coordinator.sweep_period10 minutesHow often the routine background sweep is run.
plugins.index_state_management.coordinator.backoff_millis50 millisecondsThe backoff time between retries for failures in the ManagedIndexCoordinator (such as when we update managed indices).
plugins.index_state_management.coordinator.backoff_count2The count of retries for failures in the ManagedIndexCoordinator.
plugins.index_state_management.history.enabledTrueSpecifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.
plugins.index_state_management.history.max_docs2,500,000The maximum number of documents before rolling over the audit history index.
plugins.index_state_management.history.max_age24 hoursThe maximum age before rolling over the audit history index.
plugins.index_state_management.history.rollover_check_period8 hoursThe time between rollover checks for the audit history index.
plugins.index_state_management.history.rollover_retention_period30 daysHow long audit history indices are kept.
plugins.index_state_management.allow_listAll actionsList of actions that you can use.

Audit history indices

If you don’t want to disable ISM audit history or shorten the retention period, you can create an index template to reduce the shard count of the history indices:

  1. PUT _index_template/ism_history_indices
  2. {
  3. "index_patterns": [
  4. ".opendistro-ism-managed-index-history-*"
  5. ],
  6. "template": {
  7. "settings": {
  8. "number_of_shards": 1,
  9. "number_of_replicas": 0
  10. }
  11. }
  12. }