アプリケーションでのAPMブラウザ・エージェントのデプロイ

すべてのアプリケーション・ページにJavaScriptを挿入してAPMブラウザ・エージェントをデプロイし、Application Performance Monitoringがリアル・ユーザー・エクスペリエンスに関するレポートを作成することを許可します。

ノート

JavaScriptを挿入する場所およびその方法の詳細は、モニター対象のアプリケーションに固有です。

APM Javaエージェント: APM Javaエージェントがデプロイされると、APMブラウザ・エージェント・スクリプトを自動的に注入するように構成することもできます。これには、パッケージ・アプリケーション固有のスクリプト(該当する場合)が含まれます。

JavaScriptを挿入するには:

  1. モニター対象のアプリケーション・ページのHTMLソースを編集します。
    ノート

    • パッケージ化されたWebアプリケーションの場合、通常、Webアプリケーションに属するすべてのページに使用されるページ・テンプレートがあります。

      パッケージ・アプリケーション固有のスクリプトも必ず含めてください(該当する場合)。詳細は、パッケージ・アプリケーションを含むAPMブラウザ・エージェントのデプロイを参照してください。

    • 構成は、window.apmrumまたはdocument.apmrumオブジェクトに格納できます。

      構成の混乱を避けるために、必ず同じオブジェクトを一貫して使用してください。遅延ロードはオブジェクトのプロパティに使用され、更新は動的に適用されます。

  2. 次のプロパティに値を指定し、終了タグ</head>の後にスクリプトを挿入します。別の<script>タグ内にはコードを追加しないようにします:
    • window.apmrum.serviceName: サービスの名前を指定します。サービス名を指定しない場合は、デフォルトのサービス名APM Browserが割り当てられます。サービスでフィルタし、対応するスパンをモニターできるように、サービス名を指定することをお薦めします。
    • window.apmrum.webApplication: Webアプリケーションの名前を指定します。この名前は、デプロイメントの機能領域を分類するために使用できます。webApplicationの値を指定しないと、デフォルト値「デフォルトWebApp」が使用されます。
    • window.apmrum.ociDataUploadEndpoint: RUMデータのアップロード先となるデータ・センターおよびドメインを決定するデータ・アップロード・エンドポイントを指定します。データ・アップロード・エンドポイントの値を取得するには、次を行います:
      • OCIコンソールに移動し、「監視および管理」「Application Performance Management」「管理」に移動して、目的のドメインを選択します。
      • 「データ・アップロード・エンドポイント」の横にある「コピー」をクリックして値をクリップボードにコピーし、これを使用してwindow.apmrum.ociDataUploadEndpointの値を設定します。
    • window.apmrum.OracleAPMPublicDataKey: APMドメインの作成時に生成されるパブリックdataKeyを指定します。パブリックdataKeyを取得するには、次を実行します:
      • OCIコンソールに移動し、「監視および管理」「Application Performance Management」「管理」に移動して、目的のコンパートメントとドメインを選択します。
      • 「リソース」で、「データ・キー」をクリックします。データ・キーが存在しない場合、「データ・キーの生成」をクリックし、「パブリック・データ・キー」を選択します。
      • タイプが「パブリック」のデータ・キーの横にある「コピー」をクリックして、window.apmrum.OracleAPMPublicDataKeyの値を移入するために使用する値を取得します。

    モニター対象アプリケーションのユーザーのパフォーマンスを最適化するには、JavaScriptライブラリの場所を指定し、ネットワークでJavaScriptライブラリにアクセスできることを確認する必要があります。

    JavaScriptの例

    スクリプトは次のようになります:

    <script>
    window.apmrum = (window.apmrum || {}); 
    window.apmrum.serviceName='<APM Browser>';
    window.apmrum.webApplication='<Web App Name>';
    window.apmrum.ociDataUploadEndpoint='<ociDataUploadEndpoint>';
    window.apmrum.OracleAPMPublicDataKey='<APM_Public_Datakey>';
    </script>
    <script async crossorigin="anonymous" src="<ociDataUploadEndpoint>/static/jslib/apmrum.min.js"></script>
    説明:
    • <APM Browser>は、APMブラウザ・エージェントに指定するサービス名の値です。値を設定しない場合、デフォルトのサービス名APM Browserが割り当てられます。
    • <Web App Name>はWebアプリケーション名です。
    • <ociDataUploadEndpoint>は、データ・アップロード・エンドポイントの値です。これは「APM管理」ページから取得できます。データ・アップロード・エンドポイントおよびデータ・キーの取得を参照してください。
    • <APM Public Datakey>は、APMメイン・ページの「管理」メニューから取得できるAPMパブリック・データキーの値です。

    たとえば、データ・アップロード・エンドポイントの値がaaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.comであり、APMパブリック・データキーの値がIMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZDの場合、スクリプトは次のようになります:

    <script>
    window.apmrum = (window.apmrum || {});
    window.apmrum.serviceName='Apm Browser1';
    window.apmrum.webApplication='Webapp';
    window.apmrum.ociDataUploadEndpoint='https://aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com';
    window.apmrum.OracleAPMPublicDataKey='IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD';
    </script>
    <script async crossorigin="anonymous" src="https://aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com/static/jslib/apmrum.min.js"></script>

    インストゥルメンテーションで<ociDataUploadEndpoint>/static/jslib/apmrum.min.jsへの参照を使用すると、APMモニタリングでAPMブラウザ・エージェントの使用可能な最新バージョンを常に利用できるようになります。

    完了したら、「APMブラウザ・エージェント・デプロイメントの確認」を参照してください

    ノート

パッケージ・アプリケーションを含むAPMブラウザ・エージェントのデプロイ

パッケージ・アプリケーションを監視する場合、そのパッケージ・アプリケーションの特性を取得するのに役立つ特定のスクリプトを使用できます。これを使用すると、パッケージ・アプリケーションの詳細を取得するための手動構成の必要性を削減できます。

サポートされている次のいずれかのパッケージ・アプリケーションを使用する場合は、特定のjavascriptコード・セットを使用できます。
  • Oracle E-Business Suite
  • PeopleSoft.
  • Siebel。
  • Oracle Business Intelligence Enterprise Edition (OBIEE)
  • Visual Builder Studio。

スクリプトは、特定のパッケージ・アプリケーションの特性を追跡し、url/DOMの特定の領域を認識して、それらを使用して、追加属性でスパンをエンリッチします。

パッケージ・アプリケーションを使用してブラウザ・エージェントをデプロイするには、次の手順を実行します。
  1. apmrum.min.jsライブラリをスクリプトに追加するステップを完了したことを確認します(アプリケーションを使用したAPMブラウザ・エージェントのデプロイを参照)。

  2. 特定のパッケージ・アプリケーション・ライブラリをスクリプトに追加します。
    <script crossorigin="anonymous" src="<ociDataUploadEndpoint>/static/jslib/<libraryName>"></script>

    説明:

    • <ociDataUploadEndpoint>は、データ・アップロード・エンドポイントの値です。詳細は、データ・アップロード・エンドポイントおよびデータ・キーの取得を参照してください。
    • <libraryName>は、特定のパッケージ・アプリケーションのライブラリ名です。詳細は、次の表を参照してください。
      パッケージ・アプリケーション <libraryName> 属性の例 システム・ルール名
      Oracle E-Business Suite apmrum.ebs.base.min.js EbsFunctionId,EbsOAFunc,EbsClassName,EbsRegionCode,EbsAkRegionCode EBSスイート
      PeopleSoft apmrum.psft.fluidui.min.js portalName, portalPortalNodePart,portalObjName -
      Siebel apmrum.sbl.openui.min.js ActiveView,ActiveApplet,ActiveBusObj,ActiveBusComp,WebApplicationName -
      OBIEE apmrum.obiee.base.min.js UserName(ハッシュ) -
      Visual Builder Studio apmrum.vbs.base.min.js ActionOutcome、EventName、EventType、ContainerParentId、ContainerParentType、AppUiId、ユーザー名(ハッシュ) -
      たとえば、Oracle E-Business Suiteアプリケーション(ライブラリ名はapmrum.ebs.base.min.js)を使用しており、APMデータ・アップロード・エンドポイントの値がaaaac5d2kke6waaaaaaaaaaala.APM-agt.us-ashburn-1.oci.oraclecloud.comの場合、スクリプトは次のようになります。
      <script crossorigin="anonymous" src="aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com/static/jslib/apmrum.ebs.base.min.js"></script>