Skip to content
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.

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

Use markdown table #13

Merged
merged 1 commit into from
Feb 4, 2021
Merged
Changes from all commits
Commits
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
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,12 @@ gives

## Parameters

* **kv_delimiter**: The delimiter for key-value pairs. By default, it is the regexp `/\t\s/+` (one or more whitespace/tabs). If the value starts and ends with the character `'/'`, the separator is interpreted to be a regexp. Else, it is interpreted to be a string. Hence,

- `kv_delimiter /a+/` splits on one or more "a"s
- `kv_delimiter a` splits on a single "a"

* **kv_char**: The string to split the key from the value. By default, it is "=".
* **time_key**: The time key field among the key-value pairs to be used as the time for the event. If missing or unparsable, the current time is used.
* **types**: The parameter to convert the values of key-value pairs. The syntax is `<key_name>:<type_name>`. For example, to convert the key "k1" into integer, write `types k1:integer`. For the `time` type, one can write `<key_name>:time:<time_format>` to convert the string into a time object. For example, to convert the string "my_time=12/31/2014 12:00:00", use `my_time:time:%m/%d/%Y %H:%M:%S`. This parameter is same as the one used for [in_tail](https://docs.fluentd.org/input/tail) and others (see under the "types" section over there).
|parameter|description|default|
|---|---|---|
|kv_delimiter|The delimiter for key-value pairs. If the value starts and ends with the character `'/'`, the separator is interpreted to be a regexp. Else, it is interpreted to be a string.<br> Hence,`kv_delimiter /a+/` splits on one or more "a"s, `kv_delimiter a` splits on a single "a"|`/\s+/`|
|kv_char|The string to split the key from the value|`"="`|
|time_key|The time key field among the key-value pairs to be used as the time for the event. If missing or unparsable, the current time is used|`time`|
|types|The parameter to convert the values of key-value pairs. The syntax is `<key_name>:<type_name>`.<br> For example, to convert the key "k1" into integer, write `types k1:integer`. For the `time` type, one can write `<key_name>:time:<time_format>` to convert the string into a time object. For example, to convert the string "my_time=12/31/2014 12:00:00", use `my_time:time:%m/%d/%Y %H:%M:%S`. This parameter is same as the one used for [in_tail](https://docs.fluentd.org/input/tail) and others (see under the "types" section over there)||

## License

Expand Down