File (Source)

Use the File source to monitor files on your systems.

This source is typically use to search for specific strings such as “Error”, “Exception”, or “Failure” in log files.

Once configured, it reads content from local or remote files using either:

  • LOG mode for incremental reading (new entries only)
  • FLAT mode for full-file reading.

Format

connector:
  # ...
beforeAll: # <object>
  <sourceKey>: # <source-object>

monitors:
  <monitorType>: # <object>
    <job>: # <object>
      sources: # <object>
        <sourceKey>:
          type: file
          paths: # <string-array> | globs are supported (e.g. /opt/metricshub/logs/*.log)
          maxSizePerPoll: # <string> | size in bytes or shorthand (e.g. 5Mb); -1 for unlimited, default 5 MB
          mode: # <enum> | possible values: [ LOG, FLAT ]; default LOG
          forceSerialization: # <boolean>
          executeForEachEntryOf: # <object>
            source: # <string>
            concatMethod: # oneOf [ <enum>, <object> ] | possible values for <enum> : [ list, json_array, json_array_extended ]
              concatStart: # <string>
              concatEnd: # <string>
          computes: # <compute-object-array>

Each source must define a set of computes, as described in the Computes Section[1].

No results.