curator job from logsearch/211.0.3

This job runs Curator process to purge outdated info from Elasticsearch cluster

Github source: 03b1ebc or master branch

Properties¶

curator¶

actions¶

List of Elasticsearch Curator actions in YAML format.

Example

|+
  - action: delete_indices
    description: >-
      Delete indices older than 45 days (based on index name), for logstash-
      prefixed indices. Ignore the error if the filter does not result in an
      actionable list of indices (ignore_empty_list) and exit cleanly.
    options:
      ignore_empty_list: True
      disable_action: True
    filters:
    - filtertype: pattern
      kind: prefix
      value: logstash-
    - filtertype: age
      source: name
      direction: older
      timestring: '%Y.%m.%d'
      unit: days
      unit_count: 45

elasticsearch¶

hosts¶

IP address of elasticsearch host to proxy requests for (eg, 127.0.0.1)

Default

- 127.0.0.1

port¶

Port address of elasticsearch host to proxy requests for (eg, 9200)

Default

9200

execute¶

daily¶

Execute Curator daily?

Default

false

hourly¶

Execute Curator hourly?

Default

true

weekly¶

Execute Curator weekly?

Default

false

logformat¶

This should default, json, logstash.

Default

default

loglevel¶

Set the minimum acceptable log severity to display.

Default

INFO

purge_logs¶

retention_period¶

The value of this setting will be used as a multiplier for unit

Default

30

unit¶

One of the following values: seconds, minutes, hours, days, weeks, months, years

Default

days

elasticsearch¶

cloud¶

aws¶

bucket¶

Bucket name on S3 where to keep snapshots

Default

""

path_repo¶

Shared file system to store snapshots. In order to register the shared file system repository it is necessary to mount the same shared filesystem to the same location on all master and data nodes.

Default

""

snapshots¶

repository¶

Repository name for automatic snapshots

Templates¶

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/curator/ directory (learn more).

• bin/pre-start (from bin/pre-start)
• bin/run-curator (from bin/run-curator)
• config/actions.yml (from config/actions.yml.erb)
• config/config.yml (from config/config.yml.erb)

Packages¶

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.

• curator
• python3