IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Tutorial: Customize built-in ILM policies Index management in Kibana »
Elastic Docs ›Elasticsearch Guide [8.15] ›Data management

Tutorial: Automate rollover with ILM

edit

Tutorial: Automate rollover with ILM

edit

When you continuously index timestamped documents into Elasticsearch, you typically use a data stream so you can periodically roll over to a new index. This enables you to implement a hot-warm-cold architecture to meet your performance requirements for your newest data, control costs over time, enforce retention policies, and still get the most out of your data.

Data streams are best suited for append-only use cases. If you need to update or delete existing time series data, you can perform update or delete operations directly on the data stream backing index. If you frequently send multiple documents using the same _id expecting last-write-wins, you may want to use an index alias with a write index instead. You can still use ILM to manage and roll over the alias’s indices. Skip to Manage time series data without data streams.

Manage time series data with data streams

edit

To automate rollover and management of a data stream with ILM, you:

  1. Create a lifecycle policy that defines the appropriate phases and actions.
  2. Create an index template to create the data stream and apply the ILM policy and the indices settings and mappings configurations for the backing indices.
  3. Verify indices are moving through the lifecycle phases as expected.

When you enable index lifecycle management for Beats or the Logstash Elasticsearch output plugin, lifecycle policies are set up automatically. You do not need to take any other actions. You can modify the default policies through Kibana Management or the ILM APIs.

Create a lifecycle policy

edit

A lifecycle policy specifies the phases in the index lifecycle and the actions to perform in each phase. A lifecycle can have up to five phases: hot, warm, cold, frozen, and delete.

For example, you might define a timeseries_policy that has two phases:

  • A hot phase that defines a rollover action to specify that an index rolls over when it reaches either a max_primary_shard_size of 50 gigabytes or a max_age of 30 days.
  • A delete phase that sets min_age to remove the index 90 days after rollover.

The min_age value is relative to the rollover time, not the index creation time. Learn more.

You can create the policy through Kibana or with the create or update policy API. To create the policy from Kibana, open the menu and go to Stack Management > Index Lifecycle Policies. Click Create policy.

Create policy page
API example 
resp = client.ilm.put_lifecycle(
    name="timeseries_policy",
    policy={
        "phases": {
            "hot": {
                "actions": {
                    "rollover": {
                        "max_primary_shard_size": "50GB",
                        "max_age": "30d"
                    }
                }
            },
            "delete": {
                "min_age": "90d",
                "actions": {
                    "delete": {}
                }
            }
        }
    },
)
print(resp)
response = client.ilm.put_lifecycle(
  policy: 'timeseries_policy',
  body: {
    policy: {
      phases: {
        hot: {
          actions: {
            rollover: {
              max_primary_shard_size: '50GB',
              max_age: '30d'
            }
          }
        },
        delete: {
          min_age: '90d',
          actions: {
            delete: {}
          }
        }
      }
    }
  }
)
puts response
const response = await client.ilm.putLifecycle({
  name: "timeseries_policy",
  policy: {
    phases: {
      hot: {
        actions: {
          rollover: {
            max_primary_shard_size: "50GB",
            max_age: "30d",
          },
        },
      },
      delete: {
        min_age: "90d",
        actions: {
          delete: {},
        },
      },
    },
  },
});
console.log(response);
PUT _ilm/policy/timeseries_policy
{
  "policy": {
    "phases": {
      "hot": {                                
        "actions": {
          "rollover": {
            "max_primary_shard_size": "50GB", 
            "max_age": "30d"
          }
        }
      },
      "delete": {
        "min_age": "90d",                     
        "actions": {
          "delete": {}                        
        }
      }
    }
  }
}

The min_age defaults to 0ms, so new indices enter the hot phase immediately.

Trigger the rollover action when either of the conditions are met.

Move the index into the delete phase 90 days after rollover.

Trigger the delete action when the index enters the delete phase.

Create an index template to create the data stream and apply the lifecycle policy

edit

To set up a data stream, first create an index template to specify the lifecycle policy. Because the template is for a data stream, it must also include a data_stream definition.

For example, you might create a timeseries_template to use for a future data stream named timeseries.

To enable the ILM to manage the data stream, the template configures one ILM setting:

  • index.lifecycle.name specifies the name of the lifecycle policy to apply to the data stream.

You can use the Kibana Create template wizard to add the template. From Kibana, open the menu and go to Stack Management > Index Management. In the Index Templates tab, click Create template.

Create template page

This wizard invokes the create or update index template API to create the index template with the options you specify.

API example 
resp = client.indices.put_index_template(
    name="timeseries_template",
    index_patterns=[
        "timeseries"
    ],
    data_stream={},
    template={
        "settings": {
            "number_of_shards": 1,
            "number_of_replicas": 1,
            "index.lifecycle.name": "timeseries_policy"
        }
    },
)
print(resp)
response = client.indices.put_index_template(
  name: 'timeseries_template',
  body: {
    index_patterns: [
      'timeseries'
    ],
    data_stream: {},
    template: {
      settings: {
        number_of_shards: 1,
        number_of_replicas: 1,
        'index.lifecycle.name' => 'timeseries_policy'
      }
    }
  }
)
puts response
const response = await client.indices.putIndexTemplate({
  name: "timeseries_template",
  index_patterns: ["timeseries"],
  data_stream: {},
  template: {
    settings: {
      number_of_shards: 1,
      number_of_replicas: 1,
      "index.lifecycle.name": "timeseries_policy",
    },
  },
});
console.log(response);
PUT _index_template/timeseries_template
{
  "index_patterns": ["timeseries"],                   
  "data_stream": { },
  "template": {
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1,
      "index.lifecycle.name": "timeseries_policy"     
    }
  }
}

Apply the template when a document is indexed into the timeseries target.

The name of the ILM policy used to manage the data stream.

Create the data stream

edit

To get things started, index a document into the name or wildcard pattern defined in the index_patterns of the index template. As long as an existing data stream, index, or index alias does not already use the name, the index request automatically creates a corresponding data stream with a single backing index. Elasticsearch automatically indexes the request’s documents into this backing index, which also acts as the stream’s write index.

For example, the following request creates the timeseries data stream and the first generation backing index called .ds-timeseries-2099.03.08-000001.

resp = client.index(
    index="timeseries",
    document={
        "message": "logged the request",
        "@timestamp": "1591890611"
    },
)
print(resp)
response = client.index(
  index: 'timeseries',
  body: {
    message: 'logged the request',
    "@timestamp": '1591890611'
  }
)
puts response
const response = await client.index({
  index: "timeseries",
  document: {
    message: "logged the request",
    "@timestamp": "1591890611",
  },
});
console.log(response);
POST timeseries/_doc
{
  "message": "logged the request",
  "@timestamp": "1591890611"
}

When a rollover condition in the lifecycle policy is met, the rollover action:

  • Creates the second generation backing index, named .ds-timeseries-2099.03.08-000002. Because it is a backing index of the timeseries data stream, the configuration from the timeseries_template index template is applied to the new index.
  • As it is the latest generation index of the timeseries data stream, the newly created backing index .ds-timeseries-2099.03.08-000002 becomes the data stream’s write index.

This process repeats each time a rollover condition is met. You can search across all of the data stream’s backing indices, managed by the timeseries_policy, with the timeseries data stream name. Write operations should be sent to the data stream name, which will route them to its current write index. Read operations against the data stream will be handled by all its backing indices.

Check lifecycle progress

edit

To get status information for managed indices, you use the ILM explain API. This lets you find out things like:

  • What phase an index is in and when it entered that phase.
  • The current action and what step is being performed.
  • If any errors have occurred or progress is blocked.

For example, the following request gets information about the timeseries data stream’s backing indices:

resp = client.ilm.explain_lifecycle(
    index=".ds-timeseries-*",
)
print(resp)
response = client.ilm.explain_lifecycle(
  index: '.ds-timeseries-*'
)
puts response
const response = await client.ilm.explainLifecycle({
  index: ".ds-timeseries-*",
});
console.log(response);
GET .ds-timeseries-*/_ilm/explain

The following response shows the data stream’s first generation backing index is waiting for the hot phase’s rollover action. It remains in this state and ILM continues to call check-rollover-ready until a rollover condition is met.

{
  "indices": {
    ".ds-timeseries-2099.03.07-000001": {
      "index": ".ds-timeseries-2099.03.07-000001",
      "index_creation_date_millis": 1538475653281,
      "time_since_index_creation": "30s",        
      "managed": true,
      "policy": "timeseries_policy",             
      "lifecycle_date_millis": 1538475653281,
      "age": "30s",                              
      "phase": "hot",
      "phase_time_millis": 1538475653317,
      "action": "rollover",
      "action_time_millis": 1538475653317,
      "step": "check-rollover-ready",            
      "step_time_millis": 1538475653317,
      "phase_execution": {
        "policy": "timeseries_policy",
        "phase_definition": {                    
          "min_age": "0ms",
          "actions": {
            "rollover": {
              "max_primary_shard_size": "50gb",
              "max_age": "30d"
            }
          }
        },
        "version": 1,
        "modified_date_in_millis": 1539609701576
      }
    }
  }
}

The age of the index used for calculating when to rollover the index via the max_age

The policy used to manage the index

The age of the indexed used to transition to the next phase (in this case it is the same with the age of the index).

The step ILM is performing on the index

The definition of the current phase (the hot phase)

Manage time series data without data streams

edit

Even though data streams are a convenient way to scale and manage time series data, they are designed to be append-only. We recognise there might be use-cases where data needs to be updated or deleted in place and the data streams don’t support delete and update requests directly, so the index APIs would need to be used directly on the data stream’s backing indices. In these cases we still recommend using a data stream.

If you frequently send multiple documents using the same _id expecting last-write-wins, you can use an index alias instead of a data stream to manage indices containing the time series data and periodically roll over to a new index.

To automate rollover and management of time series indices with ILM using an index alias, you:

  1. Create a lifecycle policy that defines the appropriate phases and actions. See Create a lifecycle policy above.
  2. Create an index template to apply the policy to each new index.
  3. Bootstrap an index as the initial write index.
  4. Verify indices are moving through the lifecycle phases as expected.

Create an index template to apply the lifecycle policy

edit

To automatically apply a lifecycle policy to the new write index on rollover, specify the policy in the index template used to create new indices.

For example, you might create a timeseries_template that is applied to new indices whose names match the timeseries-* index pattern.

To enable automatic rollover, the template configures two ILM settings:

  • index.lifecycle.name specifies the name of the lifecycle policy to apply to new indices that match the index pattern.
  • index.lifecycle.rollover_alias specifies the index alias to be rolled over when the rollover action is triggered for an index.

You can use the Kibana Create template wizard to add the template. To access the wizard, open the menu and go to Stack Management > Index Management. In the Index Templates tab, click Create template.

Create template page

The create template request for the example template looks like this:

resp = client.indices.put_index_template(
    name="timeseries_template",
    index_patterns=[
        "timeseries-*"
    ],
    template={
        "settings": {
            "number_of_shards": 1,
            "number_of_replicas": 1,
            "index.lifecycle.name": "timeseries_policy",
            "index.lifecycle.rollover_alias": "timeseries"
        }
    },
)
print(resp)
const response = await client.indices.putIndexTemplate({
  name: "timeseries_template",
  index_patterns: ["timeseries-*"],
  template: {
    settings: {
      number_of_shards: 1,
      number_of_replicas: 1,
      "index.lifecycle.name": "timeseries_policy",
      "index.lifecycle.rollover_alias": "timeseries",
    },
  },
});
console.log(response);
PUT _index_template/timeseries_template
{
  "index_patterns": ["timeseries-*"],                 
  "template": {
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1,
      "index.lifecycle.name": "timeseries_policy",      
      "index.lifecycle.rollover_alias": "timeseries"    
    }
  }
}

Apply the template to a new index if its name starts with timeseries-.

The name of the lifecycle policy to apply to each new index.

The name of the alias used to reference these indices. Required for policies that use the rollover action.

Bootstrap the initial time series index with a write index alias

edit

To get things started, you need to bootstrap an initial index and designate it as the write index for the rollover alias specified in your index template. The name of this index must match the template’s index pattern and end with a number. On rollover, this value is incremented to generate a name for the new index.

For example, the following request creates an index called timeseries-000001 and makes it the write index for the timeseries alias.

resp = client.indices.create(
    index="timeseries-000001",
    aliases={
        "timeseries": {
            "is_write_index": True
        }
    },
)
print(resp)
const response = await client.indices.create({
  index: "timeseries-000001",
  aliases: {
    timeseries: {
      is_write_index: true,
    },
  },
});
console.log(response);
PUT timeseries-000001
{
  "aliases": {
    "timeseries": {
      "is_write_index": true
    }
  }
}

When the rollover conditions are met, the rollover action:

  • Creates a new index called timeseries-000002. This matches the timeseries-* pattern, so the settings from timeseries_template are applied to the new index.
  • Designates the new index as the write index and makes the bootstrap index read-only.

This process repeats each time rollover conditions are met. You can search across all of the indices managed by the timeseries_policy with the timeseries alias. Write operations should be sent towards the alias, which will route them to its current write index.

Check lifecycle progress

edit

Retrieving the status information for managed indices is very similar to the data stream case. See the data stream check progress section for more information. The only difference is the indices namespace, so retrieving the progress will entail the following api call:

resp = client.ilm.explain_lifecycle(
    index="timeseries-*",
)
print(resp)
response = client.ilm.explain_lifecycle(
  index: 'timeseries-*'
)
puts response
const response = await client.ilm.explainLifecycle({
  index: "timeseries-*",
});
console.log(response);
GET timeseries-*/_ilm/explain
« Tutorial: Customize built-in ILM policies Index management in Kibana »