Skip to content

Logging system#

Logging guide#

Collecting logs is necessary for:

  • Providing VisionLabs technical support information for filing a ticket to find a problem;
  • Independent search for errors.

To receive complete information about an emergency situation when using Access, you must prepare and submit information to a VisionLabs representative about:

Settings file#

Settings file is a JSON file that contains information about the components used in Access.

The settings file becomes available for export after creating any component in Access.

1․ After creating any of the 4 types of components, click on to the right of the user's avatar and click the "Export Settings" button (Figure 8).

Export settings
Figure 8. Export settings

This will download a JSON file called vl-access_settings.json.

2․ Find the JSON on your local machine.

For Linux systems, the default is /home/\<username>/Downloads.

3․ Rename the settings file depending on the main services and devices used, for example, bolid+gate+fast.json.

Container logs#

Container log files contain all information about the operation of Access from the moment of startup (docker compose up) to the creation of logs, provided that the containers are running.

1․ Open the Access directory in the console.

For self-checking, make sure that this directory contains /db and docker-compose.yml (Figure 9).

Correct directory
Figure 9. Correct directory

2․ Activate debug mode: in the .env file, set the value of the variable DEBUG=1.

3․ Restart Access:

docker-compose down
docker-compose up

4․ Run the commands to record worker and fastapi containers logs:

The name of the log file must contain the names of the main components.

docker-compose logs worker &> worker_<имена сервисов/устройств, bolid+gate+fast>.log
docker-compose logs fastapi &> fastapi_<имена сервисов/устройств, bolid+gate+fast>.log

5․ Check for the generated .log files in the same directory.

Env file#

The .env file is located in the root folder of the distribution (in the same place as docker-compose.yml), but may not appear in the default UI.

1․ Locate the .env file to provide to your VisionLabs representative.

Information about the working environment#

Check the hardware and software properties of the working machine with the minimum ones (see Requirements).

To check the requirements, run the view commands:

1․ OS version of the local machine:

hostnamectl

2․ Docker/docker-compose version:

docker --version
docker-compose --version

3․ Information about hardware:

cat /proc/cpuinfo | grep "model name"

4․ Amount of free RAM:

free -h

5․ Amount of free physical memory:

df -h

Screenshots of UI#

Screenshots are only needed to find a problem with the UI:

  • the is_alive status of the component is displayed inadequately,
  • a component is displayed that should not exist (it was removed, but it “resurrected”),
  • an unreadable error appeared,
  • there are duplicates in the list in LUNA Clementine - the screenshot should include the dates of creation of the persons in the list,
  • in the events in LUNA Clementine something doesn’t match correctly, the event tag is incorrect,
  • other problems with the UI.

Tracking passages using trace_id#

A unique identifier, trace_id, is generated for each passage through the ACS. This identifier links all events related to one passage of a specific person: from the moment of detection to the provision of access through the turnstile.

Using trace_id allows you to quickly and accurately track the entire passage process, analyze delays at different stages and identify possible problems.

Using trace_id, you can track:

  • The time of receiving and processing events in the system;
  • Information about the recognition result: full name, card number, identifiers in the ACS and biometric system;
  • The time of execution of key operations: detection, recognition, sending data to the terminal and controller;
  • Other technical details related to processing the passage.

Tracking Luna Platform Event Passes#

1․ Open the Luna CLEMENTINE / Luna Platform interface and go to the Latest Events section. 2․ Find the oldest successful recognition event. 3․ Go to the card of this event by clicking on the arrow in the upper right corner next to the photo (Figure 10).

Successful recognition event
Figure 10. Successful recognition event

4․ Copy the eight-digit trace_id from the Tags field (Figure 11).

Location of trace_id in the event card
Figure 11. Location of trace_id in the event card

5․ Make sure that debug mode (debug) is enabled in LUNA Access 2 and DEBUG-level messages are present in the worker log. 6․ Find all logs related to this pass by running the command:

docker-compose logs fastapi worker | grep "<trace_id>"

Example (Figure 12).

Example log
Figure 12. Example log

How to find trace_id by person's full name#

1․ Make sure debug mode (debug) is enabled for LUNA Access 2 and there are DEBUG logs in the worker. 2․ Find the required log by full name:

docker-compose logs worker | grep -i "<name>"

3․ The found log will contain trace_id in the format trace <trace_id> (Figure 13).

Display trace_id in log
Figure 13. Display trace_id in log

4․ Use this trace_id to search all related logs:

docker-compose logs fastapi worker | grep "<trace_id>"

Search for an event in Luna Platform by trace_id#

The steps to display an event by trace_id in the UI are as follows (Figure 14).

Display trace_id in log
Figure 13. Display trace_id in log

1․ In Luna CLEMENTINE / Luna Platform, go to Recent Events. 2․ Click the filter icon on the right. 3․ Enter the trace_id value in the Tags field: 4․ Click the Filter button.