# Monitoring

Published 2023-04-03

# Introduction

This document describes the general principles of monitoring the proper operation of the ZeeBORN system. It concentrates on the easy detection of operation errors.

The document uses some system variables that are described at Glossary.

With the first implementation this feature concentrates on the reporting of errors found during the operation of the data replication related modules.

# Error Log

Whenever a condition is reached within the system that may have an impact on the further operation, an error is logged in a dedicated log file. This log file can be found at %zeeborndata%\logs\errors.log. This log file exists only if an error was previously detected. The existence of this file can be used as a first indicator for a problematic condition in the system.

IMPORTANT: Writing the error to the log file is usually the only action taken by the ZeeBORN system. It's up to the system administrator to implement suitable procedures for the error log file transmission and further handling.

# Log file format

Please note: all timestamps use UTC timezone.

The log file uses the following format:

yyyy-mm-dd hh-mm-ss: stationed;module;function;user;error message

The log file contains one line per error message.

Example:

2018-01-21 08:00:03;208;data transfer;import;Administrator;time gap detected while importing file 20180121040000.replic -- imported until 18.01.2018, transfer starts at 20.01.2018