name
editname
editThis setting is used by the alias, create_index and snapshot, actions.
The value of this setting is the name of the alias, snapshot, or index,
depending on which action makes use of name
.
date math
editThis setting may be a valid Elasticsearch date math string.
A date math name takes the following form:
<static_name{date_math_expr{date_format|time_zone}}>
|
is the static text part of the name |
|
is a dynamic date math expression that computes the date dynamically |
|
is the optional format in which the computed date should be rendered. Defaults to |
|
is the optional time zone . Defaults to |
The following example shows different forms of date math names and the final form they resolve to given the current time is 22rd March 2024 noon utc.
Expression | Resolves to |
---|---|
|
|
|
|
|
|
|
|
|
|
strftime
editThis setting may alternately contain a valid Python strftime string. Curator will extract the strftime identifiers and replace them with the corresponding values.
The identifiers that Curator currently recognizes include:
Unit | Value |
---|---|
|
4 digit year |
|
2 digit year |
|
2 digit month |
|
2 digit week of the year |
|
2 digit day of the month |
|
2 digit hour of the day, in 24 hour notation |
|
2 digit minute of the hour |
|
2 digit second of the minute |
|
3 digit day of the year |
action: alias description: "Add/Remove selected indices to or from the specified alias" options: name: alias_name add: filters: - filtertype: ... remove: filters: - filtertype: ...
This option is required by the alias action, and has no default setting in that context.
For the create_index action, there is no default setting, but you can use strftime:
action: create_index description: "Create index as named" options: name: 'myindex-%Y.%m' # ...
or use Elasticsearch date math
action: create_index description: "Create index as named" options: name: '<logstash-{now/d+1d}>' # ...
to name your indices. See more in the create_index documenation.
action: snapshot description: >- Snapshot selected indices to 'repository' with the snapshot name or name pattern in 'name'. Use all other options as assigned options: repository: my_repository name: include_global_state: True wait_for_completion: True max_wait: 3600 wait_interval: 10 filters: - filtertype: ...
For the snapshot action, the default value of this setting is
curator-%Y%m%d%H%M%S