Business Transaction Listener のインストールと設定

BT Listener (Business Transaction Listener)は、BT Diviner によって要求された該当データのみをフィルタしてルーティングします。BT Listener は、プラグインと BT Diviner の間に展開されます。BT Listener は、Windows および Linux でサポートされています。
BT Listener のプロパティ
Business_Transaction_Listener.zip
ファイルに含まれている
application.properties
ファイルには、以下のプロパティが含まれています。
プロパティ
説明
Configure ThreadPool for Reading the Input
以下のプロパティを使用して、非常に大きな負荷を処理するために、またはトラフィックが高い場合に BT Listener を拡張します。
このスケーリングをサポートするための十分なインフラストラクチャがあることを確認してください。
btListener.component.core.pool.size=8 btListener.component.maximum.pool.size=10 btListener.component.keep.alive.time.in.seconds=5
Configure ThreadPool to Post Data to Target System/DXC
以下のプロパティを使用して、キャプチャまたは検出されたデータをポストするように BT Listener を拡張します。
このスケーリングをサポートするための十分なインフラストラクチャがあることを確認してください。
btListener.output.channel.max.pool.size=8 btListener.output.channel.core.pool.size=10 btListener.output.channel.keep.alive.time.in.sec=5
Configure Netty Service Buffer Size
以下のオプションを使用して、Java ソケット インスタンスの基盤となるチャネルのバッファ サイズを指定します。
btListener.netty.receiveBufferSize.in.kb=1048576 btListener.netty.sendBufferSize.in.kb=1048576
Timeout and Cleanup Task
このプロパティを使用して、要求を無視するまで応答を待機する時間を設定します。プラグインは、別個のコンポーネントとして要求および応答を送信できます。これらの要求/応答コンポーネントは、遅延して BT Listener に到達する場合があります。
btListener.request.timeout.in.seconds=90
Request and Response Components are Cached Internally
このプロパティを使用して、クリーンアップ タスクのスケジュール間隔を設定します。要求または応答のいずれかがタイムアウト期間前にペアになっていない場合、それらは古いオブジェクトとしてキャッシュされます。スケジュールされたクリーンアップ タスクは、これらのオブジェクトをキャッシュから消去します。
btListener.cleanup.time.in.seconds=30
Host the Netty Server
以下のプロパティは、プラグインが通信する Netty サーバをホストします。
btListener.input.channel.hostname=localhost btListener.input.channel.port=8000
Netty Server Number of Worker Threads
このプロパティを使用して、ワーカ スレッド数を指定します。ワーカの数を増やして、大きな負荷に合わせて拡張できます。
btListener.input.channel.worker.threads.count=15
InputChannel Factory Property
以下のプロパティを使用して、BT Listener 入力通信チャネル タイプをソケットとして定義します。
btListener.input.channel.type=socket
Plugin Data Line Terminator
このプロパティを使用して、プラグインによって送信される行でデータ行でデータ ファイルを読み取る区切り文字を定義します。
btListener.input.channel.data.line.separator=\\r?\\n
Output Channel Properties
このプロパティは、Digital Experience Collector (DXC)のホスト名およびポート番号を定義し、BT Listener をダウンロードするときに設定および自動入力されます。
btListener.output.channel.url=<defined>
Listener Tenant ID
このプロパティは、出力通信チャネルのテナント ID を定義し、BT Listener をダウンロードするときに設定および自動入力されます。
btListener.output.channel.tenantId=<defined>
Proxy Configuration
出力接続がプロキシを経由する必要がある場合は、このプロパティを使用してプロキシ接続を設定します。true または false としてプロキシを使用します。
btListener.output.useproxy=false
Proxy Protocol Scheme
これらのプロパティを使用して、プロトコル スキームを定義します。
#btListener.output.proxy.protocol=http #btListener.output.proxy.host=localhost #btListener.output.proxy.port=3128
Proxy Client Authentication Details
これらのプロパティを使用して、プロキシ クライアントの認証の詳細を定義します。基本認証方式のみがサポートされています。
#btListener.output.proxy.user= #btListener.output.proxy.password=
SSL Validation Using Keystore
キーストアを使用して SSL 検証を行うには、以下のプロパティを使用します。
#https.client.ssl.keystore.path=# #https.client.ssl.keystore.password=#
Data is Not Sent Out for Every Component
このプロパティを使用して、送信データのサイズを定義します。データはコンポーネントごとに送信されません。データはローカルにキャッシュされ、以下の条件のいずれかが満たされたときに一括送信されます。
# max data size limit for filtered data btListener.output.channel.filtered.data.max.size.in.mb=5 # max data size limit for discovered data btListener.output.channel.discovered.data.max.size.in.mb=5 # max count of components for filtered data btListener.output.channel.filtered.events.max.size=1000 # max count of components for discovered data btListener.output.channel.discovered.events.max.size=1000 # max time to wait for before sending data btListener.output.channel.data.cleanup.time.in.seconds = 1
Enable Persist Data in BT Listener
ターゲット システム(DxC)がダウンしている場合、このプロパティを使用して BT Listener システム内の永続データを有効にし、ターゲット システムが稼働しているときと永続化されたデータをポストします。
btListener.persistData.enabled = false
Scheduler Checks if Any Data Available
DxC にポストできるデータがあるかどうかを確認するには、このプロパティを使用します。
btListener.persist.dataPosting.in.seconds = 30
Data Size to Store Recent Data
btListener.persistData.file.size.in.kb
の値は、
btListener.output.channel.discovered.data.max.size.in.kb
および
btListener.output.channel.filtered.data.max.size.in.kb
を超えている必要があります。値がこれより小さい場合、これはディスカバリ永続性に
btListener.output.channel.discovered.data.max.size.in.kb
を使用し、永続キャプチャに
btListener.output.channel.filtered.data.max.size.in.kb
を使用します。
btListener.persistData.file.size.in.kb = 1024
Scheduler to Get App Specific Rules from DXC
このプロパティを使用して、スケジューラがキャプチャ ルールを取得する間隔を設定します。
btListener.fetchCaptureRules.in.seconds = 60
Define a Connection Limit per One HTTP Route
httpclient.max.connections.route
プロパティは、接続プールの全体的な接続制限を定義します。このプロパティは、HTTP ルートごとの接続制限を定義します。たとえば、ルート(5)および合計(20)を使用するとします。これは、ターゲット ホストごとに最大 5 つの接続を同時に使用できることを示しています。たとえば、ca.com との 5 つの接続、google.com との別の 5 つの接続、というようになります。ただし、通信しているホストの数にかかわらず、開いている接続の合計数は 20 を超えることはできません。
httpclient.max.connections.route=5 httpclient.max.connections.total=20
Discovery Polling Interval Time
このプロパティは、ポーリング間隔を指定します。
btListener.discovery.polling.interval.time.in.seconds = 100
Payload Tokenizers to be Used for Different Content Types
このプロパティを使用して、さまざまなコンテンツ タイプに使用されるペイロード トークナイザを定義します。
btListner.payload.tokenizers=\ TEXT/XML=com.ca.apm.eum.tokenizer.XmlPayloadTokenizer,\ TEXT/HTML=com.ca.apm.eum.tokenizer.HtmlPayloadTokenizer,\ TEXT/PLAIN=com.ca.apm.eum.tokenizer.PlainTextPayloadTokenizer,\ APPLICATION/XML=com.ca.apm.eum.tokenizer.XmlPayloadTokenizer,\ APPLICATION/JSON=com.ca.apm.eum.tokenizer.JsonPayloadTokenizer,\ APPLICATION/X-WWW-FORM-URLENCODED=com.ca.apm.eum.tokenizer.FormUrlEncodedPayloadTokenizer,\ DEFAULT=com.ca.apm.eum.tokenizer.PlainTextPayloadTokenizer
HTML Tags to Ignore While Tokenizing HTML Payload
このプロパティを使用して、HTML ペイロードのトークン化中に無視する HTML タグを指定します。
htmltokenizer.html.tags.toIgnore=script,link,code
HTML Tags to Ignore While Tokenizing HTML Payload
このプロパティを使用して、HTML ペイロードのトークン化中に無視する HTML タグを指定します。
htmltokenizer.html.tags.toIgnore=script,link,code
HTML Attributes to be Considered While Tokenizing HTML Payload
このプロパティを使用して、HTML ペイロードのトークン化中に考慮に入れる HTML タグを指定します。
htmltokenizer.html.attributes.toInclude=alt,value,placeholder,content,title
HTML Tags in Mega Tags to be Considered While Tokenizing HTML Payload
このプロパティを使用して、HTML ペイロードのトークン化中に考慮に入れるメタ タグ内の HTML タグを指定します。
htmltokenizer.html.attributes.fromMeta.toInclude=name,http-equiv,charset,property
Delimiter to Use for Specifying an Array Type in Parameter Names
このプロパティを使用して、パラメータ名に配列タイプを指定するために使用する区切り文字を指定します。
jsontokenizer.json.arraydelimiter = @@
Delimiter to Use for Specifying an Object Type in Parameter Names
このプロパティを使用して、パラメータ名にオブジェクト タイプを指定するために使用する区切り文字を指定します。
jsontokenizer.json.objectdelimeter = @
Delimiter to Use for Specifying an Index Number in Parameter Names
このプロパティを使用して、パラメータ名にインデックス番号(同じ名前の複数のオブジェクトが存在する場合)を指定するために使用する区切り文字を指定します。
jsontokenizer.json.iddelimiter = #
BT Listener のダウンロード
以下の手順に従います。
  1. DX SaaS
    にログインします。
  2. DX Application Performance Management
    を開きます。
  3. 左側のナビゲーション ペインで、
    [設定]
    をクリックします。
  4. [統合]
    で、
    [Business Payload Analyzer
    ]をクリックします。
  5. [Business Payload Analyzer のルール管理]
    ページで、
    [ダウンロード]
    アイコンをクリックして、
    [Download Business Transaction Listener (Business Transaction Listener のダウンロード)]
    をクリックします。
  6. ダウンロードした
    Business_Transaction_Listener.zip
    ファイルをローカル フォルダに解凍します。
    btlistener-*
    ファイルには、以下のフォルダが含まれています。
    • bin:
      このフォルダにはスクリプトが含まれています。
    • config:
      このフォルダには、アプリケーション プロパティ ファイルが含まれています。
      btlistener-*\config
      フォルダには、以下のファイルが含まれています。
      • default\application.properties:
        このファイルにはデフォルト設定が含まれています。このファイルの内容は編集しないでください。
      • custom\application.properties:
        環境に合わせてこのファイルにカスタム プロパティを追加できます。更新されたカスタム プロパティにより、デフォルト設定がオーバーライドされます。
    • lib:
      このフォルダには jar ファイルが含まれています。
BT Listener のインストール
BT Listener のインストールについては、以下の点を考慮してください。
  • プラグインと同じサーバに BT Listener をインストールします。これは、同じサーバ上の複数のプラグイン間で共有できる別個のプロセスです。
  • BT Listener のホーム ディレクトリに存在する
    data
    フォルダの名前または内容を変更しないでください。
  • 監視対象アプリケーションから Business Payload Analyzer バックエンドにデータを送信するには、BT Listener が実行されている必要があります。
前提条件:
続行する前に、以下の前提条件を満たしていることを確認します。
  • Java がインストールされている。
  • JAVA_HOME 環境変数が設定されている。
Windows での BT Listener のインストール
BT Listener は、root ユーザまたは sudo (root 以外の)ユーザとしてインストールできます。BT Listener は、以下のいずれかの方法でインストールできます。
デフォルト プロパティを使用した Windows での BT Listener のインストール
以下の手順に従います。
  1. btlistener-*\bin
    フォルダに移動します。
  2. 管理者として
    BTListener.bat
    ファイルを実行します。
カスタマイズされたプロパティを使用した Windows での BT Listener のインストール
以下の手順に従います。
  1. btlistener-*\config\default
    フォルダに移動します。
  2. カスタマイズするすべてのプロパティ(以下のプロパティを含む)を、
    application.properties
    ファイルからコピーします。
    テナントおよび APM Experience Collector 情報と一致するように、以下の値を設定します。この情報は、まだ提供されていない場合は、ブラウザ エージェントの設定から表示できます。
    Output Channel Properties
    Digital Experience Collector または Kafka のホスト名およびポート番号を定義します。
    btListener.output.channel.url=http://<hostname>:<port>
    Listener Tenant ID
    出力通信チャネルのテナント ID を定義します。
    btListener.output.channel.tenantId=0
  3. コピーしたプロパティを
    btlistener-*\config\custom\application.properties
    ファイルに貼り付けます。
  4. ファイルを保存して閉じます。
  5. btlistener-*\bin
    フォルダに移動します。
  6. 管理者として
    BTListener.bat
    ファイルを実行します。必要に応じて、システムの再起動時に
    BTListener.bat
    が起動するように設定します。このオプションの設定方法の詳細については、オペレーティング システムのマニュアルを参照してください。
Linux での BT Listener のインストール
BT Listener は、root ユーザまたは sudo (root 以外の)ユーザとしてインストールできます。BT Listener は、以下のいずれかの方法でインストールできます。
デフォルト プロパティを使用した Linux での BT Listener のインストール
以下の手順に従います。
  1. btlistener-*\bin
    フォルダに移動します。
  2. 管理者として
    BTListener.bat
    ファイルを実行します。
カスタマイズされたプロパティを使用した Linux での BT Listener のインストール
以下の手順に従います。
  1. btlistener-*\config\default
    フォルダに移動します。
  2. カスタマイズするすべてのプロパティ(以下のプロパティを含む)を、
    application.properties
    ファイルからコピーします。
    テナントおよび APM Experience Collector 情報と一致するように、以下の値を設定します。この情報は、まだ提供されていない場合は、ブラウザ エージェントの設定から表示できます。
    Output Channel Properties
    Digital Experience Collector または Kafka のホスト名およびポート番号を定義します。
    btListener.output.channel.url=http://<hostname>:<port>
    Listener Tenant ID
    出力通信チャネルのテナント ID を定義します。
    btListener.output.channel.tenantId=0
  3. コピーしたプロパティを
    btlistener-*\config\custom\application.properties
    ファイルに貼り付けます。
  4. ファイルを保存して閉じます。
  5. btlistener-*\bin
    フォルダに移動します。
  6. 管理者として
    BTListener.sh
    ファイルを実行します。必要に応じて、システムの再起動時に
    BTListener.sh
    が起動するように設定します。このオプションの設定方法の詳細については、オペレーティング システムのマニュアルを参照してください。