SAMS2 Приложения

Оглавление

Приложение 1. Параметры командной строки

samsparser

Программа предназначена для обработки дополнительных (архивных) лог файлов SQUID и работы с БД. Может использоваться как альтернатива демону в части подсчета трафика.

Некоторые команды могут быть указаны одновременно. Если ни одна команда не указана, то используется --update. Если указаны несколько команд, то они выполняются в следующем порядке:

  • Обновление базы данных (команда --update)
  • Експорт кеша во внешний файл (команда --export)
  • Очистка счетчиков пользователей (команда --clear)
  • Очистка информации о трафике (команда --truncate)
    • На все команды действуют фильтры --user и --date, если они указаны.



    Команда Описание
    -h, --help Выводит список параметров с небольшим описанием и завершает работу.
    -V, --version Выводит версию программы и завершает работу.
    -u, --update Обновляет информацию о трафике из лог файла SQUID. По умолчанию обрабатывается текущий лог файл начиная с места последней обработки. Если дополнительно указывается параметр --file, то обрабатывается указанный файл с самого начала и смещение в файле не обновляется.
    -e, --export Записывает во внешний файл подробную информацию о трафике. Если параметр --file не указан, то используется файл squid.log в текущей директории.
    -c, --clear Обнуляет счетчики пользователей.
    -t, --truncate Очищает информацию о трафике в БД.

    Обязательные аргументы для параметров в полном варианте, так же обязательны для краткого варианта.


    Параметр Описание
    -f, --file=FILE Использовать файл FILE для команд update или export (по умолчанию: squid.log).
    -U, --user=LIST Применить фильтр по пользователям. LIST - это список пользователей, разделенных запятой. Например, -U DOMAIN+user1,192.168.1.1,user2.
    -D, --date=DATE_INTERVAL Применить фильтр по датам. DATE_INTERVAL - это две даты, разделенные запятой. Дата указывается в формате ГГГГ-ММ-ДД. Существуют нестрогие формы указания интервала. Если дата начала не указана, то началом считается 1 января 2000 года. Если дата окончания не указана, то окончанием считается текущее число. Если запятой нет, то началом и окончанием считается указанная дата. Примеры:
  • -D 2007-11-01,2007-11-30 # с 1 по 30 ноября 2007 г.
  • -D ,2007-12-31 # c 1 января 2000 г. по 31 декабря 2007 г.
  • -D 2007-01-01, # с 1 января 2007 до текущего дня
  • -D 2007-10-15 # только 15 октября 2007 г.
    •
    -v, --verbose Выводить краткую информацию в процессе работы.
    -d, --debug=LEVEL Установить уровень отладочных сообщений в диапазоне от 0 до 9. 0 выключает все отладочные сообщения. Для пользователей рекомендуется устанавливать уровень не более 5.
    -l, --logger=LOGGER Использовать LOGGER для вывода сообщений. Возможные значения: console, syslog, file. В случае вывода в файл, через двоеточие можно указать имя файла (по умолчанию: samsparser.log). Например:
  • -l syslog
  • -l file:/path/to/file
    •
    -C, --config=FILE Использовать конфигурационный файл FILE вместо стандартного.
    -w, --wait-myself Если обнаружена запущенная копия программы, то вместо завершения работы, ожидать завершения работы этой копии и только после этого продолжить выполнение.

    samsdaemon

    Демон предназначен для подсчета трафика через определенный интервал времени (интервал указывается в web интерфейсе), автоматической блокировки и очистки счетчиков пользователей, внесения различных правил в конфигурационный файл SQUID и его реконфигурирования, экспорта подробной информации о трафике во внешний файл и автоматической очистки устаревших данных.

    Команда Описание
    -h, --help Выводит список параметров с небольшим описанием и завершает работу.
    -V, --version Выводит версию программы и завершает работу.
    -s, --stop Останавливает работу демона, передавая соответствующую команду в базу данных. Длительность остановки демона зависит от периода проверки команд, который устанавливается в web интерфейсе.

    Обязательные аргументы для параметров в полном варианте, так же обязательны для краткого варианта.


    Параметр Описание
    -f, --fork Запустить в фоновом режиме. Демон самостоятельно переходит в фоновый режим, если не указан параметр --debug.
    -F, --no-fork Не запускать в фоновом режиме.
    -t, --timeout=SECONDS Переподключаться к базе данных каждые SECONDS секунд. По умолчанию 3600 (один час).
    -v, --verbose Выводить краткую информацию в процессе работы.
    -d, --debug=LEVEL Установить уровень отладочных сообщений в диапазоне от 0 до 9. 0 выключает все отладочные сообщения. Для пользователей рекомендуется устанавливать уровень не более 5. При указании этого параметра демон не переходит в фоновый режим, если не указан параметр --fork.
    -l, --logger=LOGGER Использовать LOGGER для вывода сообщений. Возможные значения: console, syslog, file. В случае вывода в файл, через двоеточие можно указать имя файла (по умолчанию: samsdaemon.log). Например:
  • -l syslog
  • -l file:/path/to/file
    •
    -C, --config=FILE Использовать конфигурационный файл FILE вместо стандартного.

    samsredir

    Редиректор предназначен для снижения трафика путем обрезания рекламы, так-же при блокировке доступа показывает расширенную информацию о причине блокировки.

    Команда Описание
    -h, --help Выводит список параметров с небольшим описанием и завершает работу.
    -V, --version Выводит версию программы и завершает работу.

    Обязательные аргументы для параметров в полном варианте, так же обязательны для краткого варианта.


    Параметр Описание
    -v, --verbose Выводить краткую информацию в процессе работы.
    -d, --debug=LEVEL Установить уровень отладочных сообщений в диапазоне от 0 до 9. 0 выключает все отладочные сообщения. Для пользователей рекомендуется устанавливать уровень не более 5. При включении отладочного режима во время работы со SQUID, рекомендуется использовать параметр --logger для избежания вывода сообщений в стандартный поток вывода.
    -l, --logger=LOGGER Использовать LOGGER для вывода сообщений. Возможные значения: console, syslog, file. В случае вывода в файл, через двоеточие можно указать имя файла (по умолчанию: samsredir.log). Например:
  • -l syslog
  • -l file:/path/to/file
    •
    -C, --config=FILE Использовать конфигурационный файл FILE вместо стандартного.

    		Оглавление