Skip to content

Logging system#

The logging system as part of the Logstash, Elasticsearch, and Kibana components allows you to record events in Access in detail.

The section describes the functions necessary in the context of Access logging, the algorithms for working with Elasticsearch are described in the official help.

The logging system is located at http://<ip_address_Access>:5601 (Figure 8).

Logging system home page
Figure 8. Logging system home page

To access logs in real time:

1․ Go to the Observability' category, theLogs' section (Figure 9).

Section Logs
Figure 9. Section Logs

2․ Open the Stream section (Figure 10).

Section Stream
Figure 10. Section Stream

Инструкция по сбору логов#

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 11).

Export settings
Figure 11. 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-test, make sure that there is /db and docker-compose.yml in this directory (Figure 12).

Correct directory
Figure 12. 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.