seq forwarder

シーケンスフォワーダー

Seq Forwarder はクライアント側のログ コレクターであり、ローカル HTTP API 経由でイベントを受信し、リモート Seq サーバーに到達するまでイベントを独自の内部ストレージに保存します。

Seq Forwarder はデフォルトでポート15341をリッスンします。 HTTP インジェスト API は Seq のものと同一であるため、 Serilog.Sinks.Seqなどの標準クライアント ライブラリはこれに直接書き込むことができます。

 Log.Logger = new LoggerConfiguration() .WriteTo.Seq("http://localhost:15341").CreateLogger();Log.Information("Hello, Seq Forwarder!");

クライアント アプリケーションは、Seq Forwarder にログインするときに API キーを指定できます。この場合、クライアントによって提供された API キーはターゲット Seq サーバーに転送されます。

あるいは、Seq Forwarder は API キーを使用して設定でき、クライアント アプリケーションが API キーを指定しない場合、これを使用して Seq にログを記録します。

はじめる

まず、使用しているプラ​​ットフォームのリリース バンドルをダウンロードし、適切な場所に抽出します。

以下の手順ではseqfwdコマンドラインを使用します。利用可能なコマンドについては、 seqfwd helpを試してください。

Windows の場合

Seq Forwarder を Windows サービスとして設定するには、Seq Forwarder ディレクトリの管理 PowerShell プロンプトから、ターゲット Seq サーバー URL とオプションの API キーを設定します。

 ./seqfwd config -k Output.serverUrl --value="http://seq.example.com/"./seqfwd config -k Output.apiKey --value="1a2b3c4d5e6f"./seqfwd config -k storage.bufferSizeBytes -v 1073741824./seqfwd インストール
./seqfwd 開始

デフォルトのバッファ サイズ制限は 64 MB です。この例では、これは 1 GB に増加します。

アップグレードするには、サービスを停止し、フォワーダー リリース バンドルを上書きして、サービスを再起動します。

Windows では、Seq Forwarder はマシン スコープの DPAPI を使用して、デフォルトの API キーとクライアントから提供された API キーを暗号化します。

macOS または Linux の場合

Linux では、 liblmdb必要になります。

apt install liblmdb-dev

Seq Forwarder を実行するには、ターゲット Seq サーバー URL と、必要に応じて API キーを設定します。

 ./seqfwd config -k Output.serverUrl --value="http://seq.example.com/"./seqfwd config -k Output.apiKey --value="1a2b3c4d5e6f"./seqfwd config -k storage.bufferSizeBytes -v 1073741824
./seqfwd を実行

macOS および Linux では、出力 API キーとクライアントから提供された API キーはプレーン テキストで保存されることに注意してください。

デフォルトのバッファ サイズの上限は 64 MB です。この例では、これは 1 GB に増加します。

発達

Seq Forwarder は、Windows、macOS、Linux 上で .NET Core SDK を使用して構築できる .NET Core アプリケーションです。

デバッグするにはF5使用できますが、Windows では、 installコマンド (下記を参照) を実行して HTTP 名前空間の予約を作成するか、管理者として実行する必要があります。

トラブルシューティング

デフォルトでは、「フォワーダー」ログは%PROGRAMDATA%SeqLogsに保存されます。 宛先 Seq サーバーが利用できない場合、例外がこれらのログ ファイルに保存されます。

現在の構成を検査する必要がある場合は、 %PROGRAMDATA%SeqForwarderSeqForwarder.jsonで見つけることができます。

コマンドラインの使用法

> ./seqfwd help
Usage: seqfwd <command> [<args>]

Available commands are:
  bind-ssl   Bind an installed SSL certificate to an HTTPS port served by Seq 
             Forwarder
  config     View and set fields in the SeqForwarder.json file; run with no 
             arguments to list all fields
  dump       Print the complete log buffer contents as JSON
  help       Show information about available commands
  install    Install the Seq Forwarder as a Windows service
  restart    Restart the Windows service
  run        Run the server interactively
  start      Start the Windows service
  status     Show the status of the Seq Forwarder service
  stop       Stop the Windows service
  truncate   Clear the log buffer contents
  uninstall  Uninstall the Windows service
  version    Print the current executable version

Windows HTTP およびサービス関連のコマンド ( bind-ssl 、 install 、 restart 、 start 、 status 、 stop 、およびuninstall ) は、そのプラットフォームでのみ使用できることに注意してください。

SeqForwarder.json の構成例

seqfwd configコマンドは、 SeqForwarder.json の読み取りと書き込みを行います。

 { "診断": {"internalLogPath": "C:ProgramDataSeqLogs","internalLoggingLevel": "情報"
  }, "output": {"serverUrl": "http://localhost:5341","eventBodyLimitBytes": 262144,"rawPayloadLimitBytes": 10485760,"apiKey": null
  }, "ストレージ": {"バッファサイズバイト": 67108864
  }, "api": {"listenUri": "http://localhost:15341"
  }
}

Windows では、このファイルはC:ProgramDataSeqForwarderにあります。