Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

OutSystemsプラットフォームのロギングレベルの変更(OSTrace)

固定リンク: www.outsystems.com/goto/ostrace

概要

OutSystemsプラットフォームの問題をトラブルシューティングするため、OutSystemsサービスまたはランタイムアプリケーションのログレベルを上げるようにOutSystemsのサポートチームが依頼する場合があります。

ログレベルを上げることで、内部で発生している状況の詳細な情報を収集することができます。この情報は、サポートとやりとりする際や問題を独自に分析する際に役立つ場合があります。

この記事では、OutSystemsプラットフォームのログレベルを変更する方法と、この変更を実行するときに必要な注意事項について説明しています。

 

OutSystemsサービスのログレベルを上げる

.NETスタック

OutSystemsプラットフォームは、標準のロギングメカニズムを使用します。.NETスタックでは、System.Diagnosticsを使用します。System.Diagnosticsを構成して詳細度を上げるには、トレースするアプリケーションの.configファイルにトレースリスナーを追加します。

これらのファイルはC:\Program Files\OutSystems\Platform Server\にあります。

  • Deployment Controller Service: CompilerService.exe.config
  • Deployment Service: DeployService.exe.config
  • Log Service: LogServer.exe.config
  • Scheduler Service: Scheduler.exe.config
  • SMS Connector: SMSConnector.exe.config
  • Configuration Tool: ConfigurationTool.exe.config
    Configuration Toolのファイルがない場合は、この構成ファイルを例として使用できます。

</configSections>行の直後に以下のXMLを追加します。

<system.diagnostics> <switches> <add name="LogLevel" value="4" /> </switches> <trace autoflush="true"> <listeners> <add name="MyListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="PATH-TO-LOG" /> </listeners> </trace> </system.diagnostics>

 

ログを書き込むファイルを指定する必要があります(<PATH-TO-LOG>)。C:\Program Files\OutSystems\Platform Server\logs\<NameOfService>.logに書き込むことを推奨しています。
たとえば、CompilerService.exeはC:\Program Files\OutSystems\Platform Server\logs\CompilerService.logに書き込みます。

ログファイルを編集した後、変更した構成を使用するサービスを再起動する必要があります。

 

0(最も詳細度が低い)~4(最も詳細度が高い)のログレベルを指定できます。サポートチームにログを送信する場合は、必ずログレベル4(エラー+警告+情報+デバッグ)を使用してください。

 

Javaスタック

Javaスタックでは、log4jのログを利用します。特定のロガーのログレベルを上げることができます。分析するサービスに応じて、/etc/outsystems/にあるロガー構成ファイルを編集することができます。

  • Deployment Controller Service: os.controller.service.properties
  • Deployment Service: os.deployment.service.properties
  • Log Service: os.log.service.properties
  • Scheduler Service: os.scheduler.service.properties
  • Configuration Tool: configurationtool.properties

以下のXMLを追加します。

## config for outsystems packages log4j.logger.outsystems=TRACE

ログファイルを編集した後、変更した構成を使用するサービスを再起動する必要があります。

 

使用できるログレベルがいくつかあります。サポートチームにログを送信する場合は、必ずTRACEログレベルを使用してください。

ランタイムアプリケーションのログレベルを上げる

.NETスタック

アプリケーションが.NETで実行されている場合、手間のかかるIIS構成のほとんどを実行できるFactory ConfigurationというツールをOutSystemsが提供しています。Factory Configurationツールを使用してトレースを有効にするには、以下の手順を実行します。

  1. Forgeで提供されているFactory Configurationをダウンロードして、パブリッシュします。
  2. ブラウザでFactory Configurationアプリケーションを開き、Service Centerの資格情報を使用してログインします。
  3. Shared Configurations]タブを開き、[Create New Shared Configuration]をクリックします。
  4. Pre-made Samples]ドロップダウンで[OSTrace Logs]を選択し、[Fill]ボタンをクリックします。
  5. Value]テキストボックスにはXSLTコードが含まれ、ここでログが書き込まれるファイルを編集することができます(<listeners>タグ内のinitializeDataディレクトリ)。トレースログを使用するeSpaceが複数ある場合は、eSpaceごとに別の共有構成を作成し、出力ファイルを変更してください。
  6. 構成に名前を付け、[Save]をクリックします。

  7. eSpaces]タブに戻り、トレースするアプリケーションを選択します。
  8. 一番下にあるドロップダウンで先ほど作成した構成を選択し、[Associate]をクリックします。

    image00.png
  9. eSpaceを再パブリッシュします。

Javaスタック

OutSystemsでは、Javaスタックで実行されるアプリケーションのトレースを自動的に構成するツールが提供されていないため、手動でロギング設定を変更する必要があります。

以降のセクションでは、OutSystemsがサポートする3つのJavaアプリケーションサーバーでトレースを有効にする方法について説明しています。

JBoss/WildFly
  1. 以下のフォルダ内にあるファイルstandalone-outsystems.xmlを編集します。
    • JBoss: <JBoss Folder>/standalone/configuration/ (デフォルトのJBossフォルダは/usr/share/jbossasです)
    • WildFly: /opt/<WildFly folder>/standalone/configuration/
  1. ロギングサブシステムで以下を追加または編集します。

<logger category="outsystems"> <level name="TRACE"/> </logger>
  1. 対応するコマンドを使用してアプリケーションサーバーを再起動します。

service wildfly-outsystems restart

service jboss-outsystems restart

WebLogic
  1. WebLogicの管理コンソールにログインします。
  2. 左ペインで、[Environment]をクリックします。
  3. Servers]に移動し、アプリケーションサーバーを選択します。
  4. Advanced]オプションを展開します。
  5. 左ペインの一番上にある[Lock & Edit]をクリックし、[Platform Logger Levels]ボックスに以下を追加します。

outsystems=Trace

  1. Save]および[Activate Changes]をクリックします。
  2. 以下のコマンドを使用してアプリケーションサーバーを再起動します。

service weblogic-outsystems restart

ロルレベルを上げるときの注意

レベルを上げると、プラットフォームや関連するソフトウェアツールで追加のコードが実行され、追加のログ情報(大量になる可能性があります)がディスクに書き込まれます。そのため、以下のようになります。

  • ディスク使用量が増加します。ロルレベルを上げる場合、適切なディスク上の場所を選択し、十分な領域を確保してください。
  • ディスクへのI/Oが増加します。ほとんどの場合、この影響は最小限ですが、ベストプラクティスとして、別のディスクボリュームを使用することでパフォーマンスへの影響を最小限に抑えることを推奨します。

また、トラブルシューティングセッションが終わり次第、ログレベルを下げることを推奨します。ログレベルを常に高いままにしていると、アプリケーションのパフォーマンスとディスク領域の使用量に影響を及ぼす可能性があります。

 

適用対象

OutSystemsプラットフォーム、すべてのバージョン(最終確認は10.0.105.0)、オンプレミス。