Add comments describing how watched files can be used for log output.
@@ -50,12 +50,24 @@ event:
host: 127.0.0.1
port: 9109
watch:
+ # Creates events from data written to files.
+ # Designed for monitoring log files, but capable of capturing
+ # any file writes.
# - type: file
# name: .*log.* # whitelist ex regex describing log file names
# value: .* # whitelist ex regex describing field values
+
+ # Creates events from data written to stdout, stderr, or both.
+ # May be most useful for capturing debug output from processes
+ # running in containerized environments.
# - type: console
# name: (stdout)|(stderr)
# value: .*
+
+ # Create events from libscope's metric (statsd) data. May be
+ # most useful for data which could overwhelm metric aggregation
+ # servers, either due to data volumes or dimensions (tags) with
+ # high cardinality.
# - type: metric
# name: .* # (net.*)|(.*err.*)
# field: ^[^h]+ # whitelist ex regex describing field names
