Skip to content

[DOCS] Fixes getting time features example in Painless in Transforms #59379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 13, 2020
Merged

[DOCS] Fixes getting time features example in Painless in Transforms #59379

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84a972c
[DOCS] Fixes Getting time features example.
szabosteve Jul 13, 2020
3895f8b
[DOCS] Changes the name of the section.
szabosteve Jul 13, 2020
094540f
[DOCS] Fine-tunes section title.
szabosteve Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 29 additions & 27 deletions docs/reference/transform/painless-examples.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ You can retrieve the last value in a similar way:

[discrete]
[[painless-time-features]]
==== Getting time features as scripted fields
==== Getting time features by using aggregations

This snippet shows how to extract time based features by using Painless in a
{transform}. The snippet uses an index where `@timestamp` is defined as a `date`
Expand All @@ -115,37 +115,39 @@ type field.
[source,js]
--------------------------------------------------
"aggregations": {
"script_fields": {
"hour_of_day": { <1>
"script": {
"lang": "painless",
"source": """
ZonedDateTime date = doc['@timestamp'].value; <2>
return date.getHour(); <3>
"""
}
},
"month_of_year": { <4>
"script": {
"lang": "painless",
"source": """
ZonedDateTime date = doc['@timestamp'].value; <5>
return date.getMonthValue(); <6>
"""
}
"avg_hour_of_day": { <1>
"avg":{
"script": { <2>
"source": """
ZonedDateTime date = doc['@timestamp'].value; <3>
return date.getHour(); <4>
"""
}
},
...
}
},
"avg_month_of_year": { <5>
"avg":{
"script": { <6>
"source": """
ZonedDateTime date = doc['@timestamp'].value; <7>
return date.getMonthValue(); <8>
"""
}
}
},
...
}
--------------------------------------------------
// NOTCONSOLE

<1> Contains the Painless script that returns the hour of the day.
<2> Sets `date` based on the timestamp of the document.
<3> Returns the hour value from `date`.
<4> Contains the Painless script that returns the month of the year.
<5> Sets `date` based on the timestamp of the document.
<6> Returns the month value from `date`.
<1> Name of the aggregation.
<2> Contains the Painless script that returns the hour of the day.
<3> Sets `date` based on the timestamp of the document.
<4> Returns the hour value from `date`.
<5> Name of the aggregation.
<6> Contains the Painless script that returns the month of the year.
<7> Sets `date` based on the timestamp of the document.
<8> Returns the month value from `date`.


[discrete]
Expand Down