seqcli

seqcli

Seq クライアント コマンド ライン アプリ。ロギング ( seqcli log )、検索 ( search )、テーリング ( tail )、クエリ ( query )、JSON またはプレーンテキストのログ ファイルの取り込み ( ingest ) などをサポートします。

はじめる

Windows 用の Seq インストーラーには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=引数を介して各コマンドに API キーを渡すことができます。

seqcli datalust/seqcliの下の Docker コンテナとしても使用できます。

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

ローカル マシン上の Docker コンテナ内の Seq に接続するには、マシンの IP アドレス (localhost ではない) を使用するか、 --net hostで Docker ホスト ネットワークを指定します。

Docker ネットワークとボリュームを使用して、コンテナー内のseqcliローカル ファイルや他のコンテナーにアクセスできるようにします。

環境変数の上書き

各設定値は、 SEQCLI_形式の環境変数を指定することで実行時にオーバーライドできます。ここで、 には、アンダースコアで区切られた設定名のドット部分ごとに 1 つの要素が含まれます。

たとえば、 connection.serverUrl設定はSEQCLI_CONNECTION_SERVERURL変数でオーバーライドできます。

APIキーなしで接続する

Seq セットアップを自動化している場合は、 seqcliで使用する API キーをまだ持っていない可能性があります。 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 — Seq ノードの/healthエンドポイントを調査し、返された HTTP ステータス コードを出力します。エンドポイントをクエリできなかった場合は「到達不能」を出力します。
  • node list — Seq クラスター内のノードをリストします。
• print — ファイルまたはSTDINからイベントを CLEF/JSON 形式で整形印刷します。
• 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 キーを設定するときに役立ちます。 「個人」サブスクリプションを持つサーバーでは、このオプションを使用した同時リクエストは 1 つだけ許可されます
--connect-password=VALUE	connect-usernameが指定されている場合、対応するパスワード
--connect-password-stdin	connect-usernameが指定されている場合、 STDINから対応するパスワードを読み取ります。
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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 キーの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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 キーの ID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
-a 、 --apikey=VALUE	サーバーに接続するときに使用する API キー。デフォルトでは、 connection.apiKey構成値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

apikey update

既存の API キーを更新します。

例：

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

オプション	説明
--json=VALUE	JSON 形式の更新された API キー。これは、 seqcli apikey list --json使用して生成できます。
--json-stdin	更新された API キーをSTDINから JSON として読み取ります
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	インストールするアプリのパッケージID
--version=VALUE	インストールするパッケージのバージョン。デフォルトでは最新バージョンがインストールされます
--feed-id=VALUE	パッケージのインストール元となる NuGet フィードの ID。フィードが 1 つだけ設定されている場合は省略できます
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	リストするアプリのパッケージ ID
-i 、 --id=VALUE	リストする単一のアプリの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。アプリの構成にのみ使用されます (サーバーへの接続は行われません)。デフォルトでは、 connection.serverUrl値が使用されます。
--server-instance=VALUE	Seq サーバーのインスタンス名。アプリの構成にのみ使用されます。デフォルトではインスタンス名はありません
-t 、 --title=VALUE	アプリインスタンスのタイトル。アプリの構成にのみ使用されます。デフォルトではプレースホルダーのタイトルになります。
--id=VALUE	アプリのインスタンス ID。アプリの構成にのみ使用されます。デフォルトはプレースホルダー ID です。
--read-env	https://docs.datalust.co/docs/seq-apps-in-other-lungs で指定されているように、環境変数からアプリの構成と設定を読み取ります。 --directory と --type を除くすべてのオプションを無視します。

app uninstall

アプリパッケージをアンインストールします。

例：

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

オプション	説明
--package-id=VALUE	アンインストールするアプリパッケージのパッケージID
-i 、 --id=VALUE	アンインストールする単一のアプリ パッケージの ID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	更新する単一のインストール済みアプリの ID
-n 、 --name=VALUE	更新するインストール済みアプリの名前
--all	インストールされているすべてのアプリを更新します。 -iまたは-nと互換性がありません
--version=VALUE	更新するパッケージのバージョン。デフォルトでは、関連するフィードの最新バージョンに更新されます。
--force	対象バージョンがすでにインストールされている場合でもアプリを更新する
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	インスタンス化するインストール済みアプリ パッケージの ID
-p 、 --property=NAME=VALUE	アプリの名前/値設定を指定します。例: -p [email protected] -p Subject="Alert!"
--stream[=VALUE]	受信イベントが取り込まれると、このアプリ インスタンスにストリーミングします。オプションで、ストリーミングするイベントを制限するシグナル式 (たとえば、 signal-1,signal-2を受け入れます。
--overridable=VALUE	アプリの起動時にユーザーが上書きできる設定名を指定します
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	リストする単一のアプリ インスタンスの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	削除する単一のアプリインスタンスのID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	更新されたアプリ インスタンスをSTDINから JSON として読み取ります
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。デフォルトでは、 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	リストする単一のダッシュボードの ID
-o 、 --owner=VALUE	ダッシュボードをリストするユーザーの ID。デフォルトでは、共有ダッシュボードがリストされます
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	削除する単一のダッシュボードの ID
-o 、 --owner=VALUE	ダッシュボードを削除するユーザーの ID。デフォルトでは、共有ダッシュボードは削除されます
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	レンダリングする単一のダッシュボードの ID
-c 、 --chart=VALUE	レンダリングするダッシュボード上のグラフのタイトル
--last=VALUE	チャートをレンダリングする期間 (例: 7d )。これは間隔の境界に合わせて配置されます。 --lastまたは--startと--endいずれかを指定する必要があります
--by=VALUE	チャート データのタイムスライス間隔 (期間として)、例: 1h
--start=VALUE	クエリ元の ISO 8601 日付/時刻
--end=VALUE	クエリ対象の ISO 8601 日付/時刻
--signal=VALUE	適用する信号式または交差する信号 ID のリスト ( signal-1,signal-2など)
--timeout=VALUE	実行タイムアウト (ミリ秒)
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。デフォルトでは、 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	リストする単一の式インデックスの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキスト)
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
-a 、 --apikey=VALUE	サーバーに接続するときに使用する API キー。デフォルトでは、 connection.apiKey構成値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

expressionindex remove

サーバーから式インデックスを削除します。

例：

 seqcli expressionindex -i expressionindex-2529

オプション	説明
-i 、 --id=VALUE	削除する式インデックスの ID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	フィードの場所。これは、NuGet v2 または v3 フィード URL、または Seq サーバー上のローカル ファイルシステム パスである可能性があります。
-u 、 --username=VALUE	認証が必要な場合、フィードに接続するときに Seq が指定するユーザー名
-p 、 --password=VALUE	認証が必要な場合はフィードのパスワード。 --password-stdin方が安全であることに注意してください
--password-stdin	STDINからフィードパスワードを読み取ります
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	リストする単一フィードの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキストです)。
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	削除する単一フィードの ID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
-a 、 --apikey=VALUE	サーバーに接続するときに使用する API キー。デフォルトでは、 connection.apiKey構成値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

feed update

既存の NuGet フィードを更新します。

例：

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

オプション	説明
--json=VALUE	JSON 形式の更新された NuGet フィード。これは、 seqcli feed list --json使用して生成できます。
--json-stdin	更新された NuGet フィードをSTDINから JSON として読み取ります
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	リストする単一のインデックスの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキストです)。
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	抑制するインデックスの ID
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。デフォルトでは、 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	Seq サーバーの URL。デフォルトでは、 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] と答えます
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
-a 、 --apikey=VALUE	サーバーに接続するときに使用する API キー。デフォルトでは、 connection.apiKey構成値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

node health

Seq ノードの/healthエンドポイントを調査し、返された HTTP ステータス コードを出力するか、エンドポイントをクエリできなかった場合は「到達不能」を出力します。

例：

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

オプション	説明
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

node list

Seq クラスター内のノードをリストします。

例：

 seqcli node list --json

オプション	説明
-n 、 --name=VALUE	リストするクラスターノードの名前
-i 、 --id=VALUE	リストする単一のクラスター ノードの ID
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキストです)。
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 connection.serverUrl設定値が使用されます。
-a 、 --apikey=VALUE	サーバーに接続するときに使用する API キー。デフォルトでは、 connection.apiKey構成値が使用されます。
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlおよびconnection.apiKey構成値が使用されます。

print

ファイルまたはSTDINから CLEF/JSON 形式でイベントを整形印刷します。

例：

 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	SeqサーバーのURL
-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	適用する信号式または交差する信号 ID のリスト ( signal-1,signal-2など)
--timeout=VALUE	実行タイムアウト (ミリ秒)
--json	改行区切りの JSON で出力を印刷します (デフォルトはプレーンテキストです)。
--no-color	テキスト出力を色付けしない
--force-color	リダイレクトされた出力に強制的に ANSI カラーを適用します ( --no-colorも指定されていない場合)
-s 、 --server=VALUE	Seq サーバーの URL。デフォルトでは、 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	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）

retention list

保持ポリシーをリストします。

例：

 seqcli retention list

オプション	説明
-i 、 --id=VALUE	リストする単一の保持ポリシーのID
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	削除する単一の保持ポリシーのID
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	STDINのJSONとして更新された保持ポリシーをお読みください
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます

sample ingest

サンプルイベントを配列インスタンスにログに記録します。

例：

 seqcli sample ingest

オプション	説明
-y 、 --confirm	継続するように促されたときに[y] esに答えます
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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] esに答えます
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
--signal=VALUE	適用する交差した信号IDの信号式またはリスト、たとえばsignal-1,signal-2
--request-timeout=VALUE	イベントの各ページをミリ秒単位で取得できる時間。デフォルトは100000です
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます

setting clear

ランタイム構成のサーバー設定をクリアします。

オプション	説明
-n 、 --name=VALUE	設定名、たとえばOpenIdConnectClientSecret
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます

setting show

ランタイム構成のサーバー設定の現在の値を印刷します。

オプション	説明
-n 、 --name=VALUE	設定名、たとえばOpenIdConnectClientSecret
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）

signal import

Newline Delimited JSON形式で信号をインポートします。

例：

 seqcli signal import -i ./Exceptions.json

オプション	説明
--merge	インポートされたデータのIDと一致する信号を更新します。デフォルトは、常に新しい信号を作成することです
-i 、 --input=VALUE	インポートするファイル。指定されていない場合、 STDIN使用されます
-o 、 --owner=VALUE	の信号をインポートするユーザーのID;デフォルトでは、共有信号はImportDです
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	リストする単一の信号のID
-o 、 --owner=VALUE	の信号をリストするユーザーのID;デフォルトでは、共有信号はlistdです
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	削除する単一の信号のID
-o 、 --owner=VALUE	の信号を削除するユーザーのID;デフォルトでは、共有信号は削除されます
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	STDINのJSONとして更新された信号をお読みください
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます

tail

フィルターに一致するログイベントをストリーミングします。

オプション	説明
-f 、 --filter=VALUE	@Level = 'Error'など、ストリームに適用するオプションのサーバー側フィルター
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
--signal=VALUE	適用する交差した信号IDの信号式またはリスト、たとえばsignal-1,signal-2
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	信号、ダッシュボード、保存されたクエリ、ワークスペース、またはエクスポートの保持ポリシーのID。この引数は複数回指定される場合があります。デフォルトは、すべての共有エンティティをエクスポートすることです
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	ターゲットサーバー上の作成されたエンティティのIDにテンプレート名をマッピングするファイルのパスは、複数のインポートが実行されたときに複製を回避します。デフォルトでは、入力ディレクトリのimport.stateが使用されます
--merge	.stateファイルにエントリがないテンプレートの場合、最初に名前またはタイトルを備えた既存のエンティティをチェックします。保持ポリシーのマージをサポートしていません
-g 、 --arg=NAME=VALUE	テンプレート引数、Eg -g ownerId=user-314159
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	ユーザーのメールアドレス（ユーザーのグラバタル画像を有効にします）
-p 、 --password=VALUE	ユーザー名/パスワード認証が使用されている場合、ユーザーの初期パスワード。 --password-stdin方が安全です
--password-stdin	ユーザー名/パスワード認証が使用されている場合は、 STDINのユーザーの最初のパスワードを読む
--no-password-change	次のログインでユーザーにパスワードを変更するように強制しないでください
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）

user list

ユーザーをリストします。

例：

 seqcli user list

オプション	説明
-n 、 --name=VALUE	リストするユーザーのユーザー名
-i 、 --id=VALUE	リストする単一のユーザーのID
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	削除する単一のユーザーのID
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	STDINのJSONとして更新されたユーザーをお読みください
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	ワークスペースに含めるためのダッシュボード、信号、または保存されたクエリのID
--protected	ワークスペースが管理者のみが編集可能であることを指定します
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 connection.serverUrl構成値が使用されます
-a 、 --apikey=VALUE	サーバーに接続するときに使用するAPIキー。デフォルトでは、 connection.apiKey構成値が使用されます
--profile=VALUE	使用する接続プロファイル。デフォルトでは、 connection.serverUrlとconnection.apiKey構成値が使用されます
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）

workspace list

利用可能なワークスペースをリストします。

例：

 seqcli workspace list

オプション	説明
-t 、 --title=VALUE	リストするワークスペースのタイトル
-i 、 --id=VALUE	リストする単一のワークスペースのID
-o 、 --owner=VALUE	ワークスペースをリストするユーザーのID;デフォルトでは、共有ワークスペースはリストです
--json	newline-limimetted jsonの出力を印刷する（デフォルトはプレーンテキストです）
--no-color	テキスト出力を色付けしないでください
--force-color	ANSI色を持つようにリダイレクトされた出力を強制します（ --no-colorも指定されていない場合）
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	削除する単一のワークスペースのID
-o 、 --owner=VALUE	ワークスペースを削除するユーザーのID;デフォルトでは、共有ワークスペースは削除されます
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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	STDINのJSONとして更新されたワークスペースを読んでください
-s 、 --server=VALUE	SEQサーバーのURL。デフォルトでは、 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}の間のテキストは、抽出されるイベントの一部を識別するマッチ式であり、
• 文字通りの巻き毛のブレースは倍増することで脱出されるため、 {{ literal Text {および}}の一致}と一致します。

一致式にはフォームがあります。

 {name:matcher}

名前とマッチャーの両方がオプションですが、どちらか一方を指定する必要があります。したがって、 {@t:timestamp} @tおよびValue timestampの名前を指定し、 {IPAddress}名前のみを指定し、 {:n}のみを指定します（この場合、組み込みのNewline Matcher）。

名前は抽出されるプロパティ名です。特別な取り扱いを得る4つの組み込みプロパティ名があります。

• @t T-イベントのタイムスタンプ
• @mイベントに関連付けられたテキストメッセージ
• @lイベントのレベル
• @xイベントに関連する例外またはバックトレース

その他のプロパティ名はイベントペイロードに添付されるため、 {Elapsed:dec} 、 dec進数マッチャーを使用して、 Elapsedと呼ばれるプロパティを抽出します。

名前なしの式を一致させると、入力から消費されますが、イベントペイロードには追加されません。

マッチャー

マッチャーは、入力イベントのチャンクを識別します。

200OKのようなテキストを個別のプロパティ、つまり{StatusCode:nat}{Status:alpha}に分離できるように、異なるマッチャーが必要です。ここでは、 nat （自然数）マッチャーも結果を数値に強制しているため、テキスト"200"としてではなく、イベントに数値的に200として数値ペイロードに添付されます。

マッチャーには3種類あります。

• alphaやnatのようなマッチャーは、マッチャーという名前の組み込みです。
• 特別なマッチャー* 、 **およびそのままは、非溝のコンテンツマッチャーです。これらは、次のパターン要素が一致するまで（ * ）、次の2つの要素が一致するまで、任意のテキストと一致します。これは、例の{@m:*}{:n}要素を使用して動作していました。メッセージは、次のNewlineまでのすべてのテキストです。
• より複雑な化合物マッチャーは、サブ発現を使用して説明されています。これらには{Phone:={:nat}-{:nat}-{:nat}}のように、等しい記号=が付いています。これにより、 123-456-7890などのテキストがPhoneプロパティに抽出されます。

マッチャー	説明	例
* 、 ** 、...	非グリーディコンテンツ
alpha	1つ以上の文字	Abc
alphanum	1つ以上の文字または数字	a1b2
dec	10進数	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	1つ以上のスペースまたはタブ文字
serilogdt	デフォルトのSerilogファイルロギング形式のDateTime	2020-01-28 13:50:01.123 +10:00
syslogdt	Syslog形式のDateTime	Dec 8 09:12:13
t	単一のタブ文字
timestamp	認識された形式のデータタイム
token	非白色文字の任意のシーケンス	1+x$3
trailingident	インデントされたトレーリングラインを備えたマルチラインコンテンツ
unixdt	数秒（10桁）またはミリ秒（12桁）をサポートするUNIX時間形式のデータタイム	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 Webサーバーログを摂取します

この例は、ログファイルを形式で摂取します。

 # 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など、 STDINを介したエンティティの更新されたJSON表現を受信します。

これは、PowerShellなどのネイティブJSONサポートを備えたjqやModern Shellsなどのツールで特にうまく機能します。

(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...