hotrod-job-es-index-cleanup

Hotrob job to close or delete ElasticSearch indexes

Install

npm install hotrod-job-es-index-cleanup

Usage

var esHost = 'localhost:9200';
var job = require('hotrod-job-es-index-cleanup')(esHost, {
    index: 'logstash-*',
    skip: 30,
    action: 'close',
    whatIf: true  
});

Configuration

require('hotrod-job-es-index-cleanup')(esHost, options)

• esHost - the ElasticSearch host
• options:
  • index - the index name pattern. All indices names matching this pattern will be fetched and then sorted using Array.sort
  • indexNameCompare - optional custom sort function to pass to Array.sort
  • skip - how many results to skip (skip is applied after sorting)
  • action - either 'close' or 'delete'
  • whatIf - If true, will not perform any index operation but will resolve with a message saying what action(s) would be performed

Running

Run this job with the hotrod-jobs package.

License

The MIT License (MIT)

Copyright (c) Panoptix CC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.