From 997ab0011b7505b71213c4b8bf7ab2f17ef91fa3 Mon Sep 17 00:00:00 2001 From: Pablo Grill Date: Mon, 2 Aug 2021 10:53:39 -0300 Subject: [PATCH] Small fixs in the Readme. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e7f5b500..c4d6828f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ - [Supported video feeds formats](#supported-video-feeds-formats) - [Change the default configuration](#change-the-default-configuration) - [API usage](#api-usage) + - [Interacting with the processors' generated information](#interacting-with-the-processors-generated-information) - [Issues and Contributing](#issues-and-contributing) - [Contact Us](#contact-us) - [License](#license) @@ -694,6 +695,18 @@ The complete list of endpoints, with a short description and the signature speci ***NOTE*** Most of the endpoints update the config file given in the Dockerfile. If you don't have this file mounted (see section [Persisting changes](#persisting-changes)), these changes will be inside your container and will be lost after stopping it. + +### Interacting with the processors' generated information + +#### Generated information +The generated information can be split into 3 categories: + - `Raw data`: This is the most basic level of information. It only includes the results of the detector, classifier, tracker, and any configured post-processor step. All the video information generated (such as the live feed) is **stored inside the edge device and is never sent outside it**. + - `Metrics data`: **Generated in Lanthorn's cloud dashboard, only generated if you register a processor in your account.**. These include metrics related to occupancy, social-distancing, and facemask usage; aggregated by hour and day. When you enabled that functionality, some raw data needs to be sent from your device to our cloud engine. However, **only numeric and statistical data is sent. No video or personal information is sent from your device to Lanthorn's servers.** + - `Notifications`: Situations that require an immediate response (such as surpassing the maximum occupancy threshold for an area) and need to be notified ASAP. The currently supported notification channels are email and slack. Same that the metrics, this feature is supported by Lanthorn's cloud engine. + +#### Accessing and storing the information +Most of the information that is generated by the processor is stored (by default) inside the edge device for security reasons. However, the processor provides features to easily export or backup the data to another system if required. + ##### Storing the raw data The raw data storage is managed by the `SourceLogger` step. By default, only the `video_logger` and the `file_system_logger` are enabled. As both steps store the data inside the processor (by default the folder `/repo/data/processor/static/`), we strongly recommend mounting that folder to keep the data safe when the process is restarted ([Persisting changes](#persisting-changes)).