Déployer l'agent de navigateur APM avec votre application
Vous pouvez déployer l'agent de navigateur APM en insérant un code JavaScript dans toutes les pages de votre application et permettre au service de surveillance de la performance des applications de produire des rapports sur l'expérience utilisateur réelle.
Les détails relatifs à l'emplacement et à l'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 :
- Modifiez la source HTML des pages d'application surveillées.
Note
- Pour les applications Web groupé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 propre à l'application groupée, le cas échéant. Pour plus de détails, voir Déployer l'agent de navigateur APM avec des applications groupées.
- La configuration peut être stockée dans l'objet
window.apmrum
oudocument.apmrum
.Veillez à utiliser le même objet de façon cohérente afin d'éviter toute confusion dans les configurations. Le chargement dynamique est utilisé pour les propriétés de l'objet et les mises à jour sont appliquées de manière dynamique.
- Pour les applications Web groupées, il existe généralement un modèle de page utilisé pour toutes les pages appartenant à l'application Web.
- Spécifiez des valeurs pour les propriétés suivantes et insérez le script après la balise
</head>
de fermeture. Assurez-vous de ne pas ajouter le code dans une autre balise<script>
:window.apmrum.serviceName
: Indiquez un nom pour le service. Si vous n'entrez pas de nom pour le service, le nom de service par défaut,APM Browser
, est affecté. Il est recommandé d'indiquer un nom de service pour pouvoir filtrer par service et surveiller les intervalles correspondants.window.apmrum.webApplication
: Spécifiez un nom pour l'application Web, qui peut être utilisé pour classer les domaines fonctionnels du déploiement. Si aucune valeur n'est spécifiée pour webApplication, la valeur par défaut "WebApp" sera utilisée.window.apmrum.ociDataUploadEndpoint
: Indiquez le point d'extrémité de chargement des données qui détermine le centre de données et le domaine dans lesquels les données de surveillance des utilisateurs réels (RUM) seront chargées. Vous pouvez obtenir la valeur du point d'extrémité de chargement des données de la façon suivante :- Accédez à la console OCI, sélectionnez Observabilité et gestion > Gestion de la performance des applications > Administration et sélectionnez le domaine désiré.
- Cliquez sur Copier à côté de Point d'extrémité de chargement des données afin de copier la valeur dans le presse-papiers et 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 façon suivante :- Accédez à la console OCI, naviguez jusqu'à Observabilité et gestion > Gestion de la performance des applications > Administration et sélectionnez le compartiment et le domaine désiré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 et sélectionnez Clé de données publique.
- Cliquez sur Copier à côté d'une clé de données de type Publique pour extraire la valeur à utiliser pour alimenter
window.apmrum.OracleAPMPublicDataKey
.
Pour optimiser la performance 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 dans votre réseau.
Exemple 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 le nom de service que vous indiquez pour votre agent de navigateur APM. Si vous ne définissez pas de valeur, le nom de service
APM Browser
est affecté par défaut. - <Web App Name> est la valeur du nom de l'application Web.
- <ociDataUploadEndpoint> est la valeur du point d'extrémité de chargement des données. Cette valeur peut être obtenue à partir de la page Administration APM. Voir Obtenir un point d'extrémité de 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 APM principale.
Par exemple, si le point d'extrémité de chargement des données est aaaac5d2kke6waaaaaaaaaaala.apm-agt.us-ashburn-1.oci.oraclecloud.com et la clé de données publique APM est IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD, le script ressemble à ceci :
<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 l'opération terminée, voir Vérifier le déploiement de l'agent de navigateur APM
Note
- Pour plus d'informations sur les clés de données publiques et l'élément DataUploadEndpoint, voir Obtenir un point d'extrémité de chargement de données et des clés de données.
-
Si vous disposez d'une application packagée, voir Déployer l'agent de navigateur APM avec les applications packagées.
Déployer l'agent de navigateur APM avec des applications groupées
Lors de la surveillance des applications groupées, il est possible d'utiliser un script spécifique qui permet de saisir les caractéristiques de cette application groupée. Ceci peut être utilisé pour réduire le besoin de configuration manuelle pour saisir les détails de l'application de package.
- Oracle E-Business Suite.
- PeopleSoft.
- Siebel.
- Oracle Business Intelligence Enterprise Edition (OBIEE).
- Visual Builder Studio.
Le script suit les caractéristiques de l'application groupée spécifique, reconnaît les zones spécifiques dans l'URL/DOM et les utilise pour enrichir les intervalles avec des attributs supplémentaires.
-
Vérifiez que vous avez terminé l'étape d'ajout de la bibliothèque
apmrum.min.js
au script, comme décrit dans Déployer l'agent de navigateur APM avec votre application. - Ajoutez la bibliothèque d'applications intégrée au script.
<script crossorigin="anonymous" src="<ociDataUploadEndpoint>/static/jslib/<libraryName>"></script>
Où :
- <ociDataUploadEndpoint> est la valeur du point d'extrémité de chargement des données. Pour plus de détails, voir Obtenir un point d'extrémité de chargement de données et des clés de données.
- <libraryName> est le nom de la bibliothèque de l'application groupée spécifique. Pour plus de détails, voir le tableau ci-dessous :
Ensemble d'applications <libraryName> Exemples d'attributs 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 (code de hachage) - Studio Visual Builder apmrum.vbs.base.min.js ActionOutcome,EventName,EventType,ContainerParentId,ContainerParentType,AppUiId,Nom d'utilisateur (code de hachage) - 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 du point d'extrémité de chargement des 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>