Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 6.65 KB

README.md

File metadata and controls

76 lines (54 loc) · 6.65 KB
Raw

Known Vulnerabilities

Log Interleaver

Log Interleaver can interleave log files based on their timestamp.

Features

Combine multiple log files in to a single ordered log.

  • Can use multiple regular expressions to extract the timestamps from log files, allowing files with different format times to be merged.
  • Fully customised date formats can be specified using date-fns format specifiers, see https://date-fns.org/v2.30.0/docs/parse.
  • Blank lines can be removed, enabling log files to be cleaned up.
  • Lines with invalid or missing timestamps can be either removed, or have the timestamp of the immediatly preceeding line assigned. If there is a block of invalid or missing timestamps, these lines will be kept together in the merged output.
  • Timestamps in the merged output can be re-written in ISO format.
  • Can merge an arbitary number of log files at once.
  • Can include the contents of the current active editor, if it is a log file.
  • The merged output can contain the file names of the source files, either prefixed or appended to each line.

Extension Settings

Setting Description Default
dropBlankLines Drop lines that only contain whitespace. true
dropInvalidTimestamp Drop lines where the timestamp cannot be extracted. true
addFileName Add the original filename to the merged log. Options off, start, end. off
timestampRegex The regular expression used to extract the timestamp from the log file. Multiple expressions can be added as a space separated list. ^([\d]{4}[-/][\d]{2}[-/][\d]{2}[\sT]{1}[\d]{2}:[\d]{2}:[\d]{2}(?:[\.,]{1}\d*)?(?:Z)?(?:(?<!Z)[\+-]{1}[\d]{2}:[\d]{2})?)
includeActiveEditor Include the contents of the active editor, if it is a log file. true
replaceTimestamps Replace timestamps with ISO formatted timestamps in the merged output. false
timeFormatSpecifications An array of time format specification to be tried if the format is not an ISO standard. Consists of a "name" and "format". The "name" is for reference only. The "format" is as described here: https://date-fns.org/v2.30.0/docs/parse

Notes on regular expressions

The timestampRegex is a space seperated list of expressions. All expressions must have exactly one match group, this is expected to be the timestamp. If your timestamps have some prefix, use a non-capturing group. For example: (?:abc).

The default regex should be able to extract an ISO formatted timestamp. So, all of the following should work by default:

  • 2019-11-14 15:36:00
  • 2019-11-14 15:36:00Z
  • 2019-11-14 15:36:00+01:00
  • 2019-11-14 15:36:00.123
  • 2019-11-14 15:36:00.123-07:00

The timestamps may include a T between the date and time.

Note that if no timezone information is supplied, the timezone will be assumed to be the same as the local machine.

Adding custom date formats

Additional formats can be added in the timeFormatSpecifications settings, for example:

{
    "name": "My time format",
    "format": "dd/LLL/yyyy:HH:mm:ss xxxx"
}

Note that the name field is not used. It simply for your reference. You can test out formats interactivley here: https://date-fns-interactive.netlify.app/

Usage

Select Log Interleaver from the command pallet, then select the files to interleave. A new editor will be opened with the interleaved logs. If the currently active editor contains a log file, this will be included in the interleaved log. This can be disabled in the settings.

Known Issues

Pleaes see the project issues page for current issues.