From a364a6a9faeb6aa290b790f3dec74e92b8670534 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 25 Mar 2021 15:08:23 -0700 Subject: [PATCH] add note regarding calculated timestamps --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 273d819e..eaffa9fb 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,9 @@ The `jc` parsers can also be used as python modules. In this case the output wil ``` Two representations of the data are possible. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of `None` are converted to JSON `null`, known boolean values are converted, and, in some cases, additional semantic context fields are added. +> Note: Some parsers have calculated epoch timestamp fields added to the output. Unless a timestamp field name has a `_utc` suffix it is considered naive. (i.e. based on the local timezone of the system the `jc` parser was run on). +If a UTC timezone can be detected in the text of the command output, the timestamp will be timezone aware and have a `_utc` suffix to the key name. (e.g. `epoch_utc`) + To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`. Schemas for each parser can be found in the [`docs/parsers`](https://github.com/kellyjonbrazil/jc/tree/master/docs/parsers) folder.