docs: fix go.d/weblog parser config (#18037)
Ilya Mashchenko committed
Jun 29, 2024 at 20:09 UTC
80b03f68fe6cd54a9ef8e3153d70517db019e7f4
1 file changed
+26
-34
src/go/collectors/go.d.plugin/modules/weblog/metadata.yaml
+26
-34
@@ -127,11 +127,7 @@ modules:
127
description: Used to match against full original request URI. Pattern syntax in [matcher](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#supported-format).
128
default_value: ""
129
required: true
130
- - name: parser
131
- description: Log parser configuration.
132
- default_value: ""
133
- required: false
134
- - name: parser.log_type
130
+ - name: log_type
131
description: Log parser type.
132
default_value: auto
133
required: false
@@ -149,8 +145,7 @@ modules:
145
Syntax:
146
147
```yaml
152
- parser:
153
- log_type: auto
148
+ log_type: auto
149
```
150
151
If `log_type` parameter set to `auto` (which is default), weblog will try to auto-detect appropriate log parser and log format using the last line of the log file.
@@ -173,32 +168,32 @@ modules:
168
```
169
170
If you're using the default Apache/NGINX log format, auto-detect will work for you. If it doesn't work you need to set the format manually.
176
- - name: parser.csv_config
171
+ - name: csv_config
172
description: CSV log parser config.
173
default_value: ""
174
required: false
180
- - name: parser.csv_config.delimiter
175
+ - name: csv_config.delimiter
176
description: CSV field delimiter.
177
default_value: ","
178
required: false
184
- - name: parser.csv_config.format
179
+ - name: csv_config.format
180
description: CSV log format.
181
default_value: ""
182
required: false
183
detailed_description: ""
189
- - name: parser.ltsv_config
184
+ - name: ltsv_config
185
description: LTSV log parser config.
186
default_value: ""
187
required: false
193
- - name: parser.ltsv_config.field_delimiter
188
+ - name: ltsv_config.field_delimiter
189
description: LTSV field delimiter.
190
default_value: "\\t"
191
required: false
197
- - name: parser.ltsv_config.value_delimiter
192
+ - name: ltsv_config.value_delimiter
193
description: LTSV value delimiter.
194
default_value: ":"
195
required: false
201
- - name: parser.ltsv_config.mapping
196
+ - name: ltsv_config.mapping
197
description: LTSV fields mapping to **known fields**.
198
default_value: ""
199
required: true
@@ -208,18 +203,17 @@ modules:
203
> **Note**: don't use `$` and `%` prefixes for mapped field names.
204
205
```yaml
211
- parser:
212
- log_type: ltsv
213
- ltsv_config:
214
- mapping:
215
- label1: field1
216
- label2: field2
206
+ log_type: ltsv
207
+ ltsv_config:
208
+ mapping:
209
+ label1: field1
210
+ label2: field2
211
```
218
- - name: parser.json_config
212
+ - name: json_config
213
description: JSON log parser config.
214
default_value: ""
215
required: false
222
- - name: parser.json_config.mapping
216
+ - name: json_config.mapping
217
description: JSON fields mapping to **known fields**.
218
default_value: ""
219
required: true
@@ -229,18 +223,17 @@ modules:
223
> **Note**: don't use `$` and `%` prefixes for mapped field names.
224
225
```yaml
232
- parser:
233
- log_type: json
234
- json_config:
235
- mapping:
236
- label1: field1
237
- label2: field2
226
+ log_type: json
227
+ json_config:
228
+ mapping:
229
+ label1: field1
230
+ label2: field2
231
```
239
- - name: parser.regexp_config
232
+ - name: regexp_config
233
description: RegExp log parser config.
234
default_value: ""
235
required: false
243
- - name: parser.regexp_config.pattern
236
+ - name: regexp_config.pattern
237
description: RegExp pattern with named groups.
238
default_value: ""
239
required: true
@@ -252,10 +245,9 @@ modules:
245
Syntax:
246
247
```yaml
255
- parser:
256
- log_type: regexp
257
- regexp_config:
258
- pattern: PATTERN
248
+ log_type: regexp
249
+ regexp_config:
250
+ pattern: PATTERN
251
```
252
examples:
253
folding: