Vue d’ensemble de la journalisation ULS (Unified Logging System)

Dernière modification : jeudi 15 avril 2010

S’applique à : SharePoint Foundation 2010

Dans cet article
Éléments fournis par la journalisation ULS
Moment auquel un développeur doit utiliser la journalisation ULS
Manipulation des journaux du service ULS par un développeur

Une stratégie de journalisation efficace a longtemps été considérée par les administrateurs système comme un moyen d’effectuer le suivi des problèmes liés aux composants et aux applications, de fournir des statistiques quantifiables pour l’historique d’une application, de faciliter la résolution des problèmes, ainsi que de faciliter la surveillance de l’intégrité globale des systèmes placés sous la responsabilité des administrateurs.

Cette rubrique explique comment, en tant que développeur, vous pouvez utiliser les mécanismes de journalisation fournis par Microsoft SharePoint Foundation pour faciliter le développement d’applications, fournir des informations plus détaillées pour le débogage et communiquer avec les administrateurs système lorsqu’un problème est rencontré ou qu’un seuil est atteint. Le mécanisme principal est le service de journalisation unifiée (ULS, Unified Logging Service), qui écrit les événements SharePoint Foundation dans le journal de suivi de SharePoint et les stocke dans le système de fichiers. (Remarque : les journaux du service ULS sont également parfois appelés journaux de suivi.)

Éléments fournis par la journalisation ULS

La journalisation ULS, lorsqu’elle est implémentée efficacement, peut fournir des informations très utiles pour les publics suivantes.

Développeurs

En tant que développeur, vous pouvez tirer parti du journal de suivi lorsque vous développez du code. Utilisez les journaux de suivi en guise d’extension de vos outils de développement et en tant qu’outil de débogage supplémentaire pour mieux analyser les problèmes. Grâce à l’écriture d’informations utiles dans le journal de suivi, de nombreux problèmes qui se produisent pendant le développement peuvent être résolus sans qu’il soit nécessaire d’attacher un débogueur. En outre, un testeur peut passer en revue les journaux de suivi pour découvrir les problèmes susceptibles de ne pas apparaître dans l’interface utilisateur et utiliser les journaux de suivi pour vérifier l’achèvement des tâches de longue durée éventuellement dépourvues d’une interface utilisateur associée aux actions.

Un autre avantage de la journalisation ULS pour les développeurs réside dans le fait que les problèmes rencontrés dans l’interface utilisateur ou dans les notifications n’ont pas besoin d’être affichés dans l’interface utilisateur. À la place, ils peuvent être écrits dans la base de données en vue d’être passés en revue et analysés par les administrateurs et les développeurs.

Administrateurs de serveur

Un message du journal des événements ne revêt de l’importance pour l’administrateur système que si la quantité d’informations et de métadonnées permet à celui-ci de déterminer l’action nécessaire, à quel endroit celle-ci est requise et ce qui la justifie. Une autre information contextuelle utile pouvant être incluse dans le journal des événements est l’utilisateur à l’origine de l’action. À l’évidence, il est très important que la surveillance et les performances du serveur soient couronnées de succès dans l’environnement de l’entreprise, et la journalisation ULS permet aux administrateurs d’affiner les performances système après un déploiement.

Personnel de support technique

Lorsque se produit un problème qui doit être résolu rapidement à l’aide du service clientèle Microsoft, les journaux du service ULS peuvent fournir des informations détaillées sur ce problème à un groupe de support technique afin de permettre une résolution plus rapide.

Attention
En général, gardez à l’esprit que le texte de la journalisation n’est pas découpé à des fins de sécurité. Par conséquent, lorsque vous créez des messages de journal, veillez à ne pas inclure d’informations sensibles sur l’entreprise ou personnelles susceptibles d’être écrites dans les journaux.

Moment auquel un développeur doit utiliser la journalisation ULS

En général, plus un développeur peut fournir d’informations sur son code, plus il est facile de résoudre les problèmes susceptibles de se produire.

Manipulation des journaux du service ULS par un développeur

Dans SharePoint Foundation, le service ULS expose des paramètres configurables de deux façons, par le biais :

• du modèle objet ;

• des applets de commande Windows PowerShell.

Modèle objet et journaux du service ULS

Dans Windows SharePoint Services 3.0, l’accès aux journaux du service ULS était fourni par le biais de l’interface IDiagnosticsManager. Toutefois, dans SharePoint Foundation, il est recommandé d’utiliser la classe SPDiagnosticsServiceBase. La classe SPDiagnosticsServiceBase inclut dans un wrapper tous les appels à la classe IDiagnosticsManager, ce qui permet aux développeurs d’interagir plus facilement avec les journaux des événements. Grâce à cette approche, vous pouvez écrire directement dans le service de suivi.

Pour plus d’informations sur l’utilisation du modèle objet pour manipuler les journaux du service ULS, voir Utilisation de l’API de journalisation du suivi

Windows PowerShell et journaux du service ULS

Pour plus d’informations sur l’écriture d’applets de commande Windows PowerShell dans SharePoint Foundation pour manipuler les journaux du service ULS, voir Utilisation d’applets de commande Windows Powershell avec la journalisation ULS