Déploiement de l'agent de navigateur APM avec votre application

Vous pouvez déployer l'agent de navigateur APM en insérant du code JavaScript dans toutes les pages de votre application et en autorisant Application Performance Monitoring à générer des rapports sur l'expérience des utilisateurs réels.

Remarque

Les détails de l'emplacement et de la méthode d'insertion de JavaScript sont propres à l'application surveillée.

Agent Java APM : lorsque l'agent Java APM est déployé, il peut également être configuré pour injecter automatiquement le script d'agent de navigateur APM. Cela inclut le script spécifique à l'application packagée, le cas échéant.

Pour insérer le code JavaScript, procédez comme suit :

  1. Modifiez la source HTML des pages de l'application surveillée.
    Remarque

    • Pour les applications Web packagées, il existe généralement un modèle de page utilisé pour toutes les pages appartenant à l'application Web.

      Assurez-vous d'inclure également le script spécifique de l'application packagée, le cas échéant. Pour plus de détails, reportez-vous à Déploiement de l'agent de navigateur APM avec des applications packagées.

    • La configuration peut être stockée dans l'objet window.apmrum ou document.apmrum.

      Veillez à utiliser le même objet de façon cohérente afin d'éviter les configurations déroutantes. Le chargement lazy est utilisé pour les propriétés de l'objet et les mises à jour sont appliquées dynamiquement.

  2. Renseignez les valeurs des propriétés suivantes et insérez le script après la balise </head> fermante. Veillez à ne pas ajouter le code dans une autre balise <script> :
    • window.apmrum.serviceName : indiquez le nom du service. Si vous n'indiquez pas de nom de service, le nom de service par défaut, APM Browser, est affecté. Nous vous recommandons d'indiquer un nom de service pour pouvoir filtrer les données par service et surveiller les étendues correspondantes.
    • window.apmrum.webApplication : indiquez le nom de l'application Web, qui peut être utilisée pour classer les domaines fonctionnels du déploiement. Si aucune valeur pour webApplication n'est spécifiée, la valeur par défaut "WebApp" sera utilisée.
    • window.apmrum.ociDataUploadEndpoint : indiquez l'adresse de téléchargement de données. Elle détermine le centre de données et le domaine vers lesquels les données de surveillance des utilisateurs réels sont téléchargées. La valeur de l'adresse de téléchargement de données peut être obtenue de la manière suivante :
      • Ouvrez la console OCI, accédez à Observation & gestion > Gestion des performances des applications > Administration et sélectionnez le domaine souhaité.
      • Cliquez sur Copier en regard de l'option Adresse de téléchargement de données afin de copier la valeur dans le presse-papiers et de l'utiliser pour définir la valeur de window.apmrum.ociDataUploadEndpoint.
    • window.apmrum.OracleAPMPublicDataKey : indiquez la clé de données publique générée lors de la création du domaine APM. Vous pouvez obtenir la clé de données publique de la manière suivante :
      • Ouvrez la console OCI, accédez à Observation & gestion > Gestion des performances des applications > Administration et sélectionnez le compartiment et le domaine souhaités.
      • Cliquez sur Clés de données sous Ressources. Si aucune clé de données n'existe, cliquez sur Générer une clé de données, puis sélectionnez Clé de données publique.
      • Cliquez sur Copier en regard d'une clé de données publique afin d'extraire la valeur à utiliser pour renseigner la valeur de window.apmrum.OracleAPMPublicDataKey.

    Afin d'optimiser les performances pour les utilisateurs de l'application surveillée, vous devez indiquer l'emplacement d'une bibliothèque JavaScript et vous assurer qu'elle est accessible sur votre réseau.

    Exemple avec JavaScript

    Le script se présente comme suit :

    <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>
    Où :
    • <APM Browser> est la valeur de nom de service indiquée pour votre agent de navigateur APM. Si vous ne définissez aucune valeur, le nom de service par défaut APM Browser est affecté.
    • <Web App Name> est la valeur du nom de l'application Web.
    • <ociDataUploadEndpoint> est la valeur de l'adresse de téléchargement de données. Elle peut être obtenue à partir de la page Administration d'APM. Reportez-vous à Obtention de l'adresse de téléchargement de données et des clés de données.
    • <APM Public Datakey> est la valeur de la clé de données publique APM qui peut être obtenue à partir du menu Administration de la page principale d'APM.

    Par exemple, si la valeur de l'adresse de téléchargement de données est aaaac5d2kke6waaaaaaaaala.apm-agt conformeTERM:us-ashburn-1.oci.oraclecloud.com et que la valeur de la clé de données publique APM est IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD, le script se présente comme suit :

    <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>

    L'utilisation de la référence à <ociDataUploadEndpoint>/static/jslib/apmrum.min.js dans votre instrumentation garantit que la surveillance APM tire toujours parti de la dernière version disponible de l'agent de navigateur APM.

    Une fois terminé, reportez-vous à Vérification du déploiement de l'agent de navigateur APM.

    Remarque

Déployer l'agent de navigateur APM avec des applications packagées

Lors de la surveillance d'applications packagées, il est possible d'utiliser un script spécifique qui permet de capturer les caractéristiques de cette application packagée. Cela peut être utilisé pour réduire le besoin de configuration manuelle pour capturer les spécificités de l'application de package.

Vous pouvez utiliser un ensemble spécifique de code javascript lorsque vous utilisez l'une des applications packagées prises en charge suivantes :
  • Oracle E-Business Suite.
  • PeopleSoft.
  • Siebel.
  • Oracle Business Intelligence Enterprise Edition (OBIEE).
  • Visual Builder Studio.

Le script effectue le suivi des caractéristiques de l'application packagée spécifique, reconnaît les zones spécifiques de l'URL/du DOM et les utilise pour enrichir les étendues avec des attributs supplémentaires.

Pour déployer l'agent de navigateur avec une application packagée, procédez comme suit :
  1. Vérifiez que vous avez terminé l'étape d'ajout de la bibliothèque apmrum.min.js au script, comme décrit dans la section Deploy the APM Browser Agent With Your Application.

  2. Ajoutez la bibliothèque d'applications packagée spécifique au script.
    <script crossorigin="anonymous" src="<ociDataUploadEndpoint>/static/jslib/<libraryName>"></script>

    Où :

    • <ociDataUploadEndpoint> est la valeur de l'adresse de téléchargement de données. Pour plus de détails, reportez-vous à Obtention de l'adresse de téléchargement de données et des clés de données.
    • <libraryName> est le nom de bibliothèque de l'application packagée spécifique. Pour plus de détails, reportez-vous au tableau ci-dessous :
      Application packagée <libraryName> Exemples d'attribut Nom des règles système
      Oracle E-Business Suite apmrum.ebs.base.min.js EbsFunctionId,EbsOAFunc,EbsClassName,EbsRegionCode,EbsAkRegionCode Suite 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(hachage) -
      Studio Visual Builder apmrum.vbs.base.min.js ActionOutcome,EventName,EventType,ContainerParentId,ContainerParentType,AppUiId,Nom utilisateur (hash) -
      Par exemple, si vous utilisez des applications Oracle E-Business Suite (le nom de la bibliothèque est apmrum.ebs.base.min.js) et que la valeur de l'adresse de téléchargement de données APM est aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com, le script se présente comme suit :
      <script crossorigin="anonymous" src="aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com/static/jslib/apmrum.ebs.base.min.js"></script>