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 <command> [<args>]
Чтобы подключиться к Seq в Docker-контейнере на локальном компьютере, используйте IP-адрес компьютера (не localhost) или укажите сетевое соединение хоста Docker с помощью --net host
.
Используйте сети и тома Docker, чтобы сделать локальные файлы и другие контейнеры доступными для seqcli
внутри своего контейнера.
Каждое значение параметра можно переопределить во время выполнения, указав переменную среды в форме SEQCLI_<setting path>
, где содержится один элемент для каждого разделенного точками сегмента имени параметра, разделенного подчеркиванием.
Например, параметр connection.serverUrl
можно переопределить с помощью переменной SEQCLI_CONNECTION_SERVERURL
.
Если вы автоматизируете настройку 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 <command> [<args>]
Полный список поддерживаемых команд можно просмотреть, выполнив:
seqcli help
Чтобы просмотреть информацию об использовании конкретной команды, запустите seqcli help <command>
, например:
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
.
Пример:
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 |