Командная строка StaffCop

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

Добавление правил мониторинга в глобальную конфигурацию

sudo staffcop acl <RULE> <VALUE>

Подробный список правил можно посмотреть здесь

Бэкап базы данных и настроек. Сохраняет бэкап по умолчанию в /var/lib/staffcop/staffcop_backup

sudo staffcop backup_db [PATH_TO_BACKUP]

Удаление всех файлов и скриншотов старше, чем значение DAYS

sudo staffcop cleandata <DAYS>

Удаляет все файлы и события из базы данных старше, чем значение DAYS, после чего уменьшает размер базы данных

sudo staffcop cleanup <DAYS>

Управление Clickhouse

sudo staffcop clickhouse [install|init|reinit|pump|test|start|stop|restart]

Установка и активация базы данных сlickhouse

sudo staffcop clickhouse install

Апгрейд базы данных Clickhouse до стабильной версии

staffcop upgrade clickhouse

Cтавит последнюю известную стабильную версию Clickhouse. Иногда избавляет от проблем нестабильных версий Clickhouse, обычно более новых.

Загрузка данных из postgresql в clickhouse

sudo staffcop clickhouse pump

Тестирование системы выгрузки из postgresql в clickhouse нужно для диагностики

sudo staffcop clickhouse test

Перезапись всех данных clickhouse

sudo staffcop clickhouse reinit

Перезапуск clickhouse-server

sudo staffcop clickhouse restart

Запуск clickhouse-server

sudo staffcop clickhouse start

Остановка clickhouse-server

sudo staffcop clickhouse stop

Тест отправки данных от клиента до сервера и вывод конфигурации агента.

sudo staffcop client [SERVER]

Копирование базы данных и файлов с удаленного до локального сервера (postgresql)

sudo staffcop clone <SSH-USER>@<REMOTE-HOST> [ssh options]

Очистка незанятого места и дефрагментация базы данных

sudo staffcop compact

Вывод пути хранения базы данных

sudo staffcop db_path

Удаление всех данных по выбранному измерению

sudo staffcop delete [--type agent|account|event] [--days N] [--keep-files] [--keep-events] [--compact] <NAME>

--type        Удаление данных по агенту, имени пользователя или типу событий
--days N      Оставить данные за N дней
--compact     Дефрагментация базы данных
--keep-files  Оставить файлы
--keep-events Оставить события

Доступный список event для команды:

DiskDrive         | Внешние диски
FileOperation     | Операции с файлами
SystemLog         | Системный лог
UserActivity      | Алерт
WebcamSnapshot    | Снимок с веб-камеры
MicRecording      | Запись звука
DevInventory      | Реестр оборудования
AppInventory      | Реестр софта
WebSearch         | Поисковый запрос
DesktopVideo      | Видео рабочего стола
FormData          | Данные формы
WLan              | Беспроводное подключение
InterceptedFile   | Перехваченный файл
Keyboard          | Ввод с клавиатуры
Run               | Запуск приложения
Exit              | Завершение приложения
Screenshot        | Снимок экрана
NetworkConnection | Сеть
AppInstallation   | Установка ПО
Web               | Посещение сайтов
Im                | Интернет-пейджер
Mail              | Почта
FTP               | FTP
PrintDoc          | Печать документов
UserLogon         | Вход/выход из системы
Clipboard         | Буфер обмена
Device            | Устройства
Stat              | Время активности

Примечание

Эта команда чувствительна к регистру имени компьютера, будьте пожалуйста внимательны!

Экспорт фильтров и конфигураций в FILE_TO_EXPORT.json (путь должен быть полным)

sudo staffcop export FILE_TO_EXPORT.json

Вывод доступных команд

sudo staffcop help [command|django]

выберите django для вывода команд из командной строки django

Импорт фильтров и конфигураций из FILE_TO_IMPORT.json.

sudo staffcop import FILE_TO_IMPORT.json

Текущие фильтры будут сохранены.

Вывод информации о сервере и занятом месте на диске.

sudo staffcop info

Инициализация или восстановление настроек сервера.

sudo staffcop init

Запуск mule в высоком приоритете

sudo staffcop mule <MULE_NAME>

Выполнение команды для распознавания текста в изображениях или pdf

sudo staffcop ocr <image or pdf file>

Установка нового пароля для пользователя

sudo staffcop passwd NEW_PASSWORD

Вывод текущих sql-запросов и план выполнения

sudo staffcop prof

Удаление пользователей и агентов, которые не имеют событий

sudo staffcop prune

Вывод процессов staffcop

sudo staffcop ps

Перестройка отчетов за N месяцев

sudo staffcop rebuild_sessions MONTHS

Сброс к настройкам сервера по умолчанию

sudo staffcop reinit [full]

Если выбрать параметр «full», также удаляет все пользовательские фильтры

Перезапуск сервиса staffcop

sudo staffcop restart

Восстановление базы данных из бэкапа по пути /var/lib/staffcop/staffcop_backup

sudo staffcop restore_db [PATH_TO_BACKUP]

Объединение событий агентов с идентичными именами

sudo staffcop sane

Управление шардированием

sudo staffcop shard [init|install|list|ddl|index|copy]

Создание шарда для текущего месяца

sudo staffcop shard init

Включение фунционала шардирования базы данных

sudo staffcop shard install

Предупреждение

Необратимая операция! Команда работает в PostgreSQL версии 11 и выше, требуется 50% дискового пространства.

Вывод списка текущих шардов

sudo staffcop shard list

Доступ к sql-консоли staffcop

sudo staffcop sql

Запуск сервиса staffcop

sudo staffcop start

Остановка сервиса staffcop

sudo staffcop stop

Вывод топовых процессов staffcop

sudo staffcop top

Удаление всех данных

sudo staffcop truncate

Обновление до последней версии

sudo staffcop upgrade

Обновление postgresql (до версии 11)

sudo staffcop upgrade-postgress

Пересчитать один фильтр

sudo staffcop process 'Имя фильтра' 0

Примечание

Можно пересчитать один фильтр начиная с определённого ID если вместо «0» указать номер события с которого нужно пересчитать фильтр.

Например, что бы пересчитать фильтр с именем «Карты», начиная с ID=1000000 то нужно выполнить команду:

sudo staffcop process 'Карты' 1000000