seqcli

seqcli

Приложение командной строки клиента Seq. Поддерживает ведение журнала ( seqcli log ), поиск ( search ), отслеживание ( tail ), запросы ( query ), а также прием файлов журнала в формате JSON или простого текста ( ingest ) и многое другое.

Начиная

Установщик Seq для Windows включает seqcli . В противном случае загрузите версию для своей операционной системы. Или, если у вас установлен dotnet , seqcli можно установить как глобальный инструмент, используя:

 dotnet tool install --global seqcli

Чтобы установить URL-адрес сервера по умолчанию и ключ API, выполните:

 seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key

Ключ API будет храниться в вашем файле конфигурации SeqCli.json ; в Windows это шифруется с помощью DPAPI; на Mac/Linux ключ в настоящее время хранится в виде обычного текста. В качестве альтернативы хранению ключа API в конфигурации его можно передавать каждой команде через аргумент --apikey= .

seqcli также доступен в виде контейнера Docker в datalust/seqcli :

 docker run --rm datalust/seqcli:latest  []

Чтобы подключиться к Seq в Docker-контейнере на локальном компьютере, используйте IP-адрес компьютера (не localhost) или укажите сетевое соединение хоста Docker с помощью --net host .

Используйте сети и тома Docker, чтобы сделать локальные файлы и другие контейнеры доступными для seqcli внутри своего контейнера.

Переопределения переменных среды

Каждое значение параметра можно переопределить во время выполнения, указав переменную среды в форме SEQCLI_ , где содержится один элемент для каждого разделенного точками сегмента имени параметра, разделенного подчеркиванием.

Например, параметр connection.serverUrl можно переопределить с помощью переменной SEQCLI_CONNECTION_SERVERURL .

Подключение без ключа API

Если вы автоматизируете настройку Seq, скорее всего, у вас еще нет ключа API для использования seqcli . Во время первоначальной настройки сервера Seq вы можете указать firstRun.adminUsername и firstRun.adminPasswordHash (или эквивалентные переменные среды SEQ_FIRSTRUN_ADMINUSERNAME и SEQ_FIRSTRUN_ADMINPASSWORDHASH ), чтобы установить исходное имя пользователя и пароль для учетной записи администратора. Вы можете использовать их для создания ключа API, а затем использовать токен ключа API с остальными командами seqcli .

Команда seqcli apikey create принимает --connect-username и --connect-password-stdin и печатает новый токен ключа API в STDOUT (синтаксис PowerShell используется ниже):

 $user = "admin"
$pw = "thepassword"
$token = (
  echo $pw |
  seqcli apikey create `
    -t CLI `
    --permissions="Read,Write,Project,Organization,System" `
    --connect-username $user --connect-password-stdin
)

Содействие

См. CONTRIBUTING.md .

Разрешения

При подключении с помощью ключа API разрешенные операции определяются разрешениями, назначенными этому ключу API.

Чтобы определить разрешение, необходимое для команды, проверьте столбец «Требование разрешения» эквивалентной операции API сервера. Например, команда apikey create использует конечную точку POST api/apikeys , для которой требуется разрешение Write .

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

Все команды seqcli следуют одному и тому же шаблону:

 seqcli  []

Справка по командам

Полный список поддерживаемых команд можно просмотреть, выполнив:

 seqcli help

Чтобы просмотреть информацию об использовании конкретной команды, запустите seqcli help , например:

 seqcli help apikey create

Это также работает для командных групп; чтобы просмотреть все подкоманды apikey , запустите:

 seqcli help apikey

Доступные команды

• apikey
  • apikey create — Создайте ключ API для автоматизации или приема.
  • apikey list — список доступных ключей API.
  • apikey remove — удалить ключ API с сервера.
  • apikey update — обновить существующий ключ API.
• app
  • app define — создайте определение приложения для подключаемого модуля .NET [SeqApp] .
  • app install — установка пакета приложения.
  • app list — список установленных пакетов приложений.
  • app run — размещение подключаемого модуля .NET [SeqApp] .
  • app uninstall — удаление пакета приложения.
  • app update — обновление установленного пакета приложения.
• appinstance
  • appinstance create — создать экземпляр установленного приложения.
  • appinstance list — список экземпляров установленных приложений.
  • appinstance remove — удалить экземпляр приложения с сервера.
  • appinstance update — обновление существующего экземпляра приложения.
• bench — Измерьте производительность запросов.
• config — просмотр и установка полей в файле SeqCli.json ; запустить без аргументов, чтобы вывести список всех полей.
• dashboard
  • dashboard list — список панелей мониторинга.
  • dashboard remove — удалить панель мониторинга с сервера.
  • dashboard render — создание набора результатов CSV или JSON из диаграммы информационной панели.
• expressionindex
  • expressionindex create — Создайте индекс выражения.
  • expressionindex list — Список индексов выражений.
  • expressionindex remove — Удалить индекс выражения с сервера.
• feed
  • feed create — Создайте канал NuGet.
  • feed list — список каналов NuGet.
  • feed remove — удалить канал NuGet с сервера.
  • feed update — обновление существующего канала NuGet.
• help — Показать информацию о доступных командах.
• index
  • index list — Список индексов.
  • index suppress — Подавить индекс.
• ingest — Отправка событий журнала из файла или STDIN .
• license apply — применить лицензию к серверу Seq.
• log — отправить на сервер событие структурированного журнала.
• node
  • node demote — Начать понижение текущего узла-лидера.
  • node health — проверьте конечную точку /health узла Seq и распечатайте возвращенный код состояния HTTP или «Недоступно», если конечную точку невозможно запросить.
  • node list — список узлов в кластере Seq.
• print — Симпатичная печать событий в формате CLEF/JSON из файла или STDIN .
• profile
  • profile create — создание или замена профиля подключения.
  • profile list — список профилей подключения.
  • profile remove — Удалить профиль подключения.
• query — выполните SQL-запрос и получите результаты в формате CSV.
• retention
  • retention create — Создайте политику хранения.
  • retention list — список политик хранения.
  • retention remove — удалить политику хранения с сервера.
  • retention update — обновление существующей политики хранения.
• sample
  • sample ingest — регистрируйте события выборки в экземпляре Seq.
  • sample setup — настройте экземпляр Seq с образцами информационных панелей, сигналов, пользователей и т. д.
• search — получение событий журнала, соответствующих заданному фильтру.
• setting
  • setting clear — Очистить настройку сервера, настраиваемую во время выполнения.
  • setting names — печать названий всех поддерживаемых настроек.
  • setting set — изменение настраиваемых во время выполнения настроек сервера.
  • setting show — Распечатайте текущее значение настраиваемого во время выполнения параметра сервера.
• signal
  • signal create — Создайте сигнал.
  • signal import — Импортируйте сигналы в формате JSON с разделителями-новой строкой.
  • signal list — Список доступных сигналов.
  • signal remove — Удалить сигнал с сервера.
  • signal update — Обновите существующий сигнал.
• tail — Поток событий журнала, соответствующих фильтру.
• template
  • template export — экспорт объектов в файлы шаблонов.
  • template import — импортируйте объекты из файлов шаблонов.
• user
  • user create — Создать пользователя.
  • user list — список пользователей.
  • user remove — удалить пользователя с сервера.
  • user update — обновление существующего пользователя.
• version — Распечатайте текущую исполняемую версию.
• workspace
  • workspace create — создать рабочую область.
  • workspace list — список доступных рабочих пространств.
  • workspace remove — удалить рабочую область с сервера.
  • workspace update — обновление существующей рабочей области.

apikey create

Создайте ключ API для автоматизации или приема.

Пример:

 seqcli apikey create -t 'Test API Key' -p Environment=Test

Вариант	Описание
-t , --title=VALUE	Название ключа API
--token=VALUE	Предварительно выделенный токен ключа API; по умолчанию будет сгенерирован новый токен и записан в STDOUT
-p , --property=NAME=VALUE	Укажите свойства имени/значения, например -p Customer=C123 -p Environment=Production
--filter=VALUE	Фильтр для применения к входящим событиям
--minimum-level=VALUE	Минимальный уровень/серьезность события, которую следует принять; по умолчанию принимаются все события
--use-server-timestamps	Отменить временные метки, предоставленные клиентом, и использовать значения часов сервера.
--permissions=VALUE	Список разрешений, разделенных запятыми, которые можно делегировать ключу API; действительные разрешения: Ingest (по умолчанию), Read , Write , Project и System
--connect-username=VALUE	Имя пользователя для подключения, полезно в первую очередь при настройке первого ключа API; серверы с индивидуальной подпиской разрешают только один одновременный запрос с этой опцией
--connect-password=VALUE	Если указано connect-username , соответствующий пароль
--connect-password-stdin	Когда указано connect-username , прочитайте соответствующий пароль из STDIN
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

apikey list

Список доступных ключей API.

Пример:

 seqcli apikey list

Вариант	Описание
-t , --title=VALUE	Название ключей API для вывода в список
-i , --id=VALUE	Идентификатор одного ключа API для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

apikey remove

Удалите ключ API с сервера.

Пример:

 seqcli apikey remove -t 'Test API Key'

Вариант	Описание
-t , --title=VALUE	Название ключей API, которые нужно удалить.
-i , --id=VALUE	Идентификатор одного ключа API, который нужно удалить.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

apikey update

Обновите существующий ключ API.

Пример:

 seqcli apikey update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленный ключ API в формате JSON; это можно сделать с помощью seqcli apikey list --json
--json-stdin	Прочтите обновленный ключ API в формате JSON из STDIN
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

app define

Создайте определение приложения для подключаемого модуля .NET [SeqApp] .

Пример:

 seqcli app define -d "./bin/Debug/netstandard2.2"

Вариант	Описание
-d , --directory=VALUE	Каталог, содержащий сборки .NET Standard; по умолчанию используется текущий каталог
--type=VALUE	Имя типа подключаемого модуля [SeqApp]; по умолчанию сканируются сборки на предмет одного типа, отмеченного этим атрибутом.
--indented	Форматирование определения в несколько строк с отступами

app install

Установите пакет приложения.

Пример:

 seqcli app install --package-id 'Seq.App.JsonArchive'

Вариант	Описание
--package-id=VALUE	Идентификатор пакета приложения для установки.
--version=VALUE	Версия пакета для установки; по умолчанию устанавливается последняя версия
--feed-id=VALUE	Идентификатор канала NuGet, из которого необходимо установить пакет; можно опустить, если настроен только один канал
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

app list

Список установленных пакетов приложений.

Пример:

 seqcli app list

Вариант	Описание
--package-id=VALUE	Идентификатор пакета приложений, которые нужно перечислить.
-i , --id=VALUE	Идентификатор одного приложения для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

app run

Разместите плагин .NET [SeqApp] .

Пример:

 seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]

Вариант	Описание
-d , --directory=VALUE	Каталог, содержащий сборки .NET Standard; по умолчанию используется текущий каталог
--type=VALUE	Имя типа подключаемого модуля [SeqApp]; по умолчанию сканируются сборки на предмет одного типа, отмеченного этим атрибутом.
-p , --property=NAME=VALUE	Укажите настройки имени/значения для приложения, например -p [email protected] -p Subject="Alert!"
--storage=VALUE	Каталог, в котором могут храниться данные, относящиеся к приложению; по умолчанию используется текущий каталог
-s , --server=VALUE	URL-адрес сервера Seq, используемый только для настройки приложения (соединение с сервером не осуществляется); по умолчанию будет использоваться значение connection.serverUrl
--server-instance=VALUE	Имя экземпляра сервера Seq, используемое только для конфигурации приложения; по умолчанию имя экземпляра отсутствует
-t , --title=VALUE	Заголовок экземпляра приложения, используемый только для конфигурации приложения; по умолчанию используется заголовок-заполнитель.
--id=VALUE	Идентификатор экземпляра приложения, используемый только для конфигурации приложения; по умолчанию используется идентификатор заполнителя.
--read-env	Считайте конфигурацию и настройки приложения из переменных среды, как указано в https://docs.datatalust.co/docs/seq-apps-in-other-languages; игнорирует все параметры, кроме --directory и --type

app uninstall

Удалите пакет приложения.

Пример:

 seqcli app uninstall --package-id 'Seq.App.JsonArchive'

Вариант	Описание
--package-id=VALUE	Идентификатор пакета приложения, который нужно удалить.
-i , --id=VALUE	Идентификатор одного пакета приложения, который нужно удалить.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

app update

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

Пример:

 seqcli app update -n 'HTML Email'

Вариант	Описание
-i , --id=VALUE	Идентификатор одного установленного приложения для обновления.
-n , --name=VALUE	Имя установленного приложения для обновления
--all	Обновите все установленные приложения; несовместимо с -i или -n
--version=VALUE	Версия пакета для обновления; по умолчанию выполняется обновление до последней версии в соответствующем канале.
--force	Обновите приложение, даже если целевая версия уже установлена.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

appinstance create

Создайте экземпляр установленного приложения.

Пример:

 seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]

Вариант	Описание
-t , --title=VALUE	Название экземпляра приложения
--app=VALUE	Идентификатор установленного пакета приложения для создания экземпляра.
-p , --property=NAME=VALUE	Укажите настройки имени/значения для приложения, например -p [email protected] -p Subject="Alert!"
--stream[=VALUE]	Передавайте входящие события в этот экземпляр приложения по мере их приема; опционально принимает выражение сигнала, ограничивающее, какие события должны передаваться в потоковом режиме, например signal-1,signal-2
--overridable=VALUE	Укажите имена параметров, которые могут быть переопределены пользователями при вызове приложения.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

appinstance list

Список экземпляров установленных приложений.

Пример:

 seqcli appinstance list

Вариант	Описание
-t , --title=VALUE	Название экземпляров приложения, которые нужно перечислить
-i , --id=VALUE	Идентификатор одного экземпляра приложения для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

appinstance remove

Удалите экземпляр приложения с сервера.

Пример:

 seqcli appinstance remove -t 'Email Ops'

Вариант	Описание
-t , --title=VALUE	Название экземпляров приложения, которые нужно удалить.
-i , --id=VALUE	Идентификатор одного экземпляра приложения, который нужно удалить.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

appinstance update

Обновите существующий экземпляр приложения.

Пример:

 seqcli appinstance update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленный экземпляр приложения в формате JSON; это можно сделать с помощью seqcli appinstance list --json
--json-stdin	Считайте обновленный экземпляр приложения в формате JSON из STDIN
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

bench

Измерьте производительность запросов.

Вариант	Описание
-r , --runs=VALUE	Количество запусков для выполнения; по умолчанию 10
-c , --cases=VALUE	Файл JSON, содержащий набор дел для запуска. По умолчанию используется стандартный набор случаев.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--start=VALUE	Дата/время ISO 8601 для запроса
--end=VALUE	Дата/время ISO 8601 для запроса
--reporting-server=VALUE	Адрес сервера Seq для отправки результатов тестирования.
--reporting-apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу отчетов.
--description=VALUE	Дополнительное описание стендового испытания
--with-ingestion	Должен ли тест включать отправку событий в Seq
--with-queries	Должен ли эталонный тест включать запрос Seq

config

Просмотр и установка полей в файле SeqCli.json ; запустить без аргументов, чтобы вывести список всех полей.

Вариант	Описание
-k , --key=VALUE	Поле, например connection.serverUrl
-v , --value=VALUE	Значение поля; если не указано, команда напечатает текущее значение
-c , --clear	Очистить поле

dashboard list

Перечислите информационные панели.

Пример:

 seqcli dashboard list

Вариант	Описание
-t , --title=VALUE	Название панелей мониторинга, которые нужно перечислить
-i , --id=VALUE	Идентификатор одной информационной панели для вывода в список
-o , --owner=VALUE	Идентификатор пользователя, для которого нужно вывести список панелей мониторинга; по умолчанию отображаются общие панели мониторинга
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

dashboard remove

Удалите панель мониторинга с сервера.

Пример:

 seqcli dashboard remove -i dashboard-159

Вариант	Описание
-t , --title=VALUE	Название панелей мониторинга, которые нужно удалить
-i , --id=VALUE	Идентификатор одной информационной панели, которую нужно удалить.
-o , --owner=VALUE	Идентификатор пользователя, для которого нужно удалить панели мониторинга; по умолчанию общие информационные панели удалены
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

dashboard render

Создайте набор результатов CSV или JSON на основе диаграммы информационной панели.

Пример:

 seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h

Вариант	Описание
-i , --id=VALUE	Идентификатор отдельной панели мониторинга для отображения
-c , --chart=VALUE	Название диаграммы на информационной панели для отображения
--last=VALUE	Длительность, в течение которой должна отображаться диаграмма, например 7d ; это будет выровнено по границе интервала; необходимо указать либо --last , либо --start и --end
--by=VALUE	Интервал временного интервала для данных диаграммы в виде продолжительности, например 1h
--start=VALUE	Дата/время ISO 8601 для запроса
--end=VALUE	Дата/время ISO 8601 для запроса
--signal=VALUE	Выражение сигнала или список пересекающихся идентификаторов сигналов, например signal-1,signal-2
--timeout=VALUE	Таймаут выполнения в миллисекундах
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

expressionindex create

Создайте индекс выражения.

Пример:

 seqcli expressionindex create --expression "ServerName"

Вариант	Описание
-e , --expression=VALUE	Выражение для индексирования
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

expressionindex list

Индексы выражений списка.

Пример:

 seqcli expressionindex list

Вариант	Описание
-i , --id=VALUE	Идентификатор индекса одного выражения для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

expressionindex remove

Удалить индекс выражения с сервера.

Пример:

 seqcli expressionindex -i expressionindex-2529

Вариант	Описание
-i , --id=VALUE	Идентификатор индекса выражения, который нужно удалить
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

feed create

Создайте канал NuGet.

Пример:

 seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin

Вариант	Описание
-n , --name=VALUE	Уникальное имя фида
-l , --location=VALUE	Место подачи; это может быть URL-адрес канала NuGet v2 или v3 или путь к локальной файловой системе на сервере Seq.
-u , --username=VALUE	Имя пользователя Seq должно указываться при подключении к каналу, если требуется аутентификация.
-p , --password=VALUE	Пароль канала, если требуется аутентификация; обратите внимание, что --password-stdin более безопасен
--password-stdin	Прочитайте пароль канала из STDIN
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

feed list

Получение списка каналов NuGet.

Пример:

 seqcli feed list

Вариант	Описание
-n , --name=VALUE	Название фида для вывода в список
-i , --id=VALUE	Идентификатор одного фида для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

feed remove

Удалите канал NuGet с сервера.

Пример:

 seqcli feed remove -n CI

Вариант	Описание
-n , --name=VALUE	Название фида, который нужно удалить
-i , --id=VALUE	Идентификатор одного фида, который нужно удалить.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

feed update

Обновите существующий канал NuGet.

Пример:

 seqcli feed update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленный канал NuGet в формате JSON; это можно сделать с помощью seqcli feed list --json
--json-stdin	Прочитайте обновленный канал NuGet в формате JSON из STDIN
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

help

Показать информацию о доступных командах.

Пример:

 seqcli help search

Вариант	Описание
-m , --markdown	Создать уценку для использования в документации

index list

Список индексов.

Пример:

 seqcli index list

Вариант	Описание
-i , --id=VALUE	Идентификатор одного индекса для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

index suppress

Подавить индекс.

Пример:

 seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748

Вариант	Описание
-i , --id=VALUE	Идентификатор индекса для подавления
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

ingest

Отправлять события журнала из файла или STDIN .

Пример:

'Debug'" -p Environment=Test">

 seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test

Вариант	Описание
-i , --input=VALUE	Файл(ы) для загрузки, включая подстановочный знак * ; если не указано, будет использоваться STDIN
--invalid-data=VALUE	Укажите, как обрабатывать недопустимые данные: fail (по умолчанию) или ignore
-p , --property=NAME=VALUE	Укажите свойства имени/значения, например -p Customer=C123 -p Environment=Production
-x , --extract=VALUE	Шаблон извлечения, применяемый к журналам в виде обычного текста (игнорируется, если указан параметр --json ).
--json	Чтение событий в формате JSON (по умолчанию предполагается обычный текст)
-f , --filter=VALUE	Выражение фильтра для выбора подмножества событий
-m , --message=VALUE	Сообщение, которое нужно связать с принятыми событиями; Поддерживается синтаксис https://messagetemplates.org.
-l , --level=VALUE	Уровень или серьезность, которую следует связать с принятыми событиями; это переопределит любую информацию об уровне, присутствующую в самих событиях
--send-failure=VALUE	Укажите, как обрабатываются сбои подключения: fail (по умолчанию), retry , continue или ignore
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey
--batch-size=VALUE	Максимальное количество событий, отправляемых в каждом запросе к конечной точке приема; если не указано, будет использоваться значение 100

license apply

Примените лицензию к серверу Seq.

Пример:

 seqcli license apply --certificate="license.txt"

Вариант	Описание
-c , --certificate=VALUE	Файл сертификата; файл должен иметь текстовый формат UTF-8
--certificate-stdin	Прочтите лицензионный сертификат из STDIN
--automatically-refresh	Если лицензия предназначена для подписки, периодически проверяйте datalust.co и автоматически обновляйте сертификат при изменении или продлении подписки.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

log

Отправьте событие структурированного журнала на сервер.

Пример:

 seqcli log -m 'Hello, {Name}!' -p Name=World -p App=Test

Вариант	Описание
-m , --message=VALUE	Сообщение, связанное с событием (по умолчанию сообщение не отправляется); Поддерживается синтаксис https://messagetemplates.org.
-l , --level=VALUE	Уровень или серьезность события (по умолчанию — Information ).
-t , --timestamp=VALUE	Временная метка события в формате ISO-8601 (по умолчанию будет использоваться текущая временная метка UTC).
-x , --exception=VALUE	Дополнительная информация об исключении или ошибке для отправки, если таковая имеется.
-p , --property=NAME=VALUE	Укажите свойства имени/значения, например -p Customer=C123 -p Environment=Production
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

node demote

Начать понижение текущего узла-лидера.

Пример:

 seqcli node demote --verbose --wait

Вариант	Описание
--wait	Подождите, пока лидер будет понижен в должности, прежде чем выйти.
-y , --confirm	Ответьте [y]es, когда будет предложено продолжить.
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

node health

Проверьте конечную точку /health узла Seq и распечатайте возвращенный код состояния HTTP или «Недоступно», если конечную точку не удалось запросить.

Пример:

 seqcli node health -s https://seq-2.example.com

Вариант	Описание
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

node list

Список узлов в кластере Seq.

Пример:

 seqcli node list --json

Вариант	Описание
-n , --name=VALUE	Имя узла кластера для вывода в список
-i , --id=VALUE	Идентификатор одного узла кластера для вывода в список
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; по умолчанию будет использоваться значение конфигурации connection.serverUrl
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу; по умолчанию будет использоваться значение конфигурации connection.apiKey
--profile=VALUE	Используемый профиль подключения; по умолчанию будут использоваться значения конфигурации connection.serverUrl и connection.apiKey

print

Симпатичная печать событий в формате CLEF/JSON из файла или STDIN .

Пример:

 seqcli print -i log-20201028.clef

Вариант	Описание
-i , --input=VALUE	CLEF-файл для чтения, включая подстановочный знак * ; если не указано, будет использоваться STDIN
-f , --filter=VALUE	Выражение фильтра для выбора подмножества событий
--template=VALUE	Укажите шаблон вывода для управления форматированием обычного текста.
--invalid-data=VALUE	Укажите, как обрабатывать недопустимые данные: fail (по умолчанию) или ignore
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )

profile create

Создайте или замените профиль подключения.

Пример:

 seqcli profile create -n Production -s https://seq.example.com -a th15ISanAPIk3y

Вариант	Описание
-n , --name=VALUE	Имя профиля подключения
-s , --server=VALUE	URL-адрес сервера Seq
-a , --apikey=VALUE	Ключ API, который будет использоваться при подключении к серверу, если требуется.

profile list

Список профилей подключения.

Пример:

 seqcli profile list

profile remove

Удалить профиль подключения.

Пример:

 seqcli profile remove -n Production

Вариант	Описание
-n , --name=VALUE	Имя профиля подключения, который нужно удалить

query

Выполните SQL-запрос и получите результаты в формате CSV.

Пример:

 seqcli query -q "select count(*) from stream group by @Level" --start="2018-02-28T13:00Z"

Вариант	Описание
-q , --query=VALUE	Запрос для выполнения
--start=VALUE	Дата/время ISO 8601 для запроса
--end=VALUE	Дата/время ISO 8601 для запроса
--signal=VALUE	Выражение сигнала или список пересекающихся идентификаторов сигналов, например signal-1,signal-2
--timeout=VALUE	Таймаут выполнения в миллисекундах
--json	Вывод вывода в формате JSON с разделителями-новой строкой (по умолчанию — обычный текст)
--no-color	Не раскрашивать вывод текста
--force-color	Принудительно перенаправленный вывод будет иметь цвет ANSI (если также не указан --no-color )
-s , --server=VALUE	URL-адрес сервера Seq; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

retention create

Создать политику удержания.

Пример:

 seqcli retention create --after 30d --delete-all-events

Вариант	Описание
--after=VALUE	Продолжительность, после которой политика удалит события, например, 7d
--delete-all-events	Политика должна удалить все события (в настоящее время единственный поддерживаемый вариант)
--delete=VALUE	Поток входящих событий в этот экземпляр приложения, когда они принимают участие; По желанию принимает сигнал, ограничивая, какие события следует транслировать
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)

retention list

Политики сохранения списка.

Пример:

 seqcli retention list

Вариант	Описание
-i , --id=VALUE	Идентификатор единой политики удержания для перечисления
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

retention remove

Удалить политику удержания с сервера.

Пример:

 seqcli retention remove -i retentionpolicy-17

Вариант	Описание
-i , --id=VALUE	Идентификатор одной политики удержания для удаления
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

retention update

Обновите существующую политику удержания.

Пример:

 seqcli retention update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленная политика удержания в формате JSON; Это может быть произведено с использованием seqcli retention list --json
--json-stdin	Прочитайте обновленную политику удержания как JSON от STDIN
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

sample ingest

Журнал образца событий в экземпляр SEQ.

Пример:

 seqcli sample ingest

Вариант	Описание
-y , --confirm	Ответьте [Y], когда будет предложено продолжить
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться
--quiet	Не эхо проглатывали события в STDOUT
--batch-size=VALUE	Максимальное количество событий для отправки в каждом запросе в конечную точку проглатывания; Если не указано значение 100

sample setup

Настройте экземпляр SEQ с помощью образцов мониторинга, сигналов, пользователей и т. Д.

Пример:

 seqcli sample setup

Вариант	Описание
-y , --confirm	Ответьте [Y], когда будет предложено продолжить
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

search

Получить события журнала, которые соответствуют данному фильтру.

Пример:

 seqcli search -f "@Exception like '%TimeoutException%'" -c 30

Вариант	Описание
-f , --filter=VALUE	Фильтр для применения к поиску, например, Host = 'xmpweb-01.example.com'
-c , --count=VALUE	Максимальное количество событий для извлечения; по умолчанию 1
--start=VALUE	ISO 8601 Дата/время для запроса
--end=VALUE	ISO 8601 Дата/время, чтобы запросить
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
--signal=VALUE	Выражение сигнала или список интерсезированных идентификаторов сигнала для применения, например, signal-1,signal-2
--request-timeout=VALUE	Время разрешено получить каждую страницу событий, в миллисекундах; по умолчанию 100000
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

setting clear

Очистить настройку сервера, способствующего времени выполнения.

Вариант	Описание
-n , --name=VALUE	Имя настройки, например, OpenIdConnectClientSecret
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

setting names

Распечатайте названия всех поддерживаемых настроек.

setting set

Измените настройку сервера, настроенную на время выполнения.

Вариант	Описание
-n , --name=VALUE	Имя настройки, например, OpenIdConnectClientSecret
-v , --value=VALUE	Значение настройки, разделенное запятыми, если принимаются несколько значений
--value-stdin	Прочитайте значение из STDIN
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

setting show

Распечатайте текущее значение настройки сервера, способствующей времени выполнения.

Вариант	Описание
-n , --name=VALUE	Имя настройки, например, OpenIdConnectClientSecret
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

signal create

Создать сигнал.

Пример:

 seqcli signal create -t 'Exceptions' -f "@Exception is not null"

Вариант	Описание
-t , --title=VALUE	Заголовок для сигнала
--description=VALUE	Описание для сигнала
-f , --filter=VALUE	Фильтр, чтобы связать с сигналом
-c , --column=VALUE	Столбец для связи с сигналом; Этот аргумент можно использовать несколько раз
--group=VALUE	Явное название группы для связи с сигналом; По умолчанию заключается в выводе группы из фильтра
--no-group	Укажите, что ни одна группа не должна быть выведена; По умолчанию заключается в выводе группы из фильтра
--protected	Укажите, что сигнал редактируется только администраторами
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)

signal import

Сигналы импорта в формате json, сформированного Newline.

Пример:

 seqcli signal import -i ./Exceptions.json

Вариант	Описание
--merge	Сигналы обновления, которые имеют идентификаторы, соответствующие тем, которые в импортированных данных; По умолчанию всегда создавать новые сигналы
-i , --input=VALUE	Файл в импорт; Если не указано, будет использоваться STDIN
-o , --owner=VALUE	Идентификатор пользователя для импорта сигналов; по умолчанию общие сигналы импортируются
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

signal list

Список доступных сигналов.

Пример:

 seqcli signal list

Вариант	Описание
-t , --title=VALUE	Заголовок сигнала (ы) для перечисления
-i , --id=VALUE	Идентификатор одного сигнала для перечисления
-o , --owner=VALUE	Идентификатор пользователя для перечисления сигналов; По умолчанию общие сигналы являются списками
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

signal remove

Удалить сигнал с сервера.

Пример:

 seqcli signal remove -t 'Test Signal'

Вариант	Описание
-t , --title=VALUE	Заголовок сигнала (ы) для удаления
-i , --id=VALUE	Идентификатор одного сигнала для удаления
-o , --owner=VALUE	Идентификатор пользователя для удаления сигналов; По умолчанию общие сигналы removd
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

signal update

Обновите существующий сигнал.

Пример:

 seqcli signal update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленный сигнал в формате JSON; Это может быть произведено с помощью seqcli signal list --json
--json-stdin	Прочитайте обновленный сигнал как json от STDIN
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

tail

События журнала потока, соответствующие фильтру.

Вариант	Описание
-f , --filter=VALUE	Дополнительный фильтр на стороне сервера для применения к потоку, например @Level = 'Error'
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
--signal=VALUE	Выражение сигнала или список интерсезированных идентификаторов сигнала для применения, например, signal-1,signal-2
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

template export

Экспортные объекты в файлы шаблонов.

Пример:

 seqcli template export -o ./Templates

Вариант	Описание
-o , --output=VALUE	Каталог, в котором можно писать файлы шаблонов; Справочник должен существовать; Любые существующие файлы с именами, соответствующими экспортируемым шаблонам, будут перезаписаны; по умолчанию есть .
-i , --include=VALUE	Идентификатор сигнала, панель панели, сохраненного запроса, рабочего пространства или политики удержания для экспорта; Этот аргумент может быть указан несколько раз; По умолчанию - экспорт всех общих организаций
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

template import

Импортные объекты из шаблонов файлов.

Пример:

 seqcli template import -i ./Templates

Вариант	Описание
-i , --input=VALUE	Каталог, из которого можно прочитать набор файлов .template ; по умолчанию есть .
--state=VALUE	Путь файла, который сохранит отображение имен шаблонов с идентификаторами созданных объектов на целевом сервере, избегая дубликатов при выполнении нескольких импортов; По умолчанию будет использоваться import.state в каталоге ввода
--merge	Для шаблонов без записей в файле .state сначала проверьте на существующие объекты с соответствующими именами или названиями; не поддерживает слияние политики удержания
-g , --arg=NAME=VALUE	Аргументы шаблона, например -g ownerId=user-314159
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

user create

Создайте пользователя.

Пример:

 seqcli user create -n alice -d 'Alice Example' -r 'User (read/write)' --password-stdin

Вариант	Описание
-n , --name=VALUE	Уникальное имя пользователя для пользователя
-d , --display-name=VALUE	Имя длинного формы, которое поможет в определении пользователя
-f , --filter=VALUE	Фильтр представления, который ограничивает события, видимые пользователю
-r , --role=VALUE	Заголовок роли, которая дает разрешения пользователя на сервере; Если не указано, роль нового пользователя по умолчанию будет назначена
-e , --email=VALUE	Адрес электронной почты пользователя (включает изображение Gravatar для пользователя)
-p , --password=VALUE	Первоначальный пароль для пользователя, если используется аутентификация имени пользователя/пароля; Обратите внимание, что --password-stdin
--password-stdin	Прочтите начальный пароль для пользователя из STDIN , если используется аутентификация имени пользователя/пароля
--no-password-change	Не заставляйте пользователя изменить свой пароль при следующем входе в систему
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)

user list

Перечислите пользователей.

Пример:

 seqcli user list

Вариант	Описание
-n , --name=VALUE	Имя пользователя пользователя (ы) для перечисления
-i , --id=VALUE	Идентификатор одного пользователя для перечисления
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

user remove

Удалить пользователя с сервера.

Пример:

 seqcli user remove -n alice

Вариант	Описание
-n , --name=VALUE	Имя пользователя пользователя (ы) для удаления
-i , --id=VALUE	Идентификатор одного пользователя для удаления
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

user update

Обновите существующего пользователя.

Пример:

 seqcli user update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленный пользователь в формате JSON; Это может быть произведено с помощью seqcli user list --json
--json-stdin	Прочитайте обновленный пользователь как json от STDIN
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

version

Распечатайте текущую исполняемую версию.

workspace create

Создайте рабочее пространство.

Пример:

 seqcli workspace create -t 'My Workspace' -c signal-314159 -c dashboard-628318

Вариант	Описание
-t , --title=VALUE	Название для рабочей области
--description=VALUE	Описание для рабочей области
-c , --content=VALUE	Идентификатор приборной панели, сигнала или сохраненного запроса, чтобы включить в рабочую область
--protected	Укажите, что рабочее пространство редактируется только администраторами
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)

workspace list

Список доступных рабочих пространств.

Пример:

 seqcli workspace list

Вариант	Описание
-t , --title=VALUE	Название рабочего пространства (ы) для перечисления
-i , --id=VALUE	Идентификатор одного рабочего пространства для перечисления
-o , --owner=VALUE	Идентификатор пользователя для перечисления рабочих пространств; по умолчанию, общие рабочие пространства являются списками
--json	Вывод печати в newline delimited json (по умолчанию-простой текст)
--no-color	Не раскрашивайте вывод текста
--force-color	Передача от перенаправления, чтобы иметь цвет ANSI (если --no-color ) также не указан)
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

workspace remove

Удалить рабочее пространство с сервера.

Пример:

 seqcli workspace remove -t 'My Workspace'

Вариант	Описание
-t , --title=VALUE	Название рабочего пространства (ы) для удаления
-i , --id=VALUE	Идентификатор одного рабочего пространства для удаления
-o , --owner=VALUE	Идентификатор пользователя для удаления рабочих пространств; По умолчанию общие рабочие пространства восстанавливаются
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

workspace update

Обновите существующее рабочее пространство.

Пример:

 seqcli workspace update --json '{...}'

Вариант	Описание
--json=VALUE	Обновленное рабочее пространство в формате JSON; Это может быть произведено с помощью seqcli workspace list --json
--json-stdin	Прочитайте обновленное рабочее пространство как JSON от STDIN
-s , --server=VALUE	URL -адрес сервера SEQ; По умолчанию будет использоваться значение connection.serverUrl
-a , --apikey=VALUE	Ключ API для использования при подключении к серверу; По умолчанию будет использоваться значение connection.apiKey
--profile=VALUE	Профиль подключения для использования; По умолчанию connection.serverUrl и connection.apiKey значения конфигурации будут использоваться

Схемы извлечения

Команда seqcli ingest может использоваться для анализа журналов простых текстов в структурированные события журнала.

seqcli ingest -x " {@t:timestamp} [{@l:level}] {@m:*}{:n}{@x:*} "

Приведенный выше аргумент -x -это шаблон извлечения , которая будет анализировать такие события, как:

 2018-02-21 13:29:00.123 +10:00 [ERR] The operation failed
System.DivideByZeroException: Attempt to divide by zero
  at SomeClass.SomeMethod()

Синтаксис

Паттерны извлечения имеют простой синтаксис высокого уровня:

• Текст, который появляется в рисунке, сочетается буквально - так что такой узор, как Hello, world! соответствует операторам журнала, которые состоят только из этого приветствия,
• Текст между {curly braces} - это совпадение выражения , которое идентифицирует часть события, которое будет извлечено, и
• Буквальные вьющиеся скобки сбежаются удвоением, поэтому {{ соответствует буквальному тексту { и }} совпадениям } .

Выражения соответствия имеют форму:

 {name:matcher}

И имя, и сочетание необязательны, но должен быть указан один или другой. Следовательно, {@t:timestamp} указывает имя @t и значение timestamp , {IPAddress} Определяет только имя и {:n} только значение (в данном случае встроенный новый сочетание).

Имя - это имя свойства, которое нужно извлечь; Есть четыре встроенных названия свойств, которые получают специальную обработку:

• @t - The TimeStance события
• @m - текстовое сообщение, связанное с событием
• @l - уровень события
• @x - Исключение или обратная промышленность, связанные с событием

Другие имена свойств прилагаются к полезной нагрузке события, поэтому {Elapsed:dec} извлечет свойство, называемое Elapsed , используя dec -десятичный сочетание.

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

Маттерс

Сопоставщики идентифицируют куски события ввода.

Необходимы различные совпадения, чтобы кусок текста, такой как 200OK можно разделить на отдельные свойства, то есть {StatusCode:nat}{Status:alpha} . Здесь сопоставление nat (естественное число) также приводит к принуждению к числовому значению, так что он прикреплен к полезной нагрузке события как 200 вместо текста "200" .

Есть три вида совпадения:

• Маттеры, такие как alpha и nat являются встроенными именами .
• Специальные совпадения * , ** и так же, являются не-восточным совпадением контента ; Они будут соответствовать любому тексту вплоть до следующего элемента шаблона ( * ), следующих двух элементов и так. Мы видели это в действии с элементами {@m:*}{:n} в примере - сообщение - все текст до следующей новой линии.
• Более сложные сочетания состава описываются с использованием субэкспрессии. Они префикс с помощью equals sign = , например {Phone:={:nat}-{:nat}-{:nat}} . Это извлечет куски текста, такие как 123-456-7890 в свойство Phone .

Маттер	Описание	Пример
* , ** , ...	Не-сильное содержание
alpha	Одна или несколько букв	Abc
alphanum	Одна или несколько букв или цифр	a1b2
dec	Десятичное число	12.345
ident	Идентификатор C-стиля	countOfMatches
int	Целое число	-123
iso8601dt	ISO-8601 дата времени	2020-01-28T13:50:01.123
level	Имя уровня регистрации	INF
line	Любой однострочный контент	one line!
n	Новый персонаж или последовательность
nat	Неотрицательное число	123
s	Один или несколько символов пространства или вкладок
serilogdt	DateTime в формате журнала файлов Serilog по умолчанию	2020-01-28 13:50:01.123 +10:00
syslogdt	DateTime в формате системного журнала	Dec 8 09:12:13
t	Один символ вкладки
timestamp	DateTime в любом признанном формате
token	Любая последовательность не нагнетающих символов	1+x$3
trailingident	Многослойное содержание с отступами
unixdt	DateTime в Unix Time Format, поддерживающем секунд (10 цифр) или миллисекунд (12-значные)	1608694199.999
w3cdt	Формат журнала W3C. Пара даты/времени	2019-04-02 05:18:01

Обработка

Схемы извлечения обрабатываются слева направо. Когда встречается первая не совпадающая картина, извлечение останавливается; Любой оставшийся текст, который не мог быть сопоставлен, будет прикреплен к полученному событию в свойство @unmatched .

Многострочные события обрабатываются путем поиска линий, которые начинаются с первого элемента используемого шаблона извлечения. Это работает хорошо, если первая строка каждого события начинается с чего -то однозначного, например, временная метка iso8601dt ; Если линии начинаются с менее специфического синтаксиса, первые несколько элементов схемы извлечения могут быть сгруппированы для более точно определить начало событий:

 {:=[{@t} {@l}]} {@m:*}

Здесь буквальный текст [ токен временной метки, смежное пространство , уровень и закрытие ] все сгруппированы так, чтобы они представляли собой единый логический элемент шаблона, чтобы идентифицировать начало событий.

Когда журналы транслируются в seqcli ingest в режиме реального времени, применяется крайний срок 10 мс, в рамках которых должны быть получены любые строки, которые составляют событие.

Примеры

Хвостовые системы

journalctl -f -n 0 |
  seqcli ingest -x " {@t:syslogdt} {host} {ident:*}: {@m:*}{:n} " --invalid-data=ignore

Хвост /var/log/syslog

tail -c 0 -F /var/log/syslog |
  seqcli ingest -x " {@t:syslogdt} {host} {ident:*}: {@m:*}{:n} " 

Приглашение журнала веб -сервера IIS/W3C

Этот пример проглатывает файлы журналов в формате:

 # Fields: date time s-ip cs-method cs-uri-stem cs-uri-query s-port cs-username c-ip cs(User-Agent) 
cs(Referer) sc-status sc-substatus sc-win32-status sc-bytes cs-bytes time-taken

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

seqcli ingest -i http.log --invalid-data=ignore -x " {@t:w3cdt} {ServerIP} {@m:={Method} {RequestPath}} 
{Query} {Port:nat} {Username} {ClientIP} {UserAgent} {Referer} {StatusCode:nat} {Substatus:nat} 
{Win32Status:nat} {ResponseBytes:nat} {RequestBytes:nat} {Elapsed}{:n} "

Вложенная {@m:= шаблон используется для сбора подстроения строки журнала для отображения в качестве сообщения события.

Обновление сущностей

Семейство команд seqcli * update позволяет выполнять произвольные обновления для многих сложных типов объектов.

Команды update , такие как seqcli signal update показанное в приведенном ниже примере, получают обновленное представление JSON объекта через STDIN .

Это особенно хорошо работает с такими инструментами, как jq и Modern Shells с поддержкой Native JSON, такими как PowerShell:

(echo $warnings | ConvertTo-Json) | seqcli signal update --json-stdin PS > seqcli signal list -i signal-m33302 --json {"Title": "Alarms", "Description": "Automatically created", "Filters": [{"De...">

 PS > $warnings = (seqcli signal list -i signal-m33302 --json | ConvertFrom-Json)

PS > $warnings.Title                                                                                                                
Warnings

PS > $warnings.Title = "Alarms"

PS > (echo $warnings | ConvertTo-Json) | seqcli signal update --json-stdin        

PS > seqcli signal list -i signal-m33302 --json                                 
{"Title": "Alarms", "Description": "Automatically created", "Filters": [{"De...