Référence du schéma de profil dans SharePoint Server

S’APPLIQUE À :  yes-img-13 2013  yes-img-16 2016  yes-img-19 2019  yes-img-se Subscription Edition  no-img-sop SharePoint in Microsoft 365

Lorsque vous exécutez le script Microsoft PowerShell BackupMonitoringSettings.ps1 sur une batterie de serveurs SharePoint, vous créez un fichier appelé profil. Ce profil suit un schéma XML. Vous pouvez modifier les paramètres des éléments de ce schéma pour créer un profil personnalisé. Vous pouvez ensuite utiliser le profil personnalisé pour automatiser la configuration des paramètres d'analyse dans un environnement SharePoint. Pour consulter une présentation de la configuration de l'analyse par script, voir Configuration d'analyse par script dans SharePoint Server.

Les administrateurs peuvent exécuter les scripts avant, pendant et après l’apport de modifications à la batterie de serveurs (comme des changements de topologie, des modifications importantes des paramètres de sécurité, l’application de mises à jour logicielles ou l’exécution d’un test de performances). Les scripts modifient les paramètres d’analyse pour faciliter la collecte de toutes les données nécessaires pendant l’événement sans pour autant saturer la base de données de journalisation dans des conditions de fonctionnement normales.

Notes

Vous devez télécharger les scripts PowerShell pour sauvegarder, restaurer ou modifier les paramètres d’analyse des batteries de serveurs. Ces scripts sont disponibles dans la bibliothèque TechNet, sur les pages consacrées aux scripts de configuration de l’analyse BackupMonitoringSettings et AlterMonitoringSettings. Le script PowerShell BackupMonitoringSettings.ps1 crée le profil de sauvegarde à partir duquel vous pouvez créer d’autres profils.

Vous pouvez créer un ou plusieurs profils pour ajuster le niveau d’analyse au cours des différentes phases du cycle de vie SharePoint. Vous pouvez également utiliser un profil personnalisé pour configurer l’analyse sur plusieurs batteries à la fois.

Les profils sont généralement créés pour effectuer les tâches suivantes :

  • Terminer la configuration des paramètres d'analyse sur une batterie de serveurs après avoir installé SharePoint Server

  • Modifier les paramètres d’analyse d’une batterie de serveurs juste avant une modification administratif, par exemple une modification des paramètres d’une application Service de recherche sur la batterie de serveurs

    Vous pouvez ainsi capturer plus de données d’analyse concernant cette modification et supprimer celles dont vous ne voulez pas. Vous pouvez ensuite rétablir les paramètres d’analyse d’origine une fois la modification terminée.

  • Restaurer les paramètres d’analyse d’une batterie de serveurs après une modification administrative

  • Restaurer un précédent ensemble de paramètres d’analyse sur une batterie de serveurs

    Ce peut être le cas si vous apportez des modifications manuelles aux paramètres et que vous décidez de rétablir les valeurs précédentes.

  • Restaurer les paramètres par défaut

  • Créer un profil que vous pouvez appliquer à plusieurs batteries de serveurs

Sauvegarde des paramètres d’origine

Vous devez toujours sauvegarder les paramètres d'analyse par défaut avant de les modifier. Ainsi, vous pouvez les restaurer si nécessaire. Le profil de sauvegarde peut également servir de point de départ pour la création d'autres profils. Pour plus d'informations sur la sauvegarde des paramètres, voir Exécuter des scripts de configuration d'analyse dans SharePoint Server.

Présentation du schéma de profil

Lorsque vous exécutez le script PowerShell BackupMonitoringSettings.ps1, vous créez un profil qui suit le schéma XML ci-dessous. Les éléments du fichier contiennent les paramètres d'analyse associés à la batterie de serveurs.

<?xml version="1.0" standalone="yes"?>
<Configuration>
  <FarmDiagnosticConfig />
  <UsageServices>
    <UsageService />  
  </UsageServices>
  <UsageDefinitions>
    <UsageDefinition />
  </UsageDefinitions>
  <LogLevels>
    <LogLevel />
  </LogLevels>
  <TimerJobs>
    <TimerJob />
  </TimerJobs>
  <HealthAnalyzerRules>
    <HealthAnalyzerRule />
  </HealthAnalyzerRules>
</Configuration>

Important

Dans les tableaux suivants, il est impossible de modifier les valeurs des champs marqués comme étant en lecture seule. Toute modification de ces champs peut avoir des conséquences inattendues.

Paramètres de l'élément FarmDiagnosticConfig

Nom Type de valeur Remarques
AllowLegacyTraceProviders
Booléen
Spécifie que les fournisseurs de trace générés pour les versions antérieures des produits et technologies SharePoint peuvent écrire dans la session de suivi pour SharePoint Server.
AppAnalyticsAutomaticUploadEnabled
Booléen
Spécifie si les données d'utilisation de l'application agrégées sont automatiquement téléchargées vers Microsoft.
CustomerExperienceImprovementProgramEnabled
Booléen
Détermine si un groupe d’administration a activé la fonctionnalité Programme d’amélioration du produit.
ErrorReportingEnabled
Booléen
Obtient ou définit une valeur pour indiquer si la collecte de données de blocage et la génération de rapports d’erreurs sont activées.
ErrorReportingAutomaticUploadEnabled
Booléen
Indique si la participation au Programme d'amélioration du produit est activée. Ce programme est conçu pour améliorer la qualité, la fiabilité et les performances des produits et technologies Microsoft. Avec votre autorisation, des informations anonymes concernant votre serveur sont envoyées à Microsoft en vue d'améliorer SharePoint Server.
DownloadErrorReportingUpdatesEnabled
Booléen
Spécifie si les rapports d'erreur sont téléchargés automatiquement vers Microsoft. Ces rapports incluent les données suivantes : les informations concernant l'état du serveur au moment où un problème se produit, la version du système d'exploitation et du matériel utilisés, et l'ID du produit numérique (peut être utilisé pour identifier votre licence).
Remarque :
L'adresse IP de votre ordinateur est également envoyée, car vous vous connectez à un service en ligne pour envoyer des rapports d'erreurs ; toutefois, l'adresse IP n'est utilisée que pour générer des statistiques d'agrégation.
DaysToKeepLogs
Entier
Spécifie le nombre de jours de conservation des fichiers journaux de suivi. Le type doit correspondre à un nombre valide compris entre 1 et 366. La valeur par défaut est 14 jours.
LogMaxDiskSpaceUsageEnabled
Booléen
Spécifie si l'espace maximal réservé aux fichiers journaux de suivi doit être limité.
LogDiskSpaceUsageGB
Entier
Spécifie le volume de stockage maximal à utiliser pour les fichiers journaux de suivi, en gigaoctets (Go). La valeur par défaut est 1000 et ne prend effet que lorsque le paramètre LogMaxDiskSpaceusageEnabled a la valeur True. Le type doit correspondre à un nombre valide compris entre 1 et 1 000.
LogLocation
String:Path
Il s’agit du chemin d’accès complet de l’emplacement où vous souhaitez stocker les fichiers journaux. Il peut s’agir d’un emplacement distant. Par exemple : « %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\16\LOGS" et « %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\LOGS\"
LogCutInterval
Entier
Spécifie le délai devant s’écouler avant de passer au fichier journal suivant. Le type doit être un nombre valide compris entre 0 et 1 440.
EventLogFloodProtectionEnabled
Booléen
Indique si la fonctionnalité de protection de flux de journal des événements est activée. Si le journal des événements contient des événements similaires, certains messages en double sont supprimés. Après un certain temps, il crée un message résumant le nombre d’événements qui ont été supprimés.
EventLogFloodProtectionThreshold
Entier
Spécifie le nombre d’événements autorisés dans une période donnée avant qu’un événement soit considéré comme excédentaire pour le journal des événements. La plage d’entiers est comprise entre 1 et 100. La valeur par défaut est 5.
EventLogFloodProtectionTriggerPeriod
Entier
Spécifie, en minutes, la période à surveiller pour la survenance d’événements potentiellement excédentaires. La plage d’entiers est comprise entre 1 et 1 440. La valeur par défaut est 2.
EventLogFloodProtectionQuietPeriod
Entier
Spécifie, en minutes, le temps qui doit s’écouler sans déclenchement d’un événement pour quitter la protection de flux. La plage d’entiers est comprise entre 1 et 1 440. La valeur par défaut est 2.
EventLogFloodProtectionNotifyInterval
Entier
Spécifie, en minutes, la fréquence d’écriture d’un événement récapitulatif indiquant le nombre d’événements supprimés en raison de la protection de flux. La plage d’entiers est comprise entre 1 et 1 440. La valeur par défaut est 5.
ScriptErrorReportingEnabled
Booléen
Active ou désactive la création de rapports sur les erreurs de script dans le fichier journal.
ScriptErrorReportingRequireAuth
Booléen
Spécifie si la fonction de création de rapports d'erreurs de script requiert l'authentification.
ScriptErrorReportingDelay
Entier
Spécifie la durée (en minutes) entre les rapports d’erreur de script. La valeur doit être un entier valide compris entre 0 et 1 440. La valeur est spécifiée en minutes. La valeur par défaut est de 30.

Utilisez le tableau suivant pour les paramètres UsageServices.

Éléments des paramètres UsageServices

Nom Type de valeur Remarques
ID
GUID : Lecture seule
GUID au format 12345678-90ab-cdef-1234-567890bcdefgh.
UsageLogLocation
Chemin d’accès
Spécifie le chemin d’accès sur chaque ordinateur de la batterie où les fichiers journaux d’utilisation sont créés. Le même chemin d’accès doit exister sur tous les ordinateurs de la batterie de serveurs.
LoggingEnabled
Booléen
Spécifie que des données d'utilisation sont consignées dans des fichiers d'utilisation.
UsageLogMaxFileSizeKB
Entier
Spécifie la taille maximale d’un fichier d’utilisation unique qui est appliqué à tous les fournisseurs d’utilisation. La valeur minimale est 512 kilo-octets (Ko) et la valeur maximale est 65 536 Ko.
UsageLogCutTime
Entier
Spécifie la durée, en minutes, des données d’utilisation recueillies par fichier journal d’utilisation. La durée par défaut est 5 minutes. La valeur doit être un entier compris entre 1 et 1 440.

Utilisez le tableau suivant pour les paramètres UsageDefinition.

Éléments des paramètres UsageDefinition

Nom Type de valeur Remarques
ID
GUID : Lecture seule
GUID au format 12345678-90ab-cdef-1234-567890bcdefgh.
Name
Chaîne : Lecture seule
Nom de chaîne de l’élément UsageDefinition.
DaysRetained
Entier
Spécifie le nombre de jours de rétention des données d’utilisation pour le fournisseur d’utilisation dans la base de données du service d’utilisation. La valeur par défaut est 14. Le type doit être un entier compris entre 0 et 31.
DaysToKeepUsageFiles
Entier
Spécifie le nombre de jours de rétention des fichiers d’utilisation. La valeur doit être inférieure ou égale à la valeur du paramètre DaysRetained.
Activé
Booléen
Active ou désactive le fournisseur d’utilisation spécifié.

Utilisez le tableau suivant pour les paramètres LogLevel.

Éléments des paramètres LogLevel

Nom Type de valeur Notes
Domaine
Chaîne : Lecture seule
Composant ou service auquel le paramètre LogLevel s’applique.
Identité
Chaîne : Lecture seule
Spécifie le nom de la catégorie ou de l’ensemble de catégories pour lesquels la limitation doit être définie, par exemple « Service de journalisation unifiée ».
Remarque :
Si le paramètre Identity n’est pas spécifié, le paramètre de limitation des événements est appliqué à toutes les catégories de la batterie.
EventSeverity
String:[None | ErrorCritical | Error | Warning | Information | Verbose]
Spécifie le niveau de catégorie à définir. Le niveau de catégorie est l’une des valeurs suivantes :[Aucune information d’avertissement d’erreur critique | | | | | détaillée]
TraceSeverity
String:[None | Unexpected | Monitorable | High | Medium | Verbose | VerboseX]
Spécifie la limitation de trace à définir pour la ou les catégories spécifiées. Les fichiers journaux de suivi sont des fichiers texte écrits dans le chemin du journal de suivi qui est défini dans la page Paramètres de journalisation des diagnostics du le site Web Administration centrale de SharePoint. Le type doit être l’une des valeurs suivantes ::[Aucun verboseX élevé moyennement | | | verboseX monitorable | | | inattendu]

Utilisez le tableau suivant pour les paramètres TimerJob.

Éléments des paramètres TimerJob

Nom Type de valeur Remarques
Identité
GUID : Lecture seule
Spécifie le travail de minuteur à mettre à jour. Le type doit correspondre à un GUID valide au format 12345678-90ab-cdef-1234-567890bcdefgh.
Planification
Chaîne
Spécifie la planification d’exécution du travail du minuteur. Le type doit être une des planifications de service Minuteur SharePoint (SPTimer) valides suivantes : Toutes les 5 minutes entre 0 et 59, toutes les heures entre 0 et 59, tous les jours à 15:00:00, toutes les semaines de vendredi 22:00:00 à dimanche 06:00:00, tous les 15 du mois à 15:00:00, ainsi que tous les ans le 1er janvier à 15:00:00.
Activé
Booléen
Active ou désactive le travail du minuteur.

Utilisez le tableau suivant pour les paramètres HealthAnalyzerRule.

Éléments des paramètres HealthAnalyzerRule

Nom Type de valeur Remarques
Identité
GUID : Lecture seule
Spécifie le nom ou le GUID de la règle d’analyseur d’intégrité à définir.
Enabled
Booléen
Active ou désactive la règle d’analyseur d’intégrité.

Créer des profils

Vous pouvez créer un nombre illimité de profils. Chaque profil peut être utilisé à des fins différentes, par exemple pour augmenter les niveaux d’analyse avant une modification spécifique de l’environnement ou pour les réduire après une modification.

Vous devez uniquement créer des entrées de profil pour les modifications spécifiques que vous souhaitez apporter. Les autres paramètres restent inchangés. Par exemple, si vous souhaitez modifier certains paramètres LogLevel, vous devez uniquement spécifier ces paramètres dans le profil. Les paramètres qui ne sont pas spécifiés dans le profil ne seront pas modifiés.

Il peut être utile d’employer une convention d’affectation de noms pour vos profils, afin de les organiser et d’en faciliter l’utilisation.

Important

Sauvegardez toujours les paramètres d’analyse avant de les modifier. Utilisez toujours une copie du profil de sauvegarde pour travailler, jamais le fichier original.

Voir aussi

Concepts

Configuration d'analyse par script dans SharePoint Server

Exécuter des scripts de configuration d'analyse dans SharePoint Server