Перейти к содержанию

Консольная утилита запуска запросов

Консольная утилита запуска запросов (далее Утилита) предназначена для выполнения поисковых запросов на WDC.Платформе и вывода полученного результата на экран компьютера.

Установка и настройка Утилиты

Рассмотрим основные этапы подготовки Утилиты к работе:

Установка

Распакуйте дистрибутивный архив clisearch-0.1.2-master-0006.tar.gz в рабочую директорию.

Конфигурирование

Настройка Утилиты выполняется в конфигурационном файле clisearch.cfg, представляющим собой структуру, аналогичную той, что находится в ini-файлах.

Примечание.
Пример конфигурационного файла clisearch.cfg.example находится в дистрибутивном архиве.

Все конфигурационные параметры должны быть размещены в секции [main].

В файле предусмотрены следующие параметры:

  • host – IP адрес или доменное имя для подключения.

    По умолчанию: localhost.

  • port – номер порта для подключения.

    По умолчанию: 80.

  • username – имя пользователя, который может выполнять запрос в Утилите.

    По умолчанию: admin.

  • password – пароль пользователя, который может выполнять запрос в Утилите.

    По умолчанию не задан.

  • ssl – настройка использования шифрованного канала передачи данных при выполнении запроса.

    Возможные значения:

    • True – использовать;

    • False – не использовать.

      По умолчанию: False.

  • loglevel – уровень журнализации действий Утилиты.

    Возможные значения:

    • critical – выводятся только сообщения уровня critical;

    • warning – выводятся сообщения уровня warning и выше;

    • error – выводятся сообщения уровня error и выше;

    • info – выводятся сообщения уровня info и выше;

    • debug – выводятся сообщения всех уровней.

      По умолчанию: error.

  • logoutput – вывод журнала действий в заданный поток.

    Возможные значения:

    • STDERR – вывод потока журнала в стандартный поток ошибок;

    • STDOUT – вывод потока журнала в стандартный поток вывода;

    • NULL – не выводить поток журнала;

    • \<filename> – имя файла, в который будет выведен поток.

      По умолчанию: STDERR.

Пример конфигурационного файла:

[main]
  host = localhost
  port = 80
  username = admin
  password = password_unused
  ssl = False
  loglevel = error
  logoutput = STDERR

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

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

Утилита запускается из командной строки с использованием команды clisearch и ряда аргументов.

clisearch   [-h] 
            [--config CONFIG] [--ttl TTL] [--tws TWS] [--twf TWF]
            [--tlast TLAST] [--sid SID]
            [--loglevel LOGLEVEL]
            [--logoutput LOGOUTPUT] [--output OUTPUT]
             --query OTL

Аргументы командной строки

-c CONFIG
--config CONFIG

CONFIG – путь к конфигурационному файлу и его имя.

По умолчанию поиск файла clisearch.cfg выполняется в текущей директории запуска запроса.

--ttl TTL

TTL – время (в секундах) сохранения результата выполнения запроса в системе кэширования WDC.Платформы.

Значение по умолчанию: 60.

--tws TWS

TWS – начальное значение временного интервала поиска данных по запросу в формате Epoch time.

Значение по умолчанию: 0, т.е. с самого начала.

--twf TWF

TWF – конечное значение временного интервала поиска данных по запросу в формате Epoch time.

Значение по умолчанию: 0, т.е. до самого конца.

--tlast TLAST

TLAST – временной интервал поиска данных, заданный в секундах, окончание которого приходится на момент запуска Утилиты.

Значение по умолчанию: 0, т.е. не используется.

--sid SID

SID – идентификатор запроса SID.

Используется для идентификации запроса в журнальной системе WDC.Платформы, которая в некоторых случаях может ускорить процесс поиска и отладки выполняемых запросов.

--loglevel LOGLEVEL

Важно!

Аргумент loglevel аналогичен параметру loglevel из конфигурационного файла, но имеет над ним приоритет.

LOGLEVEL – уровень журнализации действий Утилиты.

Возможные значения:

  • critical – выводятся только сообщения уровня critical;

    • warning – выводятся сообщения уровня warning и выше;

      • error – выводятся сообщения уровня error и выше;

      • info – выводятся сообщения уровня info и выше;

      • debug – выводятся сообщения всех уровней.

        Значение по умолчанию: info.

--logoutput LOGOUTPUT

Важно!

Аргумент logoutput аналогичен параметру logoutput из конфигурационного файла, но имеет над ним приоритет.

LOGOUTPUT определяет, куда будет выведен журнал действий.

Возможные значения:

  • STDERR – выводить поток журнала в стандартный поток ошибок,

    • STDOUT – выводить поток журнала в стандартный поток вывода,

      • NULL – не выводить поток журнала,

      • \<filename> – выводить поток журнала в файл с именем filename.

        По умолчанию выводится в STDERR.

--query OTL

OTL – запрос, отправляемый на выполнение в WDC.Платформу, обрамляется кавычками.

Важно!

  1. Запрос обрамляется одинарными кавычками.

  2. Спецсимвол процент (%) в запросе необходимо экранировать, дублируя символ процента (%):

    Например:

    `..| eval _time=strptime(TS, "%%Y-%%m-%%d %%H:%%M:%%S")..`

--output OUTPUT

OUTPUT – формат (csv или json), в котором будет выведен результат выполнения запроса.

Значение по умолчанию: cvs.

Примеры использования Утилиты

Примеры запуска запросов

Пример 1.

Простой поиск без указания временного окна:

clisearch --query "makeresults | eval a=10"

Пример 2.

Простой поиск без указания временного окна, с указанием конфигурационного файла:

clisearch -с /home/user/clisearch.cfg --query "makeresults | eval a=10"

Примеры формирования результатов запроса

Пример 1.

Вывести результаты выполнения запроса на экран в CSV-формате:

clisearch --output csv --query "makeresults | eval a=10"

Пример вывода:

_time,a

1603285290,10

Пример 2.

Вывести результаты выполнения запроса на экран в JSON формате:

clisearch --output json --query "makeresults | eval a=10"

Пример вывода:

{"_time":1603285290,"a":10}

К началу