Skip to content

Commit ba28fbd

Browse files
committed
Update document
Signed-off-by: Kenji Okimoto <[email protected]>
1 parent 3fee59b commit ba28fbd

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,62 +33,69 @@ Or install it yourself as:
3333

3434
The key for part of multiline log.
3535

36-
**separator** (string)
36+
**separator** (string) (optional)
3737

3838
The separator of lines.
3939
Default value is `"\n"`.
4040

41-
**n\_lines** (integer)
41+
**n\_lines** (integer) (optional)
4242

4343
The number of lines.
4444
This is exclusive with `multiline_start_regex`.
4545

46-
**multiline\_start\_regexp**
46+
**multiline\_start\_regexp** (string) (optional)
4747

4848
The regexp to match beginning of multiline.
4949
This is exclusive with `n_lines.`
5050

51-
**multiline\_end\_regexp**
51+
**multiline\_end\_regexp** (string) (optional)
5252

5353
The regexp to match ending of multiline.
5454
This is exclusive with `n_lines.`
5555

56-
**continuous\_line\_regexp**
56+
**continuous\_line\_regexp** (string) (optional)
5757

5858
The regexp to match continuous lines.
5959
This is exclusive with `n_lines.`
6060

61-
**stream\_identity\_key** (string)
61+
**stream\_identity\_key** (string) (optional)
6262

6363
The key to determine which stream an event belongs to.
6464

65-
**flush\_interval** (integer)
65+
**flush\_interval** (integer) (optional)
6666

6767
The number of seconds after which the last received event log will be flushed.
6868
If specified 0, wait for next line forever.
6969

70-
**timeout\_label** (string)
70+
**timeout\_label** (string) (optional)
7171

7272
The label name to handle events caused by timeout.
7373

74-
**use\_first\_timestamp** (bool)
74+
**use\_first\_timestamp** (bool) (optional)
7575

7676
Use timestamp of first record when buffer is flushed.
7777
Default value is `false`.
7878

79-
**partial\_key** (string)
79+
**partial\_key** (string) (optional)
8080

8181
The field name that is the reference to concatenate records
8282

83-
**partial\_value** (string)
83+
**partial\_value** (string) (optional)
8484

8585
The value stored in the field specified by partial_key that represent partial log
8686

87-
**keep\_partial\_key** (bool)
87+
**keep\_partial\_key** (bool) (optional)
8888

8989
If true, keep partial_key in concatenated records
9090
Default value is `false`.
9191

92+
**use\_partial\_metadata** (bool) (optional)
93+
94+
Use partial metadata to concatenate multiple records
95+
96+
**keep\_partial\_metadata** (bool) (optional)
97+
98+
If true, keep partial metadata
9299

93100
## Usage
94101

0 commit comments

Comments
 (0)