Модули/Архивация на ФС - OpenSCADAWiki

# Модули/Архивация на ФС

This page is a translated version of the page Modules/FSArch and the translation is 98% complete.

English • ‎mRussian • ‎Українська

Модуль | Имя | Версия | Лицензия | Источник | Языки | Платформы | Тип | Автор | Описание
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
FSArch | Архиватор на файловую систему | 3.8 | GPL2 | arh_FSArch.so | en,uk,ru,de | x86,x86_64,ARM | Архив | Роман Савоченко | Модуль архиватора. Предоставляет функции архивирования сообщений и значений на файловую систему.

Модуль предназначен для архивирования сообщений и значений OpenSCADA на файловую систему.

Любая SCADA система предоставляет возможность архивирования собранных данных, т.е. формирование истории изменения (динамики) процессов. Архивы условно можно разделить на два типа: архивы сообщений и архивы значений.

Особенностью архивов сообщений является то, что архивируются так называемые события. Характерным признаком события является его время возникновения. Архивы сообщений обычно используются для архивирования сообщений программы, т.е. ведение логов и протоколов. В зависимости от источника, сообщения могут классифицироваться по различным критериям. Например, это могут быть: протоколы аварийных ситуаций, протоколы действий операторов, протоколы сбоев связи и др.

Особенностью архивов значений является их периодичность, определяемая промежутком времени между двумя смежными значениями. Архивы значений применяются для архивирования истории непрерывных процессов. Поскольку процесс непрерывный то и архивировать его можно только путём введения понятия квантования времени опроса, поскольку иначе мы получаем архивы бесконечных размеров ввиду непрерывности самой природы процесса. Кроме этого, практически мы можем получать значения с периодом ограниченным самими источниками данных. Например, довольно качественные источники данных в промышленности редко позволяют получать данные с частотой более 1кГц. И это без учёта самих датчиков, имеющих ещё менее качественные характеристики.

Для ведения архивов в OpenSCADA предусмотрена подсистема "Архивы-История". Данная подсистема, в соответствии с типами архивов, состоит из двух частей: архив сообщений и архивы значений. Подсистема, в целом, является модульной, что позволяет создавать архивы, основанные на различной природе и способах хранения данных. Данный модуль предоставляет механизм архивирования на файловую систему как для потока сообщений, так и для потока значений.

## 1 Архиватор сообщений

Архивы сообщений формируются архиваторами, которых может быть множество и с индивидуальными настройками, что позволяет разделять архивирование различных классов сообщений.

Архиватор сообщений этого модуля позволяет хранить данные как в файлах формата языка XML, так и в формате плоского текста. Язык разметки XML является стандартным форматом, который с лёгкостью понимают многие сторонние приложения. Однако, открытие и разбор файлов в таком формате требует значительных ресурсов. С другой стороны, формат плоского текста требует значительно меньше ресурсов, хотя и не является унифицированным, а также требует знания его структуры для стороннего разбора.

В любом случае, поддерживаются оба формата и пользователь может выбрать любой из них в соответствии со своими требованиями.

Файлы архивов именуются архиваторами согласно даты первого сообщения в архиве, например, так: "2018-05-03 17.57.03.msg".

Файлы архивов могут ограничиваться по размеру и времени. После превышения лимита создаётся новый файл. Максимальное количество файлов в директории архиватора также может быть ограничено. После превышения лимита на количество файлов, старые файлы начнут удаляться!

С целью оптимизации использования дискового пространства архиваторы поддерживают упаковку старых архивов упаковщиком gzip. Упаковка производится после продолжительного неиспользования архива.

При использовании архивов в формате языка XML, соответствующие файлы загружаются целиком! Для выгрузки неиспользуемых продолжительное время архивов применяется таймаут доступа к архиву, после превышения которого архив выгружается из памяти, а затем и пакуется.

Модулем предоставляются дополнительные параметры настройки процесса архивирования, рисунок 1.

Рис.1. Дополнительные параметры настройки процесса архивирования сообщений.

В число этих параметров входят:

- Файлы архивов в XML — включает архивирование сообщений в файлы XML-формата, вместо плоского текста. Использование в архивировании XML-формата требует больше оперативной памяти поскольку необходима: полная загрузка файла, XML-разбор и хранение в памяти на момент использования.
- Предотвращать дубликаты — включает проверку наличия дублирующих сообщений во время помещения сообщения в архив. При наличии дубликата сообщение не помещается в архив. Данная функция несколько повышает время записи в архив, но, в случаях помещения сообщений в архив обратным числом из внешних источников, позволяет исключить дублирование.
- Считать дубликатами и предотвращать с равным временем, категорией, уровнем — включает проверку наличия дублирующих сообщений во время помещения сообщения в архив. Дублирующими считаются сообщения с равным временем, категорией и уровнем. Новое дублирующее сообщение заменяет в архиве старое. Данная функция в основном полезна для изменения текста записи сообщения, например, для статуса нарушения.
- Максимальный размер файла архива, в килобайтах — устанавливает ограничение на размер одного файла архива. Отключить ограничение можно установив параметр в ноль.
- Максимальное количество файлов — ограничивает максимальное количество файлов архива и, совместно с размером отдельного файла, определяет размер архива на диска. Полностью снять это ограничение можно установив параметр в ноль.
- Размер файла по времени, в днях — устанавливает ограничение на размер одного файла архива по времени.
- Таймаут упаковки файлов, в минутах — устанавливает промежуток времени по истечению которого, и в случае отсутствия обращений, файлы архивов будут упаковываться gzip архиватором. Установить в ноль для отключения упаковки gzip.
- Период проверки архивов, в минутах — устанавливает периодичность проверки архивов на предмет появления или удаления в директории файлов архивов, а также превышение лимитов и удаление старых файлов архивов.
- Использовать информационный файл для упакованных архивов — указывает на необходимость создания файла с информацией о запакованных gzip-архиватором файлах архива. При копировании файлов архива на другую станцию этот информационный файл позволяют ускорить процесс первого запуска целевой станции, за счёт исключения необходимости распаковки gzip-архивов для получения информации.
- Проверить директорию архиватора сейчас — команда, которая позволяет запустить проверку архивов немедленно, например, после ручного изменения в директории архиватора.

Для контроля за файлами архиватора Вы можете посмотреть во вкладке "Файлы", рисунок 2.

Рис.2. Вкладка "Файлы" архиватора сообщений.

### 1.1 Формат файлов архива сообщений

В таблице ниже приведен синтаксис файла архива, построенного на XML-языке:

Тег | Описание | Атрибуты | Содержит
--- | --- | --- | ---
FSArch | Корневой элемент. Идентифицирует файл, как принадлежащий данному модулю. | Version — версия файла архива; Begin — время начала архива (hex - UTC в секундах от 01/01/1970); End — время окончания архива (hex - UTC в секундах от 01/01/1970). | (m)
m | Тег отдельного сообщения. | tm — время создания сообщения (hex - UTC в секундах от 01/01/1970); tmu — микросекунды времени сообщения; lv — уровень сообщения; cat — категория сообщения. | Текст сообщения

Архивный файл на основе плоского текста состоит из:

- заголовок в формате: "FSArch {vers} {charset} {beg_tm} {end_tm}"; Где:
  - vers — версия модуля архивирования;
  - charset — кодировка файла, обычно UTF-8;
  - beg_tm — UTC время начала архива с эпохи 01.01.1970, в шестнадцатеричной форме;
  - end_tm — UTC время конца файла архива с эпохи 01.01.1970, в шестнадцатеричной форме.
- записи сообщений в формате: "{tm} {lev} {cat} {mess}"; Где:
  - tm — время сообщения в виде: "{utc_sec}:{usec}", где:
    - utc_sec — UTC время с эпохи 01.01.1970, в шестнадцатеричной форме;
    - usec — микросекунды времени, в десятичной форме.
  - lev — уровень важности сообщения;
  - cat — категория сообщения;
  - mess — текст сообщения.

Текст сообщения и категория кодируются с целью исключения символов разделителей — символ пробела.

### 1.2 Пример файла архива сообщения

Пример содержимого архивного файла в формате языка XML:

    <?xml version='1.0' encoding='UTF-8' ?>
    <FSArch Version="3.2.0" Begin="4a27dfbc" End="4a28c990">
    <m tm="4a28c982" tmu="905587" lv="4" cat="/sub_DAQ/mod_DiamondBoards/">Ошибка dscInit.</m>
    <m tm="4a28c990" tmu="595549" lv="4" cat="/sub_Transport/mod_Sockets/out_HDDTemp/">Ошибка подключения к Internet сокету: Операция выполняется в данный момент!</m>
    </FSArch>

Пример содержимого архивного файла в формате плоского текста:

    FSArch 3.2.0    UTF-8 4a27dfbb 4a28c991
    4a28c98f:432619 1 / Запуск!
    4a28c98f:432858 1 /sub_Transport/ Пуск%20подсистемы.
    4a28c98f:455400 1 /sub_DAQ/mod_DAQGate/cntr_test/ Включение%20контроллера!
    4a28c98f:457360 1 /sub_DAQ/mod_ModBus/cntr_testTCP/ Включение%20контроллера!
    4a28c98f:460691 1 /sub_DAQ/mod_ModBus/cntr_testRTU/ Включение%20контроллера!
    4a28c98f:464227 1 /sub_DAQ/mod_BlockCalc/cntr_Anast1to2node/ Включение%20контроллера!
    4a28c98f:680767 1 /sub_DAQ/mod_BlockCalc/cntr_KM102cntr/ Включение%20контроллера!
    4a28c98f:705683 1 /sub_DAQ/mod_BlockCalc/cntr_Anast1to2node_cntr/ Включение%20контроллера!
    4a28c98f:753659 1 /sub_DAQ/mod_BlockCalc/cntr_KM101/ Включение%20контроллера!
    4a28c98f:905073 1 /sub_DAQ/mod_BlockCalc/cntr_KM102/ Включение%20контроллера!
    4a28c990:81670 1 /sub_DAQ/mod_BlockCalc/cntr_KM201/ Включение%20контроллера!
    4a28c990:206208 1 /sub_DAQ/mod_BlockCalc/cntr_КМ202/ Включение%20контроллера!
    4a28c990:333471 1 /sub_DAQ/mod_BlockCalc/cntr_KM301/ Включение%20контроллера!
    4a28c990:457490 1 /sub_DAQ/mod_BlockCalc/cntr_KM302/ Включение%20контроллера!
    4a28c990:591702 1 /sub_DAQ/mod_System/cntr_AutoDA/ Включение%20контроллера!
    4a28c990:595549 4 /sub_Transport/mod_Sockets/out_HDDTemp/ Ошибка%20подключения%20к%20Internet%20сокету:%20Операция%20выполняется%20в%20данный%20момент!
    4a28c990:618617 1 /sub_DAQ/mod_SoundCard/cntr_test/ Включение%20контроллера!
    4a28c990:621487 1 /sub_DAQ/mod_LogicLev/cntr_experiment/ Включение%20контроллера!
    4a28c990:729323 1 /sub_DAQ/mod_JavaLikeCalc/cntr_testCalc/ Включение%20контроллера!
    4a28c990:733434 1 /sub_DAQ/mod_Siemens/cntr_test/ Включение%20контроллера!
    4a28c990:754368 1 /sub_DAQ/mod_DAQGate/cntr_test/ Включение%20контроллера!
    4a28c990:786925 1 /sub_Archive/ Пуск%20подсистемы.
    4a28c990:955967 1 /sub_DAQ/mod_BlockCalc/cntr_Anast1to2node/ Запуск%20контроллера!
    4a28c990:957251 1 /sub_DAQ/mod_BlockCalc/cntr_KM102cntr/ Запуск%20контроллера!
    4a28c990:957636 1 /sub_DAQ/mod_BlockCalc/cntr_Anast1to2node_cntr/ Запуск%20контроллера!
    4a28c990:958006 1 /sub_DAQ/mod_BlockCalc/cntr_KM101/ Запуск%20контроллера!
    4a28c990:958637 1 /sub_DAQ/mod_BlockCalc/cntr_KM102/ Запуск%20контроллера!
    4a28c990:959268 1 /sub_DAQ/mod_BlockCalc/cntr_KM201/ Запуск%20контроллера!
    4a28c990:959875 1 /sub_DAQ/mod_BlockCalc/cntr_КМ202/ Запуск%20контроллера!
    4a28c990:961261 1 /sub_DAQ/mod_BlockCalc/cntr_KM301/ Запуск%20контроллера!
    4a28c990:961919 1 /sub_DAQ/mod_BlockCalc/cntr_KM302/ Запуск%20контроллера!
    4a28c990:963775 1 /sub_DAQ/mod_System/cntr_AutoDA/ Запуск%20контроллера!
    4a28c990:966980 1 /sub_DAQ/mod_LogicLev/cntr_experiment/ Запуск%20контроллера!
    4a28c991:26791 1 /sub_Archive/ Пуск%20подсистемы.
    4a28c991:28489 1 /sub_UI/mod_VCAEngine/ Старт%20модуля.

## 2 Архиватор значений

Архивы значений формируются архиваторами значений индивидуально для каждого зарегистрированного архива. Архиваторов может быть множество и с индивидуальными настройками, которые позволяющими разделить архивы по различным параметрам, например, по точности и глубине.

Архив значений является независимым компонентом, который включает буфер, обрабатываемый архиваторами. Основным параметром архива значения является источник данных. В роли источника данных могут выступать атрибуты параметров подсистемы "Сбор данных", а также другие внешние источники данных (пассивный режим). Другими источниками данных могут быть: сетевые архиваторы удалённых OpenSCADA станций, среда программирования OpenSCADA и др. Не менее важными параметрами архива являются параметры его буфера. От параметров буфера зависит возможность работы архиваторов. Так, периодичность значений в буфере должна быть не больше периодичности самого быстрого архиватора, а размер буфера не менее двойного размера для самого медленного архиватора. В противном случае возможны потери данных.

Общая схема архивирования значений наглядно изображена на рисунке 3.

Рис.3. Общая схема процесса архивирования значений.

Файлы архивов именуются архиваторами в соответствии с датой первого значения в архиве и идентификатора архива, например, так: "CPULoad_load 2018-04-03 19.13.52.val".

Файлы архивов могут ограничиваться по времени. После превышения лимита создаётся новый файл. Максимальное количество файлов в директории архиватора также может ограничиваться. После превышения лимита на количество файлов старые файлы начнут удаляться!

С целью экономии дискового пространства архиваторы поддерживают упаковку, в дополнении к последовательной упаковке, старых архивов упаковщиком gzip. Упаковка производится после продолжительного неиспользования архива. Для обеспечения возможности быстрого подключения больших архивов к другой станции можно для упакованных файлов включить использование информационного файла, что предотвратит предварительную распаковку всех файлов на другой станции.

Модулем предоставляются дополнительные параметры настройки процесса архивирования, рисунок 4.

Рис.4. Дополнительные параметры настройки процесса архивирования значений.

These additional parameters:

- Time size of the archive files, in hours — the parameter is set automatically when the value periodicity of the archiver is changed and is generally proportional to the periodicity of the values of the archiver.

  Large files of the archive will be longer processed due to the long unpacking of gzip files and initial indexing, while accessing archives is deeply in the history.

- Maximum number of files per archive — limits the maximum number of archive files and, together with the size of a single file, determines the size of the archive on the disk. Completely remove this restriction by setting the parameter to zero.
- Maximum size of all archives, in megabytes — sets limits on the maximum occupied volume of disk space for files of all archives of the archivers. The check is carried out with the periodicity of checking the archives (beyond), as a result of which, and for exceeding the limit, the oldest files of all archives are removed. Completely remove this restriction by setting the parameter to zero.
- Rounding for numeric values (%) — sets the marginal percentage of the difference between the values of the parameters of the integer and the real types at which they are considered identical and are arranged in the archive as one value, through sequential packaging. Allows you to well pack parameters beyond the validity — which are lightly changed. Disabling this property can be set to zero.
- Timeout packaging archive files, in minutes — sets the time after which, in the absence of requests, the archive file will be packaged in a gzip archive. Set to zero for disabling the packaging by gzip.
- Period of the archives checking, in minutes — sets the periodicity of checking archives for the appearance or deletion in the archive files folder, as well as exceeding the limits and removing old archives files.
- Use info file for packaged archives — points to the need to create a file containing information about the packed gzip-archiver archive files. When copying the archive files to another station, this information file allows you to accelerate the process of first launching the destination station by eliminating the need to unzip the gzip-archives for the information.
- Remove original archive file at error unpacking — removing is performed during the archives checking and that is useful for broken archive files.
- Check now for the directory of the archiver — command that allows you to run the archives checking immediately, for example, after manually modifying the archiver folder.

Для контроля за файлами архиватора Вы можете посмотреть во вкладке "Файлы", рисунок 5.

Рис.5. Вкладка "Файлы" архиватора значений.

### 2.1 Формат файлов архива значений

К реализации архивирования на файловую систему предъявлялись следующие требования:

- быстрый и простой доступ на добавление в архив и чтение из архива;
- возможность изменения значений в существующем архиве, с целью заполнения дыр в дублированных системах;
- цикличность, ограничение размера;
- возможность сжатия методом упаковки последовательности одинаковых значений, сохраняющим возможность быстрого доступа — последовательная упаковка;
- возможность упаковки устаревших данных стандартными архиваторами (gzip, bzip2 ...) с возможностью распаковки при обращении.

В соответствии с вышеприведенными требованиями, организовано архивирование методом множественности файлов (для каждого источника). Цикличность архива реализуется на уровне файлов, т.е. создается новый файл, а самый старый удаляется. Для быстрого сжатия используется метод притягивания к последнему одинаковому значению. Для этих целей в файле архива предусматривается битовая таблица упаковки размером один в один с количеством хранимых данных. Т.е. каждый бит соответствует одному значению в архиве. Значение бита указывает на наличие значения. Для потока одинаковых значений биты обнулены. В случае с архивом строк таблица является не битовой а байтовой и содержит длину соответствующего значения. В случае поступления потока одинаковых значений, длина будет нулевой и читаться будет первое одинаковое значение. Поскольку таблица байтовая то архив может хранить строки длиной не более 255 символов. Таким образом, методики хранения можно разделить на методику данных фиксированного и нефиксированного размера. Общая структура файла архива приведена на рисунке 6.

Рис.6. Общая структура файла архива значений.

При создании нового файла архива формируются: заголовок (структура заголовка в таблице 1), нулевая битовая таблица упаковки архива и первое недостоверное значение (EVAL). Таким образом, получится архив, инициализированный недостоверными значениями. В дальнейшем, новые значения будут вставляться в область значений с корректировкой индексной таблицы упаковки. Из этого следует, что пассивные архивы будут вырождаться в файлы размером в заголовок и битовую таблицу.

Таблица 1. Структура заголовка файла архива

Поле | Описание | Размер байт(бит)
--- | --- | ---
f_tp | Системное имя архива ("OpenSCADA Val Arch.") | 20
archive | Имя архива к которому принадлежит файл. | 20
beg | Время начала архивных данных, в микросекундах | 8
end | Время окончания архивных данных, в микросекундах | 8
period | Период архива, в микросекундах | 8
vtp | Тип значения в архиве: Логический, Целый (Целый16, Целый32, Целый64), Реальный (Float, Double), Строка | (3)
hgrid | Признак использования жёсткой сетки в буфере архива | (1)
hres | Признак использования времени высокого разрешения (микросекунды) в буфере архива | (1)
reserve | Резерв | 14
term | Символ окончания заголовка архива (0x55) | 1

Разъяснение механизма последовательной упаковки приведено на рисунке 7. Как можно видеть из рисунка, признак упаковки содержит длину (нефиксированные типы) или признак упаковки (фиксированные типы) отдельно взятого значения. Это значит, что для получения смещения нужного значения необходимо сложить длины всех предыдущих действительных значений. Выполнение данной операции каждый раз и для каждого значения является крайне накладной операцией поэтому был внедрён механизм кеширования смещений значений. Механизм кеширует смещения значений через предопределённое их количество, а также кеширует смещение последнего значения, к которому производился доступ (отдельно на чтение и запись).

Рис.7. Механизм последовательной упаковки значений.

Изменение значений внутри существующего архива также предусмотрено. Однако, учитывая необходимость выполнения сдвига хвоста архива, рекомендуется выполнять эту операцию как можно реже и как можно большими блоками.

## 3 Эффективность

При проектировании и реализации данного модуля были заложены механизмы повышения эффективности процесса архивирования.

Первым механизмом является блочное (покадровое или транзакционное) помещение данных в файл архива значений. Такой механизм позволяет достичь максимальной скорости архивирования, а следовательно и позволяет одновременно архивировать больше потоков данных. Опыт практического применение показал, что система K8-3000 с обычным IDE жестким диском способна архивировать до 300000 потоков данных с периодом 1 секунда или, система K5-400 с IDE диском (2.5") способна архивировать до 100 параметров с периодом 1 миллисекунда.

Вторым механизмом является упаковка как текущих значений, так и устаревших файлов архивов, для оптимизации используемого дискового пространства. Реализовано два механизма упаковки: механизм последовательной упаковки (архивы значений) и механизм дожатия архивов стандартным упаковщиком (gzip). Данный подход позволил достичь высокой производительности в процессе архивирования текущих данных с эффективным механизмом последовательного сжатия, а дожатие стандартным упаковщиком устаревших архивов завершает общую картину компактного хранения больших массивов данных. Статистика практического применения в условиях реального зашумленного сигнала(худшая ситуация) показала, что степень последовательной упаковки составила 10%, а степень полной упаковки составила 71%.

## 4 Ссылки

- Диаграмма: Общая схема процесса архивирования значений.
- Диаграмма: Общая структура файла архива значений Archive.FSArch.
- Диаграмма: Механизм последовательной упаковки значений Archive.FSArch.

Modules/FSArch/ru - GFDL | May 2026 | OpenSCADA 0.9.9