Download the PHP package arrilot/bitrix-systemcheck without Composer

On this page you can find all versions of the php package arrilot/bitrix-systemcheck. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package bitrix-systemcheck

Latest Stable Version

Данный пакет больше активно не поддерживается

Причина - мы больше не используем Битрикс в своих проектах. Если вам интересен этот проект и вы хотите заняться его поддержкой - форкните его и создайте Issue в данном репозитории чтобы мы поместили здесь ссылку на форк.

Bitrix System Checks

Пакет представляет из себя модуль для Битрикса, который является более гибкой и функциональной альтернативой штатной битриксовой функциональности "Проверка системы"

Установка

  1. Добавляем в composer.json следующие строчки если их там еще нет

composer require arrilot/bitrix-systemcheck

  1. Устанавливаем модуль на странице /bitrix/admin/partner_modules.php?lang=ru

  2. Добавляем local/modules/arrilot.systemcheck в .gitignore

Теория

Возможности bitrix-systemcheck

Основные сущности

Основные сушности пакета - проверка и мониторинг.

Проверка - класс, наследующий Arrilot\BitrixSystemCheck\Checks\Check. Цель проверки - вернуть true/false в методе run(). Если проверка возвращает false, то где-то перед return false; следует вызвать метод $this->logError("текст ошибки тут"); один или несколько раз чтобы было понятна причина провала проверки. Пример:

Мониторинг - класс, наследующий Arrilot\BitrixSystemCheck\Checks\Monitoring Логически он представляет из себя именованный набор проверок, причем этот набор может зависить от окружения и других параметров.

Пример:

Использование

  1. Реализовуем мониторинг/мониторинги (пример выше)
  2. Добавляем их в `.setting_extra.php

  3. Теперь можно запустить выбранный мониторинг в админке /bitrix/admin/arrilot_systemcheck_monitoring.php?code=full
  4. Регистрируем команду Arrilot\BitrixSystemCheck\Console\SystemCheckCommand в консольном приложении на базе symfony/console если у нас есть такое
  5. После этого мы сможем запускать мониторинги через консольное приложение следующим образом : php our_console_app.php system:check full, где full - код мониторинга, возвращаемый методом Monitoring::code(). Запускать лучше от пользователя из-под которого у вас работают кроны и веб-сервер, например вот так sudo -H -u www-data bash -c 'php our_console_app.php system:check full'
  6. При желании ставим консольную команду запускающую мониторинг в крон и получаем логи/алерты согласно нашему логгеру из Monitoring::logger()

Имеющиеся в пакете проверки можно посмотреть в src/Checks

Добавление проверок в пакет aka Contributing

Любой желающий может через Pull Request (PR) предложить свою проверку для рассмотрения на добавление в ядро модуля. При этом необходимо следовать следующим несложным правилам.

  1. Перед началом работы на проверкой нужно удостовериться что такой проверки еще нет в пакете и в открытых PR
  2. Один PR = одна проверка
  3. Проверка должна быть достаточно общей и подходить таким образом большому числу приложений. Если ваша проверка завязана на ваше приложение, то лучше ей в нём и оставаться
  4. Нужно предусмотреть чтобы проверка не закончилась Fatal Exception/Error при запуске на каком-то другом приложении. Например если в ней используется какой-то дополнительный модуль php, то нужно сделать проверку extension_loaded() и $this->skip() или return false в случае false в extension_loaded()
  5. Проверки должны работать на "php": ">=5.6.0"
  6. Из предыдущего пункта следует, что проверка должна по минимуму использовать внешние зависимости (модули php, композер-пакеты и т д)
  7. Если проверка является еще почему-то нереализованным аналогом проверки из битриксовой "Проверки системы", то она должна идти в неймспейс Arrilot\BitrixSystemCheck\Checks\Bitrix, в противном случае - в Arrilot\BitrixSystemCheck\Checks\Custom
  8. Код должен следовать PSR-2

All versions of bitrix-systemcheck with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
composer/installers Version ~1
symfony/console Version ~3 || ~4
psr/log Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package arrilot/bitrix-systemcheck contains the following files

Loading the files please wait ....