Configuration ODL

Pour chaque produit Oracle Enterprise Performance Management System utilisant le format de journalisation ODL, il existe au moins un fichier de configuration de la journalisation, logging.xml. Les composants EPM System ont des noms descriptifs au format loggingCOMPONENT_NAME.xml.

Les fichiers de configuration de la journalisation comportent deux sections : log_handlers et loggers. La section log_handlers définit les journaliseurs et leurs paramètres ; la section loggers contient les détails, notamment le niveau de journalisation et le gestionnaire log_handler à utiliser.

Reportez-vous au Tableau 3-9 pour obtenir la liste des propriétés de gestionnaire log_handler que vous pouvez spécifier.

Niveaux de journalisation ODL

Tableau 3-7 Niveaux de journalisation ODL

Niveau Description
INCIDENT_ERROR:1 Messages liés à un problème grave dont les causes sont inconnues. Les utilisateurs doivent faire appel au support Oracle pour la résolution du problème.
ERROR:1 Messages liés à un problème grave nécessitant l'intervention immédiate de l'administrateur système, mais qui ne provient pas d'un défaut d'un composant EPM System
WARNING:1 Messages liés à un problème potentiel que l'administrateur système doit examiner.
NOTIFICATION:1 Messages liés à un événement majeur du cycle de vie comme l'activation ou la désactivation d'une fonctionnalité ou d'un sous-composant principal.
NOTIFICATION:16 Messages liés à des événements normaux dans les composants EPM System
TRACE:1 Messages de trace ou de débogage d'événements significatifs pour les utilisateurs finaux des composants EPM System
TRACE:16 Message de trace ou de débogage détaillés qu'Oracle Support peut utiliser pour diagnostiquer les problèmes des composants EPM System
TRACE:32 Messages de trace ou de débogage très détaillés, généralement destinés à un développeur Oracle pour lui permettre de localiser l'origine d'une erreur

Fichier de configuration ODL : déploiements vers un serveur géré unique

Le déploiement de composants EPM System vers un serveur géré unique génère un fichier de configuration de la journalisation unifié, logging.xml, pour toutes les applications Web Java déployées. Sur un serveur Windows, ce fichier se trouve généralement dans le répertoire MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EPMServer0.

Fichiers de configuration ODL : déploiements standard

Le déploiement standard d'EPM System génère un fichier de configuration de la journalisation logging.xml pour chaque application Web Java déployée. Sur un serveur Windows, l'emplacement de ces fichiers est généralement le suivant :

Tableau 3-8 Emplacement des fichiers de configuration ODL dans les déploiements standard

Composant Emplacement de logging.xml
Serveur d'administration (console d'administration Oracle WebLogic Server, Oracle Web Services Manager, Enterprise Manager) MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AdminServer/logging.xml
Oracle Hyperion Provider Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AnalyticProviderServices0/logging.xml
Oracle Hyperion Calculation Manager MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/CalcMgr0/logging.xml
Oracle Essbase Administration Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EssbaseAdminServices0/logging.xml
Oracle Hyperion Foundation Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/FoundationServices0/logging.xml
Web Oracle Hyperion Financial Management MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/HFMWeb0/logging.xml
Oracle Hyperion Planning MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/Planning0/logging.xml

Modification des fichiers de configuration ODL

Modifiez les propriétés des journaliseurs définies dans logging.xml permet de déterminer le niveau auquel les messages sont journalisés. Le niveau défini par défaut dans logging.xml est celui qui convient pour un fonctionnement normal des composants EPM System. D'autres paramètres des gestionnaires de journal permettent de modifier le comportement de la journalisation. Par exemple, vous pouvez spécifier la fréquence de rotation des fichiers de journalisation en utilisant le paramètre rotationFrequency pour le gestionnaire de journal. Pour obtenir la liste complète des paramètres, reportez-vous au Tableau 3-9.

Tableau 3-9 Propriétés configurables des journaux ODL

Propriété du journal Description

path

Chemin du journal

format

Format à utiliser

Valeur recommandée : ODL-Text.

maxFileSize

Taille maximale de chaque fichier journal, en octets

Lorsque le fichier journal principal atteint la taille indiquée, la rotation est déclenchée, le fichier journal principal est archivé et un nouveau fichier journal est créé.

maxLogSize

Taille maximale de la totalité du journal, en octets

Les fichiers archivés les plus anciens sont supprimés pour que la taille totale du journal reste dans la limite indiquée.

rotationFrequency

Fréquence de rotation des journaux, en minutes

Cette valeur doit être un nombre (de minutes), ou le mot hourly, daily ou weekly. (Il n'est pas nécessaire de respecter la casse pour ce paramètre.)

baseRotationTime

Date/heure de base pour les rotations basées sur le temps ; par exemple, point de départ pour le paramètre rotationFrequency

Valeur par défaut : 1er janvier 1970, UTC

Utilisez l'un des formats suivants :

  • HH:mm

  • yyyy-MM-dd

  • yyyy-MM-ddT-HH:mm

  • yyyy-MM-dd-HH:mm:ss.sTZ, où TZ est l'indicateur de fuseau horaire et peut avoir pour valeur Z pour UTC ou un décalage par rapport à GMT au format plus_or_minusHH:mmm

Remarque :

Si le format ne précise pas le fuseau horaire, le fuseau horaire local est utilisé.

retentionPeriod

Durée de conservation des fichiers journaux

Les fichiers ayant dépassé cette durée sont supprimés. Ils ne le sont qu'en cas de rotation ; aucun thread en arrière-plan ne supprime les fichiers journaux. De ce fait, il se peut que les fichiers continuent à exister un certain temps au-delà de la durée de conservation. La valeur doit être un nombre (de minutes), ou bien day, week, month (30 jours) ou year (le respect de la casse n'est pas nécessaire).

encoding

Type d'encodage de caractères à utiliser

Les fichiers XML doivent utiliser l'encodage UTF-8 pour gérer les caractères étendus. Valeur par défaut : <?xml version="1.0" encoding="UTF-8" ?>.

supplementalAttributes

Liste de noms d'attributs supplémentaires, séparés par des virgules, pouvant être ajoutés à chaque message du journal

La valeur de l'attribut doit être définie dans la classe ExecutionContext.

useSourceClassAndMethod

Indique si la classe source Java et le nom de méthode doivent être ajoutés à chaque message du journal

La valeur est un nom de niveau. Les messages du niveau indiqué ou d'un niveau inférieur incluent la classe source et le nom de méthode. Les constantes true et false sont également acceptées comme alias pour OFF et ALL. Valeur par défaut : TRACE:1 (Fine).

useDefaultAttributes

Indique si les valeurs d'attribut par défaut doivent être ajoutées à chaque message du journal.

Les attributs par défaut pouvant être affectés sont HOST_ID, HOST_NWADDR et USER_ID. La valeur doit être true ou false. La valeur par défaut est true pour le format ODL-XML et false pour le format ODL-Text.

includeMessageArguments

Indique si les arguments de message doivent être inclus avec les messages de journal formatés qui ont également un ID de message

Valeurs possibles : true (valeur par défaut) ou false.

useThreadName

L'indicateur useThreadName détermine si le gestionnaire doit tenter de journaliser le nom de thread réel plutôt que la valeur threadID fournie par java.util.logging.LogRecord.

Si l'indicateur est défini sur true, le gestionnaire tente de journaliser le nom de thread réel. Dans certains cas, il arrive qu'il ne puisse pas déterminer le nom réel du thread ; il journalise alors la valeur threadID. La valeur par défaut est true.

useRealThreadId

L'indicateur useRealThreadId détermine si le gestionnaire doit tenter de journaliser l'ID de thread réel plutôt que la valeur threadID fournie par java.util.logging.LogRecord.

Si l'indicateur est défini sur true, le gestionnaire tente de journaliser l'ID de thread réel. Dans certains cas, il arrive qu'il ne puisse pas déterminer le nom réel du thread ; il journalise alors la valeur threadID. La valeur par défaut est false. La propriété de journalisation de l'ID de thread réel et la propriété useThreadName s'excluent mutuellement. Lorsque la valeur de useThreadName est true, la valeur de la propriété useRealThreadId est ignorée.

locale

Remplacement des paramètres régionaux par défaut pour la localisation des messages

Valeur par défaut : paramètres régionaux par défaut, définis dans le configurateur EPM System.

keepOpen

Indique si le fichier journal principal doit rester ouvert en permanence ou être ouvert et fermé à chaque opération de journalisation.

Valeurs possibles : true et false. Avec la valeur par défaut, true, le fichier journal principal reste ouvert en permanence.

La valeur par défaut convient dans la plupart des cas.

autoFlushLevel

Niveau pour le vidage automatique

ODLHandler permet de mettre les enregistrements de journal en mémoire tampon, mais il vide automatiquement la mémoire tampon à l'arrivée d'un enregistrement d'un niveau égal ou supérieur au niveau autoFlush indiqué. Valeur par défaut : NOTIFICATION:1.

addJvmNumber

Le numéro de JVM est ajouté au nom du fichier journal

Le numéro de JVM est défini par la propriété système oracle.process.index. Si celle-ci n'est pas définie, cette option est ignorée.

applicationContextProvider

Nom d'une classe implémentant l'interface ApplicationContext

La classe doit comporter un constructeur par défaut. La valeur spéciale disabled permet de désactiver la journalisation du nom d'application. Le fournisseur de contexte d'application par défaut est propre à la plate-forme ; dans la plupart des cas, il n'est pas nécessaire de définir cette propriété.

userContextProvider

Nom d'une classe implémentant l'interface UserContext

La classe doit comporter un constructeur par défaut. La valeur spéciale disabled permet de désactiver la journalisation du nom d'utilisateur. Le fournisseur de contexte d'utilisateur par défaut est propre à la plate-forme ; dans la plupart des cas, il n'est pas nécessaire de définir cette propriété.

La modification des propriétés des journaliseurs est utile au moment de déboguer un composant ou de générer les informations demandées par le support Oracle pour identifier les problèmes d'un composant EPM System.

Par exemple, pour capturer les messages de débogage d'Oracle Hyperion Shared Services, modifiez le niveau de journalisation de chaque définition de journaliseur Shared Services pour le faire passer à TRACE:32.

Remarque :

Une fois le débogage terminé, restaurez le fichier logging.xml d'origine à partir d'une sauvegarde afin de retrouver les paramètres de journalisation optimaux.

Pour modifier le fichier de configuration de la journalisation, procédez comme suit :

  1. Créez une sauvegarde du fichier de configuration de la journalisation du composant EPM System pour lequel le comportement de la journalisation doit être modifié. Reportez-vous à la section Matrice de journalisation des produits EPM System.

  2. A l'aide d'un éditeur de texte, ouvrez logging.xml.

  3. Localisez les définitions des journaliseurs. Par exemple, pour modifier le niveau de journalisation de Shared Services, modifiez les définitions de journaliseur suivantes :

    <logger name="oracle.EPMCAS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcas-handler" />
</logger>
<logger name="oracle.EPMCES" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmces-handler" />
</logger>
<logger name="oracle.EPMCMS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcms-handler" />
</logger>
<logger level="NOTIFICATION:1" name="oracle.EPMCSS">
     <handler name="epmcss-handler" />
</logger>

  4. Modifiez la propriété level pour définir le niveau de journalisation voulu. Par exemple, définissez la propriété level de chaque journaliseur sur TRACE:32 pour obtenir des messages de débogage détaillés.

    Reportez-vous à la section Niveaux de journalisation ODL.

  5. Enregistrez et fermez le fichier logging.xml.

  6. Redémarrez le composant EPM System pour que les modifications entrent en vigueur.