Skip to content
Public template

About

Система обслуживания и мониторинга информационных баз 1С

Topics

Resources

Stars

152 stars

Watchers

10 watching

Forks

Repository files navigation

OneSwiss

Публикация на infostart
Группа в Telegram Telegram

Оглавление

Система обслуживания и мониторинга информационных баз 1С

Кроссплатформенный программный комплекс, состоящий из:

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

Система автоматически находит установленные экземпляры платформ 1С, запущенные агенты серверов, определяет адреса, порты, запущенные для агентов экземпляры RAS, подгружает на сервер и обновляет списки кластеров и информационных баз.
Если экземпляр RAS не найден в списке служб (демонов), то система автоматически запустит экземпляры RAS для обеспечения собственной работы.

image

Функциональные возможности:

Обслуживание информационных баз:

Шаблонизация и автоматизация запуска последовательности действий обслуживания произвольного количества информационных баз посредством графической блок-схемы.

Блок-схема обслуживания ИБ имеет 2 возможных типа блоков:

  • Простой шаг
  • Шаг с обработкой исключения

Доступные типы шагов:

  • Блокировка соединений - блокировка соединений с ИБ
  • Закрытие соединений - закрытие соединений с ИБ
  • Разблокировка соединений - разблокировка соединений к ИБ
  • Загрузка расширения - загрузка расширения из CFE файла или из указанного хранилища конфигурации
  • Удаление расширения - удаление расширения из ИБ по имени (по регулярному выражению)
  • Обновление конфигурации - обновление ИБ файлом CFU
  • Загрузка конфигурации - загрузка конфигурации из CF файла или из указанного хранилища конфигурации
  • Запуск внешней обработки - выполнение запуска внешней обработки в пакетном режиме запуска клиента 1С (Execute)
  • Выполнение скрипта (OneScript) - запуск выполнения скрипта из ospx пакета

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

Сервис регистрации ошибок:

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

{URL}/api/ErrorLoggingService

Пример:

http://localhost:7002/api/ErrorLoggingService
image

Экспорт технологического журнала:

Автоматизация сбора и экспорта технологического журнала. Центральными понятиями системы являются:

  • Шаблоны сбора ТЖ - шаблоны файла logcfg.xml
  • Сеансы сбора - непосредственное описание режима сбора, подключенных к сеансу агентов и шаблонов сбора ТЖ.

Доступные режимы сбора ТЖ:

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

Режимы, имеющие временные границы будут автоматически завершены, ручных действий не требуется. Устаревшие каталоги сбора и файлы ТЖ так-же будут автоматически очищены системой.

Система поставляется с небольшим, предопределенным списком шаблонов сбора ТЖ

СУБД, доступные для экспорта:

  • ClickHouse

Для каждого сеанса сбора доступен встроенный веб-просмотрщик собранных записей ТЖ с фильтрацией (в т.ч. произвольным условием WHERE с автодополнением по доступным полям) и таймлайн-представлением событий.

image

Экспорт журнала регистрации:

Автоматизация сбора и экспорта журнала регистрации 1С. Настройка базы данных экспорта аналогична настройке базы данных для технологического журнала. Информационные базы к экспорту добавляются автоматически по регулярному выражению имени информационной базы

СУБД, доступные для экспорта:

  • ClickHouse

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

Прокси сервер серверов хранилищ

Предоставляет возможность публикации хранилищ конфигураций, переопределения адресов и добавления обработчиков некоторых запросов от конфигуратора к хранилищу. OneSwiss заменяет собой публикацию серверов хранилищ на вебсерверах IIS и Apache, принимая запросы от клиентов по http протоколу и преобразуя запросы в tcp поток, переотправляет их целевому серверу хранилищ. Для включения проксирования хранилища конфигурации, необходимо сконфигурировать публикации хранилищ в панели настроек, указав хранилище и часть пути, по которому будет опубликовано хранилище. Конечный адрес публикации будет формироваться по правилу:

{АДРЕС_ONESWISS}/cr/{АДРЕС_ПУБЛИКАЦИИ}

Пример для публикации с адресом erp/extensions/myext:

http://localhost:7002/cr/erp/extensions/myext

Так-же прокси позволяет сконфигурировать пользовательские обработчики запросов на языке сценариев OneScript. Пользовательский обработчик - это .ospx пакет, загружаемый файлом в панели управления файлами OneSwiss. Обязательными атрибутами (для исполнения в среде OneSwiss) которого, являются:

  • Указание в packagedef пути к исполняемому файлу
  • Наличие одного из возможных обработчиков:

Для возможности переиспользования пользовательских обработчиков для разных хранилищ, добавлена возможность указания аргументов обработчиков для конкретных публикаций, представляющих из себя список пар Ключ/Значение и передающихся в скрипт через объект контекста обработчика, в свойстве ДополнительныеПараметры

Для обеспечения более удобного процесса, был реализован механизм отладки скриптов обработчиков. Для начала отладки необходимо:

  1. В панели управления обработчиками установить флаг Режим отладки, указать полный путь к исполняемому файлу opsx пакета и привязать обработчик к публикации
  2. Сконфигурировать attach отладки к серверу отладки OneScript, который поднимет OneSwiss на порту 2801. Пример launch файла VSCode:
{
    "version": "0.2.0",
    "configurations": [

        {
            "name": "Отладка 1Script",
            "type": "oscript",
            "request": "attach",
            "debugPort": 2801
        }
    ]
}
  1. Вызвать в конфигураторе желаемое событие, при этом конфигуратор "зафризится" в ожидании подключения клиента отладки (VSC)
  2. Перейди в VSC, установить точку останова в желаемом месте и нажать F5 для подключения отладчика

Обработчик помещения изменений в хранилище:

Процедура ОбработатьПомещениеИзменений(КонтекстОбработчика) Экспорт
КонецПроцедуры

Обработчик помещения изменений в хранилище:

Процедура ОбработатьИзменениеВерсии(КонтекстОбработчика) Экспорт
КонецПроцедуры

КонтекстОбработчика - объект интеграции, предоставляемый OneSwiss для работы с потоком запросов конфигуратора.
Актуальный список свойств можно посмотреть в классе контекста - RequestHandlerWrapper.cs
Контекст имеет 2 основных метода для взаимодействия с потоком запросов:

  • ПередатьЗапрос - передать запрос от конфигуратора к хранилищу
  • ВызватьИсключение - отправить ответ конфигуратору с текстом исключения, вместо передачи запроса серверу хранилищ

Уведомления:

Реализована система уведомлений о результатах выполнения задач обслуживания и поступивших отчетах об ошибках. Доступные каналы уведомлений:

  • Бот Telegram
  • WebHook

MCP-доступ для AI-ассистентов:

Сервер может выступать MCP-сервером (Model Context Protocol) для подключения AI-ассистентов (например, Claude). Через него доступны для чтения отчеты сервиса регистрации ошибок, задачи обслуживания и анализ нагрузки активных сеансов кластеров 1С (по CPU, работе с СУБД, памяти и блокировкам). Запуск задачи обслуживания через MCP обязательно требует явного подтверждения пользователем на стороне AI-клиента (протокольный механизм elicitation).

Аутентификация MCP-клиентов реализована через OAuth 2.1 (Dynamic Client Registration + PKCE) поверх того же логина/пароля или SSO, что и веб-панель. Зарегистрированные клиенты и их активные сессии видны на странице «Секреты агентов» веб-панели и могут быть отозваны администратором.

По умолчанию MCP-сервер выключен - включается параметром Mcp__Enabled (см. раздел Сервер).

Некоторые детали реализации:

В комплексе реализовано автоматическое обнаружение необходимых для обеспечения собственной работы служб и приложений на хостах агентов:

  • Агентов серверов 1С (ragent)
  • Служб удаленного администрирования (RAS)
  • Установленных платформ 1С:Предприятие
  • Служб серверов хранилищ конфигураций

Найденные ресурсы комплекс использует для обнаружения и автоматической регистрации следующих сущностей на собственном сервере:

  • Кластеры 1С
  • Информационные базы
  • Хранилища конфигураций

Установка и использование:

Учетные данные администратора при первом входе - admin/admin

Развертывание с помощью Docker Compose

Сервер и веб-панель поставляются только в виде Docker-образов и разворачиваются вместе с базой данных PostgreSQL через Docker Compose. Готовый файл композиции и примеры файлов окружения:

  • docker-compose.yml - описание сервисов db (PostgreSQL), server (oneswiss-server) и web (oneswiss-web), включая полный список поддерживаемых переменных окружения сервера с комментариями
  • .env.example - пример файла окружения для docker-compose.yml (образы, порты, публичные адреса)
  • oneswiss-web/.env.example - пример файла окружения для локальной разработки веб-панели (npm run dev/next build) вне Docker

Быстрый старт:

cp .env.example .env
# заполните .env реальными значениями (адреса, порты, теги образов)
docker compose up -d

Агент устанавливается отдельно, непосредственно на серверах 1С - см. раздел Агент ниже.

Сервер

Является центральным звеном программного комплекса, осуществляет управление работой агентов, установленных на серверах 1С. Поставляется исключительно в виде Docker-образа (oneswiss-server) и конфигурируется переменными окружения (стандартная для ASP.NET Core схема именования вложенных разделов - Раздел__Подраздел). Разворачивается вместе с веб-панелью и базой данных PostgreSQL через Docker Compose - см. раздел Развертывание с помощью Docker Compose.

Основные переменные окружения сервера:

  • ConnectionStrings__Default - строка подключения к PostgreSQL
  • Ui__ReactUrl - адрес веб-панели, используется для CORS
  • Auth__RequireClientsAuthentication - флаг необходимости выполнения аутентификации подключающихся агентов
  • Auth__Jwt__SigningKey - секрет для подписи JWT, выдаваемых веб-панели и агентам
  • Auth__Mode - Internal или Mixed. Только внутренняя или внутренняя + OIDC аутентификация
  • Auth__OIDC__Authority - адрес провайдера аутентификации (только при Auth__Mode=Mixed)
  • Auth__OIDC__ClientId - идентификатор клиента аутентификации
  • Auth__OIDC__ClientSecret - секрет клиента аутентификации
  • Auth__OIDC__Scopes__0, Auth__OIDC__Scopes__1, ... - список областей, получаемых клиентом
  • Auth__OIDC__NameClaim - имя утверждения, значение которого будет использовано в качестве логина. По умолчанию - preferred_username
  • Auth__OIDC__DisplayNameClaim - имя утверждения с отображаемым именем пользователя. По умолчанию - name
  • Mcp__Enabled - флаг включения MCP-сервера для доступа AI-ассистентов к данным (см. раздел MCP-доступ для AI-ассистентов). По умолчанию выключен
  • Mcp__AnonymizeSessionData - анонимизировать логин, имя компьютера и разделитель данных при анализе нагрузки сеансов через MCP. По умолчанию выключено
  • ProxyAddress - IP пограничного прокси сервера (см. раздел Работа за reverse proxy)

Полный и актуальный список переменных, с комментариями по каждой - в docker-compose.yml.

Агент

Устанавливается непосредственно на сервера 1С.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "InstanceName": "",
  "Server": "wss://oneswiss.company.domain",
  "Auth": {
    "Required": "true",
    "TokensEndpoint": "https://sso.company.domain/protocol/openid-connect/token",
    "ClientId": "oneswiss",
    "ClientSecret": "fdsnjfdifo54343r43jnd"
  },
  "TechLogFolder": "", 
  "V8": {
    "PlatformPaths": [

    ]
  }
}

Где:

  • InstanceName - наименование агента, отображаемое в панели управления серверной части. Если не задано - то hostname
  • Server - адрес и порт, по которым агент будет стучаться к серверной части. Если сервер опубликован по https, то для доступа агентов необходимо использовать wss, а не ws
  • Auth
    • Required - флаг необходимости получения и использования jwt токена для аутентификации агента при подключении к серверу oneswiss
    • TokensEndpoint - адрес конечной точки издателя токенов аутентификации (client_credentials grant, OAuth2). Это может быть:
      • внешний OIDC/SSO провайдер (пример выше) - в этом случае сервер oneswiss должен быть настроен в режиме Auth__Mode=Mixed (см. раздел про сервер) с Auth__Jwt__SigningKey не заданным (пустым) - иначе сервер не примет токены от внешнего провайдера;
      • собственный oneswiss-server - укажите https://{адрес сервера}/api/auth/token (используйте ту же схему - http/https, - по которой сервер реально доступен: если сервер поднят без TLS-терминации перед ним (реверс-прокси не настроен), укажите http://..., иначе агент не сможет получить токен и будет молча подключаться без аутентификации, получая 401 при рукопожатии WebSocket). Работает при любом Auth__Mode, независимо от Auth__Jwt__SigningKey (использует тот же ключ, что и логин пользователей веб-панели). ClientId/ClientSecret в этом случае выпускаются на странице «Секреты агентов» веб-панели (раздел «Общее», только для администраторов) - секрет показывается один раз при создании и не восстанавливается.
    • ClientId - идентификатор клиента
    • ClientSecret - секрет клиента
  • PlatformPaths - дополнительные пути, если платформы установлены не в каталогах установки платформы 1С по умолчанию
  • TechLogFolder - служебный каталог сбора технологического журнала, используемый в работе подсистемы сеансов сбора ТЖ. Если не указан, то используется стандартный путь:
    • Windows - %PROGRAMDATA%/oneswiss/techlog
    • Linux - /var/log/oneswiss/techlog

Работа за reverse proxy

Для обеспечения корректного перенаправления и использования схемы, на прокси-сервере необходимо устанавливать следующие заголовки:

  • X-MS-Proxy - адрес прокси сервера
  • X-Forwarded-For - адрес и порт удаленной точки подключения (сервер oneswiss)
  • X-Forwarded-Proto - испольуемая схема

Условный пример:

X-Ms-Proxy: 10.10.0.1
X-Forwarded-For: {upstream}
X-Forwarded-Proto: https

Так-же в файле конфигурации сервера oneswiss обязательно требуется указание адреса пограничного прокси-сервера в параметре ProxyAddress

About

Система обслуживания и мониторинга информационных баз 1С

Topics

Resources

Stars

152 stars

Watchers

10 watching

Forks

Releases

Packages

Used by

Contributors

Languages