Mistake in reserve_time explanation in parser filter plugin
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start at the parser filter documentation at https://docs.fluentd.org/filter/parser#reserve_time and review the reserve_time explanation against the issue's expected output. Correct the wording so it distinguishes the original event time from the parsed timestamp for true and false, then verify that the examples and default behavior are consistent.
Written by the indexing model from the issue text.
Description
Describe the bug
I believe there is a mistake in the explanation for reserve_time property in parser filter plugin.
It is saying that when reserve_time: true, the time of the event is parsed from the specified parsing field (in that case, it is log).
However, it is the other way around (i.e. time of the event is kept and parsed time is discarded).
Link to the problematic documentation
https://docs.fluentd.org/filter/parser#reserve_time
Expected explanation
When reserve_time: true, the output is:
time:
2021-06-24 14:33:35.475115751 +0900 (It vary on parsed timestamp)
record:
{
"user": 1
}
When reserve_time: false (default value), the output is:
time:
2021-06-01 00:00:00.000000000 +0900
record:
{
"user": 1
}
Additional context
No response
- Dominant language
- CSS
- Stars
- 46
- Forks
- 136
- Avg merge
- 4h 47m
- Merged PRs (30d)
- 16
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from fluent/fluentd-docs-gitbook
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 74/100
fluent/fluentd-docs-gitbook#482 · 3 comments ·
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fluent/fluentd-docs-gitbook#442 · 2 comments · 2 reactions ·
-
enhancement good first issue
Difficulty 1/5 Under an hour Newbie friendliness 85/100
fluent/fluentd-docs-gitbook#434 · 1 comment ·
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
fluent/fluentd-docs-gitbook#419 · 1 comment · 1 reaction ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fluent/fluentd-docs-gitbook#250 · 3 comments ·
All issues in fluent/fluentd-docs-gitbook
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·