TeamCity サーバーログ
TeamCity サーバーは、サーバーの動作に関する課題を調査したり、内部エラーの詳細を取得したりするために確認できる内部アクティビティのログを保持します。
ログは、TeamCity サーバーマシン上のディスクディレクトリにプレーンテキストファイルとして保存されます (通常は <TeamCity サーバーホーム>/ログ )。 TeamCity の実行中は、ファイルにメッセージが追加されます。
サーバーの実行中、ログは 管理 | 診断 セクションの サーバーログ タブの Web UI で表示できます。
一般的なログ記録の説明
TeamCity はロギングに log4j 2.x ライブラリを使用しており、その設定は カスタマイズできます。 TeamCity 2022.04 より前のバージョンでは、ロギングに Log4j 1.x を使用していました。
デフォルトでは、ログファイルは <TeamCity サーバーホーム>/ログ ディレクトリにあります。
最も重要なログファイルは次のとおりです。
| 一般的なサーバーログ |
| サーバーの起動時に このログは log4j2 構成には含まれておらず、サーバーの起動に関する問題のトラブルシューティングを支援することを目的としています。 |
| ユーザー開始イベントおよび主要なビルド関連イベントのログ |
| VCS-related アクティビティのログ |
| clean-up-related ログが含まれています |
| コミットステータスパブリッシャー-related ログが含まれます。 |
| 通知-related ログ |
| プルリクエスト - 関連ログ。 |
| AI Assistant に関連する情報をログに記録します。 デフォルトでは、すべての プリセットは AI 関連イベントを |
| （デフォルトではオフ） クラウド統合-related ログ |
| (デフォルトではオフ) SQL クエリのログ、 詳細を参照 |
| （デフォルトではオフ） NTLM およびその他の HTML 要求の認証に関連するメッセージをログに記録します |
| （デフォルトではオフ）サーバーが XML-RPC 経由でエージェントおよび IDE プラグインに送信したメッセージのログ |
| （デフォルトではオフ）VCS からの個々のファイルコンテンツリクエストに関連するログ |
| （デフォルトではオフ） REST-API 関連のロギング |
| （デフォルトではオフ） 通知テンプレート処理関連のログ |
| (デフォルトではオフ) エージェントのプッシュ操作に関連するログ |
| (デフォルトではオフ) サーバー上での 個人ビルド処理に関連するログ |
| （デフォルトではオフ） SVN 統合ログ |
| （デフォルトではオフ） TFS 統合ログ |
| （デフォルトではオフ） StarTeam 統合ログ |
| （デフォルトではオフ） ClearCase 統合プラグイン(英語)ログ |
| LDAP - 関連ログ |
| NuGet 関連ログ |
| (デフォルトではオフ) maintainDB ツールで実行されたバックアップ / 復元 / 移行のログ |
| (デフォルトではオフ) メンテナンス DB ツールで実行されたバックアップ / 復元 / 移行中に発生する可能性のあるデータの切り捨てに関する拡張情報が含まれています。 |
| (デフォルトではオフ) プロジェクト設定とバージョン管理の同期に関する情報が含まれます |
| ブラウザーと TeamCity サーバーの間で WebSocket 接続を使用する通信に関連するログ |
| TeamCity と構成済みの 課題トラッカー 間の通信に関連するログ |
ログ構成を変更すると、他のファイルも作成されます。
一部のファイルには .N 拡張機能が付く場合があります - これは、メインファイルのローテーション時に以前のロギングメッセージがコピーされたファイルです。 より多くのファイルを保持するには、 <デフォルトロールオーバー戦略/> を参照してください。
ロギング関連の診断 UI
システム管理者ロールを持つユーザーは、 管理 | 診断 | サーバーログ を使用して TeamCity UI からサーバーログを直接表示およびダウンロードできます。
ロギング構成の変更
TeamCity の実行中は、使用可能な ロギングプリセット から選択することで、アクティブなロギング設定を変更できます。
アクティブなロギングプリセットは、 管理 | 診断 | トラブルシューティング | デバッグログ セクションで変更されます。 プリセットを選択すると、ログ構成がすぐに変更され、サーバーの再起動後、このページで再度手動で変更するまで、プリセットは保持されます。 必要なログが収集されたら、デフォルトのプリセットに戻すことを強くお勧めします。
使用可能なプリセットは、 <TeamCity データディレクトリ>/config/_logging ディレクトリの .xml 拡張子のファイルに保存されます。 新しいファイルをディレクトリに追加したり、既存のファイルを変更したりできます (配布版 コンベンションを使用)。 新しいプリセットは、 診断 | ログプリセット 経由でアップロードすることもできます。
ログプリセットを使用してデバッグログモードを有効にできない場合 (たとえば、サーバーの初期化中にログを取得する場合)、ログに永続的な変更を加えることができない場合は、サーバーの起動前に conf/teamcity-サーバー-log4j.xml ファイルをバックアップし、 <TeamCity データディレクトリ>/config/_logging/debug-general.xml ファイルを conf/teamcity-サーバー-log4j.xml にコピーして名前を変更することができます。
ロギング設定の変更
log4j 構成を微調整したい場合は、 <TeamCity サーバーホーム>/conf/teamcity-server-log4j.xml ファイルを編集できます。 サーバーが実行中の場合、log4j 構成ファイルが自動的に再ロードされ、ログ構成がオンザフライで変更されます (一部の log4j 制限は引き続き適用されるため、大幅な変更を行う場合はサーバーの再起動を検討してください)。
デバッグ-すべて.xml や デバッグ-vcs.xml などの他のプリセットファイルの設定を変更しても、設定は自動的に取得されません。 変更を強制するには、ログプリセットを <デフォルト> などの他の値に切り替えてから、 debug-all に戻します。
log4j 構成の最も有用な設定:
ファイルに保存する最小ログレベルを変更するには、 ロガー 要素の レベル 属性を微調整します。
ログはデフォルトでローテーションされます。 デバッグが有効になっている場合、 <デフォルトロールオーバー戦略/> 要素の 最大 属性を増やして、保存されるログファイルの数に影響を与えることは理にかなっています。 その間、十分な空きディスク容量があることを確認してください。
<デフォルトロールオーバー戦略/> およびその他のサポートされる属性の詳細については、Apache のドキュメントの RollingFileAppender(英語) を参照してください。
ログの読み取り
各メッセージにはタイムスタンプとレベル（エラー、 警告、 情報、 DEBUG ）があります。
例:
エラーは、操作が失敗し、一部のデータが失われたか、アクションが実行されなかったことを意味します。 一般的に、ログにはエラーはありません。警告は通常、操作が失敗したが、再試行されるか、操作が重要ではないと見なされることを意味します。 ある程度の警告は問題ありません。 ただし、このような警告のログを確認して、何が問題で何が問題なのかをより理解することができます。情報は、現在のアクティビティを報告するだけの情報メッセージです。DEBUGは、たとえば TeamCity 開発者が分析する課題調査にのみ役立ちます。
一般的なロギング構成
デフォルトでは、TeamCity は .../conf/teamcity-サーバー-log4j.xml ファイルで log4j 構成を検索します (これは <TeamCity サーバーホーム>/conf/teamcity-server-log4j.xml に解決され、TeamCity .exe および .tar.gz ディストリビューションを bin から実行した場合に適用されます)。 そのようなファイルが存在しない場合は、デフォルトの log4j 構成が使用されます。 ログは、デフォルトでは ../ログ ディレクトリに保存されます。
必要に応じて、 log4j2.設定ファイル JVM オプションまたは 内部プロパティ を追加することで、構成へのパスを変更できます。 logs ディレクトリへのパスは、 TEAMCITY_ログ_パス 環境変数で構成するか、代わりに teamcity_ログ JVM オプションまたは 内部プロパティ で構成します。
例: log4j2.設定ファイル=ファイル:../conf/teamcity-サーバー-log4j.xml と teamcity_ログ=../ログ/。
デフォルト値は、 bin/teamcity-サーバー スクリプトで確認できます。このスクリプトは .exe および TAR.GZ ディストリビューションで利用できます。
バンドルされている teamcity-server または runAll スクリプト以外の方法で TeamCity を起動する場合は、上記のオプションをサーバー JVM に渡すようにしてください。 バンドルされていないウェブサーバーに TeamCity をインストールする際の 推奨事項 も参照してください。
デフォルトの teamcity-サーバー-log4j.xml ファイルの内容は、 .exe および TAR.GZ ディストリビューションにあります。 デバッグが有効になっているものは、サーバーの最初の起動後に <TeamCity データディレクトリ>/config/_logging/debug-general.xml の名前で見つかります。