pipeline: outputs: kinesis: update doc for time_key_format. #981
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Claych please add spaces in commit and title: pipeline:outputs:firehose:update |
pipeline/outputs/kinesis.md
Outdated
| @@ -19,7 +19,7 @@ See [here](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e706b | |||
| | region | The AWS region. | | |||
| | stream | The name of the Kinesis Streams Delivery stream that you want log records sent to. | | |||
| | time\_key | Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis. | | |||
| | time\_key\_format | strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. This option is used with time\_key. | | |||
| | time\_key\_format | strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. Now can support millisecond with '%3N' and support nanosecond with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S:%3N'. This option is used with time\_key. | | |||
There was a problem hiding this comment.
Docs are timeless, so do not use words like "now". Just "Supports millisecond with..."
There was a problem hiding this comment.
'%Y-%m-%dT%H:%M:%S:%3N'
Should it be .%3N since that is what most users would configure?
There was a problem hiding this comment.
sure, will delete "now" and change ":" to "."
Claych
force-pushed
the
streams-clay-time-key
branch
from
00a078f to
f2fe8a6
Compare
Merged
6 tasks
pipeline/outputs/kinesis.md
Outdated
| @@ -19,7 +19,7 @@ See [here](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e706b | |||
| | region | The AWS region. | | |||
| | stream | The name of the Kinesis Streams Delivery stream that you want log records sent to. | | |||
| | time\_key | Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis. | | |||
| | time\_key\_format | strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. This option is used with time\_key. | | |||
| | time\_key\_format | strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'.Support millisecond with '%3N' and support nanosecond with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S.%3N'. This option is used with time\_key. | | |||
There was a problem hiding this comment.
grammar/language nit: I believe it reads better as "Supports millisecond precision '%3N' and supports nanosecond precision with..."
Signed-off-by: Clay Cheng <[email protected]>
Claych
force-pushed
the
streams-clay-time-key
branch
from
f2fe8a6 to
2f129d1
Compare
Claych
changed the title
PettitWesley
approved these changes
Nov 21, 2022
Merged
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Clay Cheng [email protected]