トラブルシューティング Direct Access gateway
このセクションでは、Direct Access gateway のトラブルシューティングで実行できるさまざまなアクションについて説明します。
ログ ファイルの表示とダウンロード
ログ ファイルは、Direct Access gateway 操作の情報を提供します。Qlik サポートは、トラブルシューティングの目的でログ ファイルの提供を依頼する場合があります。ログ ビューアでログ ファイルを表示したり、ダウンロードしたりできます。通常の状況下では、ログ ファイルを確認する必要はありませんが、失敗が繰り返されたり、その他の問題が発生したりした場合に、ログ ファイルは原因を特定する助けになります
ログ ビューアを開くには、
-
Administration アクティビティ センターで、 [データ ゲートウェイ] に移動し、Direct Access gateway を検索します。
-
行の最後で
をクリックし、[ログを表示] を選択します。
[ログ ビューア] ウィンドウが開きます。
-
左上のドロップダウン リストから、Qlik サポートが表示またはダウンロードするように依頼したログのタイプを選択します。
次のログを使用できます。
- Direct Access gateway のログ (DirectAccessAgent)
- DCaaS のログ (dcaas_logs)
- ODBC ベースのコネクタのログ (odbc-connector_logs)
- SAP BW コネクタのログ (QvSAPBwConnector-<date + timestamp>)
- SAP ODP コネクタのログ (QvSapConnectorPackage-<process_id>)
- SAP SQL コネクタのログ (QvSqlBwConnector-<date + timestamp>)
- コネクタ エージェントのログ (connector-agent_logs_<date>)
-
隣接するドロップダウン リストから、表示またはダウンロードするログを選択します。ログ ファイルは、最新のファイル (現在アクティブのログ ファイル) から降順に並べ替えられます。ログ ファイルを選択した後、
と
ボタンを使用してログ ファイルの最初または終わりに移動します。
ヒント メモログ ファイルのビューは、最新のメッセージで自動的に更新されません。ビューを更新するには、をクリックして、最新のメッセージで更新されたログ ファイルの最後まで移動します。
-
ログ ファイルをダウンロードするには、[ダウンロード] をクリックします。
ブラウザの設定により、ファイルがコンピュータにダウンロードされるか、保存するように促すメッセージが表示されます。
Direct Access gateway マシンで Direct Access gateway ログを開く
Direct Access gateway (DirectAccessAgent) のログは Administration アクティビティ センター からダウンロードできるだけでなく、Direct Access gateway マシンから直接開くこともできます。既定のインストールでは、これらのログの場所は次の通りです。
C:\Program Files\Qlik\ConnectorAgent\data\logs
ログ レベルの変更
Direct Access gateway ログのログ レベルは、次のように変更できます。
コネクタ コンポーネントのログ レベルの変更
トラブルシューティングの目的で、コネクタ コンポーネント ログのログ レベルを変更する必要がある場合があります。
この操作は次の手順で行います。
- 管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [表示 ] > [非表示のアイテム] が選択されていることを確認してください。
-
<COMPONENT>_LOG_LEVEL プロパティを見つけます。COMPONENT は次のいずれかになります。
- AGENT
- DCAAS
- ODBC
- SAPBW
- SAPSQL
- SアプリACKAGE
- FILE
- ERROR、WARN、INFO、DEBUG のいずれかに設定します。
-
configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
情報メモDirect Access gateway 1.7.1 以降では、AGENT コンポーネントのみを変更した場合は、Qlik Data Gateway - 直接アクセス サービスを再起動する必要はありません。
DirectAccessAgent ログ レベルの変更
トラブルシューティングの目的で、DirectAccessAgent ログのログ レベルを変更する必要がある場合があります。DirectAccessAgent は、Qlik Cloud サービスへの接続を担当します。DirectAccessAgent ログのログ詳細レベルを表示および変更するには、ConnectorAgent サブフォルダー (既定のインストールの場合は C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent) から次のコマンドを実行します。
-
現在のログ レベルを表示するには、次を実行します。
connectoragent configuration getloggers -
ログ レベルを Trace に設定するには、次を実行します。
connectoragent configuration setloggers -l Root -v DEBUG -
ログ レベルを Verbose に設定するには、次を実行します。
connectoragent configuration setloggers -l Root –v DETAILED_DEBUG
登録キーの更新
まれですが、登録キーが破損した場合や、データゲートウェイサーバーが不正にアクセスされたと思われる場合は、登録キーの変更が必要な場合があります。
登録キーを更新するには:
- Direct Access ゲートウェイ サーバーで、コマンド プロンプトを開いて、ConnectorAgent サブフォルダーの作業ディレクトリ (デフォルト インストールでは C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent) を変更します。
-
次のコマンドを実行します。
-
新規キーを生成します。
connectoragent qcs generate_keys
-
キーを表示します。
connectoragent qcs get_registration
キーが表示されます。
-
-
上の例のように、キー全体をコピーします。
-
Administration アクティビティ センターで、関連する行の終わりにある [
] ボタンをクリックして、 [編集] を選択することにより、データ ゲートウェイ設定を開きます。
-
キーを [キー] フィールドに貼り付けて (現在のキーを置換する)、設定を保存します。
-
Direct Access ゲートウェイ サーバーに戻り、「Qlik Data Gateway - 直接アクセス サービスの管理」の説明に従って Qlik Data Gateway - 直接アクセス サービスを再起動します。
リロードセッションの寿命を延長する
Direct Access gateway と Qlik Cloud の間の接続が 20 秒以上アイドル状態である場合、リロード操作が次のエラーで失敗することがあります。
Invalid object name '#<TempTableName>' (indicating that the Direct Access gateway temp tables are unavailable).
デフォルトのセッション存続期間は 20 秒ですが、このエラーが頻繁に発生する場合は、次のようにセッション存続期間を延長できます。
-
管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [非表示のファイル、フォルダー、ドライブを表示する] が選択されていることを確認してください。
- ODBC_RELOAD_SESSION_LIFE パラメータを見つけて、必要に応じてその値を増やします。
- configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
ロード リクエストのタイムアウトを延長する
ネットワークの中断が発生すると、次のエラーでリロードが失敗する可能性があります。
Connector error: The session does not exist (DirectAccess-1509)
Connector error: The stream session expired for the load data request (DirectAccess-1012)
上記のエラーが頻繁に発生する場合は、EXTEND_FIRST_REQUEST_TIMEOUT パラメーターを 5 ~ 10 分に設定してみてください。
これを行うには、次の手順に従います。
-
管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [非表示のファイル、フォルダー、ドライブを表示する] が選択されていることを確認してください。
- EXTEND_FIRST_REQUEST_TIMEOUT パラメーターを見つけて、その値を 5 ~ 10 分に増やします。既定は「0」になっています。
- configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
リロード中のコネクタのクラッシュを軽減する
プロセス分離により、ゲートウェイ サーバー オペレーティング システムに直接アクセスできる管理者は、コネクタ タイプごとにリロードに使用できるプロセスの数を制御できます。リロードを複数のコネクタ プロセスに分散すると、各コネクタ プロセスで同時に実行されるリロードの数が減り、分離レベルが高まります。これにより、コネクタのクラッシュが発生した場合の Direct Access gateway 全体の安定性が向上します。
Direct Access gateway 1.6.1 以降が必要です。
プロセス分離をオフにする
Qlik サポートでは、トラブルシューティングの目的でプロセス分離をオフにするように依頼する場合があります。
プロセス分離をオフにするには:
- C:\ProgramData\Qlik\Gateway\configuration.properties ファイルを開きます。Windows エクスプローラーで実行する場合は、 [非表示のファイル、フォルダー、ドライブを表示する] が選択されていることを確認してください。
-
[[ODBC|SAPBW|SAPSQL|SAPPACKAGE]_PROCESS_ISOLATION_MODE] (すべての行の色分けの条件) を [None] (指定された行) に設定します。
- configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
プロセス分離を有効にするか、同時リロードの数を変更する
プロセス分離を有効にする、または同時リロードの数を変更するには:
-
管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [非表示のファイル、フォルダー、ドライブを表示する] が選択されていることを確認してください。
このファイルには、さまざまなコネクタ タイプに対応する、ODBC_<property-name>、SAPBW_<property-name>、SAPSQL_<property-name>、SAPPACKAGE_<property-name> のプレフィックスが含まれています。
-
[ODBC|SAPBW|SAPSQL|SAPPACKAGE]_PROCESS_ISOLATION_MODE を Load に、[ODBC|SAPBW|SAPSQL|SAPPACKAGE]_MAX_PROCESS_COUNT を N に設定します。
説明:
N = 1 つのコマンド プロセス + 割り当てる同時リロード プロセスの数。例として、10 という値は、最大 9 回の同時リロードを意味します。
- configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
ODBC コネクタのプロセス分離の例
次の configuration.properties ファイルの抜粋は、最大 12 回のリロードに対して ODBC コネクタのプロセス分離を有効にする方法を示しています。
ODBC_PROCESS_ISOLATION_MODE=Load
ODBC_MAX_PROCESS_COUNT=13
問題発生時のリロードのためのデータキャッシュ
各リロード操作について、Direct Access gateway はデータチャンクをメモリにキャッシュし、それらをディスクにオフロードできます (キャッシュに割り当てられたサイズを超えた場合)。これは、自動リカバリを使用せず、4025、4020、4021 エラーが頻繁に発生する場合に特に役立ちます。この機能を有効にするには、データ チャンクをディスクにオフロードするためのキャッシュ サイズのしきい値を設定します (リロードごと)。指定されたしきい値に達すると、ゲートウェイは次の暗号化されたチャンクを Direct Access gateway マシンのディスクにオフロードします。
キャッシュ サイズを設定するには:
-
管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [非表示のファイル、フォルダー、ドライブを表示する] が選択されていることを確認してください。
-
RELOAD_CACHE_MEMORY_MB を N に設定します (既定は 0 で、機能が有効になっていないことを意味します)。
説明:
N = データチャンクのキャッシュに割り当てられたメモリの量 (リロードごと)
情報メモこの機能を有効にすると、Direct Access gateway マシンのメモリ消費量が増加するため、有効になっている間はメモリへの影響を監視することをお勧めします。ほとんどの状況では、RELOAD_CACHE_MEMORY_MB 値を 100 に設定すれば十分です。 - configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
既定のチャンク キャッシュ ディレクトリをオーバーライドする
各リロード操作について、Direct Access gateway はデータチャンクをメモリにキャッシュし、それらをディスクにオフロードできます (キャッシュに割り当てられたサイズを超えた場合)。システム ドライブに十分なディスク容量がない場合は、既定のチャンク キャッシュ ディレク トリ (C:\ProgramData\Qlik\Gateway\tmp) ディレクトリをオーバーライドできます。
これを実行するには、次の手順に従います。
- テキストエディタを使用して、管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [表示 ] > [非表示のアイテム] が選択されていることを確認してください。
-
OVERRIDE_CHUNKS_CACHE_DIR プロパティを見つけて、任意のディレクトリに設定します。
例:
OVERRIDE_CHUNKS_CACHE_DIR=C:\tmp
情報メモパスを引用符で囲まないでください。 - configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
ODBC (Direct Access gateway 経由)コネクタを使用するときに、既定の Qlik Cloud データ型をオーバーライドする
ベンダーの ODBC ドライバーによるソース データ型の取り扱いの問題により、リロード中にエラーが発生したり、正しくないデータが Qlik Cloud にロードされたりする場合があります。このような場合、Qlik Cloud データ型またはその仕様 (スケールや精度など) をオーバーライドできます。
これを実行するには、次の手順に従います。
- テキストエディタを使用して、管理者として C:\ProgramData\Qlik\Gateway\custom_type_mapping.json を開きます。Windows エクスプローラーで実行する場合は、 [表示 ] > [非表示のアイテム] が選択されていることを確認してください。このファイルには、Qlik Cloud データ型のサンプル ソースが含まれています。
-
問題のあるデータ型を目的の Qlik Cloud データ型にマッピングするセクションを追加します。
次の例 (custom_type_mapping.json ファイルに含まれています) では、顧客は Qlik Cloud DateTime データ型のサイズを 27 に変更する必要があります。
{
"Identifier": "Amazon Athena ODBC (x64)",
"NativeDataType": "timestamp with time zone",
"QlikDataType": "DateTime",
"Size": 27,
"IsBit": false
}
- custom_type_mapping.json ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
- データをリロードします。
Direct Access gateway を Qlik Cloud に再接続させる
既定では、Direct Access gateway が Qlik Cloud から切断された場合、45 秒後に再接続されます。再接続に時間がかかるようであれば、ゲートウェイを強制的に再接続させることができます。
これを実行するには、次の手順に従います。
- テキストエディタを使用して、管理者として C:\ProgramData\Qlik\Gateway\configuration.properties を開きます。Windows エクスプローラーで実行する場合は、 [表示 ] > [非表示のアイテム] が選択されていることを確認してください。このファイルには、Qlik Cloud データ型のサンプル ソースが含まれています。
-
ファイルの先頭の # Connector Agent セクションに AGENT_PONG_TIMEOUT_SECONDS=<time-in-seconds> を追加します。
例:
AGENT_PONG_TIMEOUT_SECONDS=30
情報メモ最短時間は 30 秒です。 - configuration.properties ファイルを保存し、Qlik Data Gateway - 直接アクセス サービスを再起動します。
ODBC データ ソースへの接続時にエラー メッセージの詳細を増やす
セキュリティ上の懸念から、ODBC ドライバーによって返される既定のエラー メッセージには最小限の情報しか含まれていません。ただし、特定のシナリオでは、特定の問題をトラブルシューティングするために、さらなる情報が必要になる場合があります。より詳細なエラー メッセージを取得するには、コネクタ ダイアログの [詳細] セクションに ShowErrorDetailMessage プロパティを追加し、True に設定します。問題が解決したら、セキュリティを最適化するために、プロパティを削除するか、False に設定することを強くお勧めします。