Skip to main content
Help us improve Python packaging – donate today!

Tending your time-series indices in Elasticsearch

Project Description

# NOTICE

The 0.6 branch is fully usable, but deprecated. It remains for those not yet using Elasticsearch version 1.0. Bug fixes will be released as needed, but no further development will be done for the 0.6 branch. Please consider upgrading your Elasticsearch to version 1.0+ and use the current release branch of curator.

# Curator

Have time-series indices in Elasticsearch? This is the tool for you!

## Versioning

There are two branches for development - master and 0.6. Master branch is used to track all the changes for Elasticsearch 1.0 and beyond whereas 0.6 tracks Elasticsearch 0.90 and the corresponding elasticsearch-py version.

Releases with major version 1 (1.X.Y) are to be used with Elasticsearch 1.0 and later, 0.6 releases are meant to work with Elasticsearch 0.90.X.

## Usage

Install using pip

pip install elasticsearch-curator

See curator –help for usage specifics.

### Defaults

The default values for host, port and prefix are:

–host localhost –port 9200 -t (or –timeout) 30 -C (or –curation-style) time -T (or –time-unit) days -p (or –prefix) logstash- -s (or –separator) . –max_num_segments 2

If your values match these you do not need to include them. The prefix should be everything before the date string.

### Examples

Close indices older than 14 days, delete indices older than 30 days (See https://github.com/elasticsearch/curator/issues/1):

curator –host my-elasticsearch -d 30 -c 14

Keep 14 days of logs in elasticsearch:

curator –host my-elasticsearch -d 14

Disable bloom filter for indices older than 2 days, close indices older than 14 days, delete indices older than 30 days:

curator –host my-elasticsearch -b 2 -c 14 -d 30

Optimize (Lucene forceMerge) indices older than 2 days to 1 segment per shard:

curator –host my-elasticsearch -t 3600 -o 2 –max_num_segments 1

Keep 1TB of data in elasticsearch, show debug output:

curator –host my-elasticsearch -C space -g 1024 -D

Dry run of above:

curator –host my-elasticsearch -C space -g 1024 -D -n

## Documentation and Errata

If you need to close and delete based on different criteria, please use separate command lines, e.g.

curator –host my-elasticsearch -C space -g 1024 curator –host my-elasticsearch -c 15

When using optimize the current behavior is to wait until the optimize operation is complete before continuing. With large indices, this can result in timeouts with the default 30 seconds. It is recommended that you increase the timeout to at least 3600 seconds, if not more.

## Contributing

  • fork the repo
  • make changes in your fork
  • send a pull request!

## Origins

<https://logstash.jira.com/browse/LOGSTASH-211>

Release history Release notifications

History Node

5.5.1

History Node

5.5.0

History Node

5.4.1

History Node

5.4.0

History Node

5.3.0

History Node

5.2.0

History Node

5.1.2

History Node

5.1.1

History Node

5.0.4

History Node

5.0.3

History Node

5.0.2

History Node

5.0.1

History Node

4.3.1

History Node

4.3.0

History Node

4.2.6

History Node

4.2.5

History Node

4.2.4

History Node

4.2.3.post1

History Node

4.2.3

History Node

4.2.1

History Node

4.2.0

History Node

4.1.2

History Node

4.1.1

History Node

4.1.0

History Node

4.0.6

History Node

4.0.5

History Node

4.0.4

History Node

4.0.3

History Node

4.0.2

History Node

4.0.1

History Node

4.0.0

History Node

3.5.1

History Node

3.5.0

History Node

3.4.1

History Node

3.4.0

History Node

3.3.0

History Node

3.2.3

History Node

3.2.2

History Node

3.2.1

History Node

3.2.0

History Node

3.1.0

History Node

3.0.3

History Node

3.0.2

History Node

3.0.1

History Node

3.0.0

History Node

2.1.2

History Node

2.1.1

History Node

2.1.0

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.1.3

History Node

1.1.2

History Node

1.1.0

History Node

1.0.0

This version
History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
elasticsearch-curator-0.6.2.tar.gz (13.5 kB) Copy SHA256 hash SHA256 Source None Feb 18, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page