@@ -27,68 +27,104 @@ Or install it yourself as:
2727
2828 $ gem install fluent-plugin-concat
2929
30+ ## Plugin helpers
31+
32+ * [ timer] ( https://docs.fluentd.org/v1.0/articles/api-plugin-helper-timer )
33+ * [ event_emitter] ( https://docs.fluentd.org/v1.0/articles/api-plugin-helper-event_emitter )
34+
35+ * See also: [ Filter Plugin Overview] ( https://docs.fluentd.org/v1.0/articles/filter-plugin-overview )
36+
3037## Configuration
3138
32- ** key** (string) (required)
39+ ### key (string) (required)
3340
3441The key for part of multiline log.
3542
36- ** separator** (string)
43+ ### separator (string) (optional )
3744
3845The separator of lines.
39- Default value is ` "\n" ` .
4046
41- ** n\_ lines** (integer)
47+ Default value: ` "\n" ` .
48+
49+ ### n\_ lines (integer) (optional)
4250
4351The number of lines.
44- This is exclusive with ` multiline_start_regex ` .
52+ This is exclusive with following parameters:
4553
46- ** multiline\_ start\_ regexp**
54+ * ` multiline_start_regexp `
55+ * ` multiline_end_regexp `
56+ * ` partial_key `
57+
58+ ### multiline\_ start\_ regexp (string) (optional)
4759
4860The regexp to match beginning of multiline.
49- This is exclusive with ` n_lines. `
61+ This is exclusive with following parameters:
62+
63+ * ` n_lines `
64+ * ` partial_key `
5065
51- ** multiline\_ end\_ regexp**
66+ ### multiline\_ end\_ regexp (string) (optional)
5267
5368The regexp to match ending of multiline.
54- This is exclusive with ` n_lines. `
69+ This is exclusive with following parameters:
5570
56- ** continuous\_ line\_ regexp**
71+ * ` n_lines `
72+ * ` partial_key `
73+
74+ ### continuous\_ line\_ regexp (string) (optional)
5775
5876The regexp to match continuous lines.
59- This is exclusive with ` n_lines. `
6077
61- ** stream\_ identity\_ key** (string)
78+ ### stream\_ identity\_ key (string) (optional)
79+
80+ The key to determine which stream an event belongs to
6281
63- The key to determine which stream an event belongs to.
82+ ### flush \_ interval (time) (optional)
6483
65- ** flush \_ interval ** (integer)
84+ The interval between data flushes, 0 means disable timeout (wait next line forever).
6685
67- The number of seconds after which the last received event log will be flushed.
68- If specified 0, wait for next line forever.
86+ Default value: ` 60 ` .
6987
70- ** timeout\_ label** (string)
88+ ### timeout\_ label (string) (optional )
7189
7290The label name to handle events caused by timeout.
7391
74- ** use\_ first\_ timestamp** (bool)
92+ ### use\_ first\_ timestamp (bool) (optional )
7593
7694Use timestamp of first record when buffer is flushed.
77- Default value is ` false ` .
7895
79- ** partial\_ key** (string)
96+ ### partial\_ key (string) (optional)
97+
98+ The field name that is the reference to concatenate records.
99+ This is exclusive with following parameters:
100+
101+ * ` n_lines `
102+ * ` multiline_start_regexp `
103+ * ` multiline_end_regexp `
104+
105+ ### partial\_ value (string) (optional)
106+
107+ The value stored in the field specified by partial_key that represent partial log.
108+
109+ ### keep\_ partial\_ key (bool) (optional)
110+
111+ If true, keep partial_key in concatenated records.
112+
113+ Default value: ` false ` .
114+
115+ ### buffer_limit_size (size) (optional)
80116
81- The field name that is the reference to concatenate records
117+ The max size of each buffer
82118
83- ** partial \_ value ** (string)
119+ Default value: ` 512000 ` .
84120
85- The value stored in the field specified by partial_key that represent partial log
121+ ### buffer_overflow_method (enum) (optional)
86122
87- ** keep \_ partial \_ key ** (bool)
123+ The method if overflow buffer
88124
89- If true, keep partial_key in concatenated records
90- Default value is ` false ` .
125+ Available values: ignore, truncate, drop, new
91126
127+ Default value: ` ignore ` .
92128
93129## Usage
94130
0 commit comments