Voice Gateway のロギングおよびトレースの構成
ロギングおよびトレースのレベルは、Voice Gateway の他の構成と同様に、Docker 環境変数として構成します (Voice Gateway の構成環境変数の説明を参照)。 ログに書き込まれるメッセージについて詳しくは、Voice Gateway のシステム・メッセージを参照してください。
デフォルトのログおよびトレース構成の変更
デフォルトのログおよびトレース構成は、個々のコンテナーの環境変数を設定して変更できます。
ロギングの環境変数
以下の Docker 環境変数を使用して、ログ設定を構成します。
| 環境変数 | デフォルト | 説明 |
|---|---|---|
| LOG_LEVEL | info (バージョン 1.0.2 以降) audit (バージョン 1.0.2 より前) |
SIP Orchestrator のログ・レベルです。 1.0.2 以降の有効な値は、最小限の情報から最大限の情報の順に、off、severe、warning、info、fine、finest、および all です。 1.0.2 より前の有効なオプションは、off、severe、warning、audit、fine、finest、および
all です。 fine、finest、または all に設定すると、ログに機密の PHI、PII、および PCI DSS のデータが含まれる可能性があります。 |
| LOG_MAX_FILES | 5 |
SIP Orchestrator のログ・ファイル、トレース・ファイル、および例外サマリー・ログ・ファイルの最大数。 この制限に到達すると、最も古いファイルが削除され、新しいファイルが作成されます。 例えば、この変数を 5 に設定すると、SIP Orchestrator は最大で 5 つのメッセージ・ログ、5 つのトレース・ログ、および 5 つの例外サマリーを生成します。 |
| LOG_MAX_FILE_SIZE | 100 |
SIP Orchestrator のログ・ファイルの最大サイズ (メガバイト (MB))。このサイズに到達すると、新しいファイルが作成されます。 |
| 環境変数 | デフォルト | 説明 |
|---|---|---|
| MEDIA_RELAY_LOG_LEVEL | INFO |
Media Relay のログ・レベルです。 有効な値は、最小限の情報から最大限の情報の順に、INFO、DEBUG、または TRACE です。 なお、DEBUG または TRACE に設定されている場合、機密の PHI、PII、および PCI DSS のデータがログに含まれる可能性があります。 |
| MEDIA_RELAY_LOG_ROTATION_FILE_COUNT | 10 |
Bunyan ロギング・モジュール用にローテーションで保持する Media Relay ログ・ファイルの数。 |
| MEDIA_RELAY_LOG_ROTATION_PERIOD | 1d |
Bunyan ロギング・モジュールがログ・ファイルのローテーションを行う期間。 デフォルトでは、ログ・ファイルは、24 時間ごとにローテーションされます。 |
| 環境変数 | デフォルト | 説明 |
|---|---|---|
LOG_LEVEL |
debug |
Speech to Text Adapter のログ・レベルです。 ログ・レベルを info、 debug、または trace に設定します。 なお、debug または trace に設定されている場合、機密の PHI、PII、および PCI DSS のデータがログに含まれる可能性があります。 |
トレースの環境変数
SIP Orchestrator 用の以下の Docker 環境変数を使用して、トレースの各種側面を制御します。
| 環境変数 | デフォルト | 説明 |
|---|---|---|
| ENABLE_AUDIT_MESSAGES | true |
監査メッセージを無効にする場合は、false に設定します。 |
| ENABLE_TRANSCRIPTION_AUDIT_MESSAGES | false |
監査書き起こしメッセージを有効にする場合は、true に設定します。 なお、このメッセージが有効になっている場合、該当するメッセージがログに出力されますが、機密の PHI、PII、および PCI DSS のデータが含まれる可能性があります。 |
| LATENCY_REPORTING_THRESHOLD | 1000 |
往復の Conversation の待ち時間を報告するしきい値 (ミリ秒)。 |
| RELAY_LATENCY_REPORTING_THRESHOLD | 1000 |
Media Relay の待ち時間を報告するしきい値 (ミリ秒)。 |
| WLP_LOGGING_MESSAGE_FORMAT | basic |
有効な値は、basic、json です。 バージョン 1.0.2 で追加されました。 |
| WLP_LOGGING_MESSAGE_SOURCE | message |
messages.log ファイルにルーティングするソースのコンマ区切りリスト。 有効な値は、message、trace、accessLog、ffdc、および audit です。 このプロパティーは、WLP_LOGGING_MESSAGE_FORMAT が json に設定されている場合にのみ適用されます。 バージョン
1.0.2 で追加されました。 |
| WLP_LOGGING_CONSOLE_FORMAT | basic |
有効な値は、basic、json です。 バージョン 1.0.2 で追加されました。 |
| WLP_LOGGING_CONSOLE_SOURCE | message |
コンソールにルーティングするソースのコンマ区切りリスト。 有効な値は、message、trace、accessLog、ffdc、および audit です。 このプロパティーは、WLP_LOGGING_CONSOLE_FORMAT が json に設定されている場合にのみ適用されます。 バージョン 1.0.2 で追加されました。 |
JSON ロギングが有効な場合、テナント ID とセッション ID は、名前と値のペアの形式でログ・レコードとトレース・レコードに追加されます。 SIP Orchestrator で JSON ロギングを有効にする方法については、表 4 を参照してください。 これらの名前と値のペアは、以下の場所に表示されます。
messages.logファイル (そのログが JSON フォーマットを使用するよう構成されている場合)- コンソールの出力 (そのコンソールが JSON フォーマットを使用するよう構成されている場合)
logstashCollectorによりLogstashに送信されたレコード
{
"type": "liberty_message",
"host": "e0b68506590f",
"ibm_userDir": "/opt/ibm/wlp/usr/",
"ibm_serverName": "defaultServer",
"message": "CWSGW0003I: The call to the Voice Gateway disconnected for the following reason = BYE received sessionID = EwhF6GX99x Length of call = 4,909 ms tenantID = watson-conversation",
"ibm_threadId": "00000083",
"ibm_datetime": "2019-05-30T17:53:19.759+0000",
"ibm_messageId": "CWSGW0003I",
"module": "com.ibm.ws.cgw.session.FullDuplexSession",
"loglevel": "INFO",
"ibm_sequence": "1559238799759_0000000000066",
"ext_SIPCallId": "EwhF6GX99x",
"ext_SIPSessionId": "wlp_2_0",
"ext_SIPASId": "wlp_2",
"ext_thread": "Default Executor-thread-60",
"ext_tenantID": "watson-conversation",
"ext_sessionID": "EwhF6GX99x"
}
ログ・ファイル言語の設定
ログ・メッセージを英語以外の言語で生成する場合は、個々のコンテナーのロケールを変更して、別の言語を選択できます。 ロケールを変更するには、以下の環境変数を両方とも設定します。
| 環境変数 | デフォルト |
|---|---|
| LC_ALL | en_US.UTF-8 |
| LANG | en_US.UTF-8 |
ロケールおよび上記環境変数について詳しくは、Ubuntu wiki の『Locale』を参照してください。
例えば、以下の変数の場合、ログ・ファイル言語はスペイン語に設定されます。
LC_ALL=es_ES.UTF-8
LANG=es_ES.UTF-8
サポートされる以下の言語から選択できます。
| 言語 | 文字セット値 |
|---|---|
| ブラジル・ポルトガル語 | pt_BR.UTF-8 |
| フランス語 | fr_FR.UTF-8 |
| ドイツ語 | de_DE.UTF-8 |
| イタリア語 | it_IT.UTF-8 |
| 日本語 | ja_JP.UTF-8 |
| スペイン語 | es_ES.UTF-8 |
| 中国語 (簡体字) | zh_CN.UTF-8 |
| 中国語 (繁体字) | zh_TW.UTF-8 |
ログ・ファイルのタイム・ゾーンの設定
各コンテナーのタイム・ゾーンを構成して、ログ・ファイル内のメッセージのタイム・ゾーンを変更できます。 タイム・ゾーンを構成するには、各コンテナーの TZ 環境変数を、International Assigned Numbers Authority (IANA) タイム・ゾーン・データベースの対応ゾーン名に設定します。
例えば、以下の構成はタイム・ゾーンを America/New_York に設定します。
TZ=America/New_York
IANA タイムゾーンについて詳しくは、Time Zone Database を参照してください。
ログ・ファイル表示許可の構成
Voice Gateway デプロイメント時に作成されるサーバー・ログは、other ユーザーに対し許可を与えません (-rw-r---)。 ロギングおよびトレースの構成を参照してください。
other ユーザーの読み取り権限を設定するサーバー・ログ・ファイルを作成する必要がある場合、デプロイメント構成ファイル内の WLP_SKIP_UMASK プロパティーを true に設定できます。 この構成により、更新された表示許可 -rw-r-r- を持つログ・ファイルを作成できます。
| 環境変数 | デフォルト |
|---|---|
| WLP_SKIP_UMASK | false |