Vue d'ensemble du contrôle d'état ASP.NET

Mise à jour : novembre 2007

Le contrôle d'état ASP.NET permet aux administrateurs système de surveiller l'état des applications Web déployées.

Remarque :
Une confiance moyenne ou élevée est requise pour déclencher un événement de contrôle d'état.

Cette rubrique contient les sections suivantes :

• Scénarios

• Fonctionnalités de contrôle d'état ASP.NET

• Contexte

• Exemples de code

• Référence de classe

Scénarios

Le contrôle d'état ASP.NET vous permet d'effectuer les tâches suivantes :

• contrôler les performances d'une application afin de vérifier son intégrité ;

• diagnostiquer rapidement les applications ou systèmes défaillants ;

• évaluer les événements significatifs survenant durant le cycle de vie d'une application ;

• Surveillez les applications ASP.NET dynamiques, individuellement ou dans une batterie de serveurs Web.

• consigner les événements qui ne sont pas nécessairement en rapport avec les erreurs observées dans une application ASP.NET.

Retour au début

Fonctionnalités

Le système de contrôle d'état ASP.NET inclut les éléments suivants :

• types d'événement qui assemblent les informations d'état de l'application ;

• types de fournisseur qui traitent les informations d'événement ;

• types supplémentaires facilitant la gestion des événements d'état.

Retour au début

Contexte

Le contrôle d'état ASP.NET fournit un moyen facile de contrôler l'état d'une application ASP.NET et d'obtenir des informations d'exécution détaillées sur les ressources ASP.NET (pour instrumenter l'application). Le contrôle d'état contient des classes d'événements de contrôle d'état Web directement utilisables (événements Web) et des fournisseurs de contrôle d'état (écouteurs). Les événements Web assemblent les informations sur les événements d'état.

Les fournisseurs écoutent les événements et utilisent les informations relatives à ces événements, généralement en les enregistrant dans un journal ou en avertissant un administrateur. Vous connectez un événement Web à un fournisseur (c'est-à-dire, vous activez l'événement) en configurant des paramètres dans le fichier de configuration de l'application.

Le système de contrôle d'état ASP.NET est implémenté à l'aide des classes contenues dans l'espace de noms System.Web.Management.

Configuration du contrôle d'état ASP.NET

Vous pouvez configurer des applications pour utiliser des fournisseurs de contrôle intégrés ou personnalisés qui traitent des informations de contrôle d'état, et signalent l'état et les caractéristiques de performance de l'application instrumentée.

Vous ajoutez des événements Web et des fournisseurs à une application en configurant la section healthMonitoring du fichier de configuration. Vous utilisez ensuite des classes intégrées ou personnalisées pour écouter les données d'événement et les traiter.

Pour plus d'informations sur les fichiers de configuration, consultez Fichiers de configuration ASP.NET.

Hiérarchie de classes d'événement Web

Lorsqu'un événement Web est déclenché, une instance de la classe d'événements associée est créée. Les données d'événement sont recueillies dans les propriétés de cet objet. Les fournisseurs d'événements traitent ces données.

Les événements Web peuvent contenir des informations sur le processus de traitement, le domaine d'application, les données de demande, les données de réponse, les erreurs d'application, les erreurs de configuration et les événements d'audit. Les informations d'état qui sont contenues dans une classe d'événements parent sont héritées par toutes les classes d'événements enfants.

Les relations entre les classes d'événements Web sont représentées dans l'illustration suivante.

Hiérarchie de classe d'événements Web

Plus un événement est situé au bas de la hiérarchie de classes d'événements Web, plus les données sont spécifiques à l'application ASP.NET. Par exemple, les classes dérivées peuvent exposer des informations telles que les traces des piles, les IP clients et les informations sur le thread et sur le traitement.

Informations sur l'événement Web

Le tableau suivant répertorie des informations qui vous aident à déterminer la classe d'événement Web à utiliser ou de laquelle hériter. Les lignes font référence aux classes d'événements Web. Les colonnes font référence aux classes d'informations, qui sont habituellement disponibles en tant que propriétés dans les classes d'événements Web.

Si votre application ne s'exécute pas en confiance totale, seule la classe WebBaseEvent peut être héritée. Cela contribue à la protection contre l'exposition d'informations sensibles par le biais des classes d'informations répertoriées dans le tableau.

Hiérarchie de classes de fournisseur

ASP.NET inclut les fournisseurs intégrés que vous pouvez utiliser pour traiter les événements Web. Vous pouvez également hériter des classes intégrées pour créer un fournisseur personnalisé, conformément aux limitations suivantes s'appliquant à l'héritage :

• La classe WebEventProvider peut être héritée par les applications qui s'exécutent à tout niveau de confiance.

• La classe BufferedWebEventProvider peut être héritée par les applications qui s'exécutent à tout niveau de confiance.

• La classe SqlWebEventProvider peut être héritée uniquement par les applications qui s'exécutent à un niveau de confiance totale.

Les autres classes ne peuvent pas être héritées par les applications, indépendamment du niveau de confiance. Pour plus d'informations, consultez les vues d'ensemble des classes pour les classes de fournisseur individuelles.

L'illustration suivante représente les relations entre les classes de fournisseur Web de l'espace de noms System.Web.Management :

Hiérarchie des classes de fournisseur Web

Utilisation des événements de contrôle d'état ASP.NET

Vous pouvez utiliser les événements de contrôle d'état ASP.NET de l'une des manières suivantes :

• Utiliser l'événement Web et les classes de fournisseur intégrés. Généralement, vous n'avez à fournir d'implémentation personnalisée d'aucune classe d'événements Web ASP.NET. Notez que votre application ne déclenche pas ces événements et que c'est le .NET Framework qui les déclenche. Toutefois, vous devez les configurer comme expliqué ultérieurement dans cette rubrique. Pour plus d'informations, consultez Comment : envoyer un message électronique pour les notifications de contrôle d'état.

• Créez des classes personnalisées pour les événements ou les fournisseurs Web. Vous créez généralement des événements Web personnalisés si vous devez ajouter des informations personnalisées à celles déjà fournies par les événements Web intégrés. Vous créez généralement des fournisseurs personnalisés si vous souhaitez fournir les données d'événement via un mécanisme non proposé par les fournisseurs intégrés. Pour plus d'informations, consultez Extension des événements de contrôle d'état ASP.NET.

Utilisation des fournisseurs et événements Web intégrés

L'utilisation des événements et des fournisseurs Web intégrés pour le contrôle d'état est la stratégie la plus courante. Elle requiert uniquement que vous configuriez l'application pour utiliser les événements et les fournisseurs dont vous avez besoin. Vous devez effectuer les opérations suivantes :

• ajouter la classe d'événements Web ASP.NET Web intégrée dont vous avez besoin à l'élément eventMappings de la section healthMonitoring du fichier de configuration de l'application ;

• Ajouter le fournisseur qui consomme l'événement à l'élément providers de la section healthMonitoring.

• Ajoutez un élément à l'élément rules qui définit l'association entre l'événement et le fournisseur.

Par défaut, les classes de contrôle d'état ASP.NET intégrées sont configurées dans la section healthMonitoring du fichier racine Web.config. La section healthMonitoring établit la configuration par défaut suivante :

• Toutes les classes d'événements Web qui dérivent de WebBaseEvent sont spécifiées dans l'élément eventMappings. Cette section est utilisée pour assigner un nom convivial à un groupe de classes d'événements.

• Toutes les classes d'événements qui dérivent de WebBaseEvent sont incluses dans l'un au moins des groupes définis dans l'élément eventMappings.

Les fournisseurs d'événements EventLogWebEventProvider, WmiWebEventProvider et SqlWebEventProvider sont spécifiés dans l'élément providers. Vous pouvez spécifier d'autres fournisseurs intégrés dans l'élément providers, tels que les classes SimpleMailWebEventProvider, TemplatedMailWebEventProvider ou TraceWebEventProvider.

Les règles qui associent les événements d'erreur Web et d'échec de l'audit aux classes EventLogWebEventProvider sont spécifiées dans l'élément rules. Vous pouvez activer d'autres fournisseurs et événements Web en ajoutant d'autres éléments rules. Un événement est activé s'il est mappé à un fournisseur d'événements dans l'élément rules. Les éléments eventMappings et providers doivent être configurés pour l'événement, mais si les deux éléments ne sont pas connectés dans l'élément rules , l'événement n'est pas activé.

Vous pouvez spécifier des valeurs de paramètre pour les éléments configurés. Les exemples incluent des paramètres qui limitent le nombre des événements pouvant se produire, spécifient l'intervalle entre deux événements ou définissent des options de mise en mémoire tampon des événements pour les fournisseurs SQL et les fournisseurs de messagerie.

Configuration d'un fournisseur personnalisé

Si le traitement personnalisé des informations d'événements Web est requis, vous pouvez générer un fournisseur d'événements d'état personnalisé. Votre fournisseur est une classe qui hérite de la classe WebEventProvider ou BufferedWebEventProvider. Pour obtenir un exemple, consultez Comment : implémenter l'exemple de fournisseur personnalisé de contrôle d'état. La création d'un fournisseur personnalisé est le moyen le plus couramment utilisé pour personnaliser le contrôle d'état. Pour cela, vous devez modifier le fichier de configuration de l'une des manières suivantes :

• Ajoutez le fournisseur personnalisé qui traite l'événement à l'élément providers de la section healthMonitoring du fichier de configuration.

• Ajoutez un élément à l'élément rules qui définit l'association entre l'événement et le fournisseur.

• Placez l'assembly qui contient l'implémentation du fournisseur personnalisé dans le sous-répertoire Bin de l'application. Vous ne pouvez pas placer le fichier de code source du fournisseur dans le sous-répertoire App_Code, parce que le système de contrôle d'état est configuré et créé avant que les fichiers de code du sous-répertoire App_Code ne soient compilés.

L'attribut type de l'élément providers requiert au moins le nom de la classe. Si l'assembly ne se trouve pas dans le répertoire Bin de l'application, il doit porter un nom fort et être installé dans le Global Assembly Cache. Dans ce cas, l'attribut type de l'élément providers requiert le nom fort complet, comme illustré dans l'exemple de code suivant, où les valeurs Version et PublicKeyToken correspondent à votre assembly :

type="Microsoft.Samples.Web.Management.SampleCustomEventProvider, Sample.SampleCustomEventProvider,Version=n.n.n.n,Culture=neutral, PublicKeyToken=xxxx"

L'exemple suivant indique comment associer le fournisseur SampleCustomEventProvider à l'événement WebHeartbeatEvent. L'événement Heartbeats est déjà configuré dans le fichier Web.config racine.

<healthMonitoring 
  heartBeatInterval="1" 
  enabled="true">
  <rules>
    <add 
      name="Heartbeat Events" 
      eventName="Heartbeats" 
      provider="Sample Custom Event Provider"
      profile="Default" 
      minInstances="1" 
      maxLimit="Infinite" 
      minInterval="00:01:00"
      custom="" 
    />
  </rules>
  <providers>
    <add 
      name="Sample Custom Event Provider" 
      type="Microsoft.Samples.Web.Management.SampleCustomEventProvider, Sample.SampleCustomEventProvider,Version=1.0.0.0,Culture=neutral, PublicKeyToken=xxxxxxxxxxxx" 
    />
  </providers>
</healthMonitoring>

Configuration d'un événement personnalisé

Si vous exigez des informations d'événement d'état personnalisées, vous pouvez générer un événement d'état personnalisé. Pour obtenir un exemple, consultez Comment : implémenter et déclencher des événements de contrôle d'état ASP.NET personnalisés. La création d'un événement Web personnalisé est moins courante que celle d'un fournisseur personnalisé. Pour cela, vous devez modifier le fichier de configuration. Vous devez également déclencher explicitement l'événement personnalisé à l'heure appropriée.

Pour configurer l'événement, vous devez procéder comme suit :

• Ajoutez la classe d'événements d'état personnalisée à l'élément eventMappings de la section healthMonitoring.

• Ajoutez un élément rules qui définit l'association entre l'événement et le fournisseur.

• Ajoutez l'assembly qui contient l'implémentation d'événement Web personnalisée au sous-répertoire Bin de l'application ASP.NET. Vous pouvez également ajouter le fichier du code source de l'événement au sous-répertoire App_Code.

Si vous utilisez un assembly, l'attribut type de l'élément eventMappings requiert au moins le nom de classe et le nom de fichier de l'assembly, comme illustré dans l'exemple suivant :

type="System.Web.Management.SampleCustomWebEvent, Sample.SampleCustomWebEvent"

Si vous utilisez un fichier de code source, vous devez spécifier uniquement le nom de la classe.

L'exemple suivant illustre comment associer le fournisseur d'événements EventLogWebEventProvider à un événement personnalisé nommé SampleCustomWebEvent. Le fournisseur d'événements EventLogProvider est déjà configuré dans le fichier racine Web.config.

<healthMonitoring 
  heartBeatInterval="0" 
  enabled="true">
  <rules>
    <add 
      name="Sample Custom Events" 
      eventName="SampleCustomWebEvent" 
      provider="EventLogProvider"
      profile="Default" 
      minInstances="1" 
      maxLimit="Infinite" 
      minInterval="00:01:00"
      custom="" 
    />
  </rules>
  <eventMappings>
    <add 
      name="SampleCustomWebEvent" 
      type="System.Web.Management.SampleCustomWebEvent, Sample.SampleCustomWebEvent,Version=1.0.0.0,Culture=neutral, PublicKeyToken=xxxxxxxxxxxx" "
      startEventCode="0" 
      endEventCode="2147483647" 
    />
  </eventMappings>
</healthMonitoring>

Sécurisation du contrôle d'état ASP.NET

La fonction de contrôle d'état est activée par défaut pour les applications ASP.NET. Vous pouvez la désactiver en affectant à l'attribut enabled de l'élément healthMonitoring la valeur false. Les paramètres de configuration par défaut ont les valeurs les plus sécurisées disponibles. Pour plus d'informations sur les paramètres de configuration du contrôle d'état, consultez healthMonitoring. Vous pouvez verrouiller les paramètres de configuration du contrôle d'état à l'aide de l'élément location.

Remarque :
Lorsque vous implémentez des consommateurs d'événements personnalisés ou des fournisseurs d'événements personnalisés, vous devez coder ou vérifier le contenu des événement pour éviter les problèmes liés aux scripts entre sites.

Sécurisation de valeurs de configuration

Lorsque vous stockez des informations sensibles dans un fichier de configuration pour une application, il est conseillé de chiffrer les valeurs sensibles à l'aide de la configuration protégée. Parmi les informations particulièrement sensibles, citons les clés de chiffrement stockées dans l'élément de configuration machineKey et les chaînes de connexion à une source de données stockées dans l'élément de configuration connectionStrings. Pour plus d'informations, consultez Chiffrement des informations de configuration à l'aide de la configuration protégée.

La section de configuration healthMonitoring est accessible uniquement par un code qui utilise un niveau de confiance moyen ou supérieur, empêchant les applications de confiance basse d'enregistrer des types personnalisés.

Sécurité pour l'extension du contrôle d'état

Les types de contrôles d'état de l'espace de noms System.Web.Management possèdent les caractéristiques suivantes :

• Les constructeurs de classe de base sont marqués comme protectedinternal. Par conséquent, les instances de types d'événement de classe de base ne peuvent pas être créées directement par le code utilisateur.

• L'accès aux instances d'événements Web est limité aux fournisseurs spécifiés par configuration, aux filtres et aux pages modèle.

• Les demandes de liaison d'héritage sur les événements avec contenu protégé garantissent que seuls les événements personnalisés d'un niveau de confiance suffisant peuvent être dérivés.

• Les événements de confiance personnalisés qui exposent des données sensibles à partir de propriétés d'événements protégés doivent appliquer la sécurité d'accès du code eux-mêmes pour éviter des attaques malveillantes. Pour plus d'informations sur la sécurité d'accès du code, consultez Sécurité d'accès du code ASP.NET ou Notions fondamentales de la sécurité d'accès du code.

• Les types WMI (Windows Management Instrumentation) qui sont utilisés pour consulter des événements Web sont verrouillés pour empêcher les utilisateurs d'accéder aux données d'événement.

  Remarque :
  Lorsque vous implémentez des consommateurs d'événements personnalisés ou des fournisseurs d'événements personnalisés, vous devez coder ou vérifier le contenu des événement pour éviter les problèmes liés aux scripts entre sites.

Sécurisation des connexions aux sources de données

Vous pouvez créer des fournisseurs d'événements de contrôle d'état personnalisés pour enregistrer les données d'événement dans une base de données. ASP.NET inclut un fournisseur SQL. Pour plus d'informations sur la consignation des données d'événement, consultez Sécurisation de l'accès aux données.

Pour une meilleure sécurisation de la connexion au serveur de base de données, il est recommandé de chiffrer les informations de la chaîne de connexion dans le fichier de configuration à l'aide de la configuration protégée. Pour plus d'informations, consultez Chiffrement des informations de configuration à l'aide de la configuration protégée.

Lorsque vous utilisez un fournisseur SQL, vous devez sécuriser convenablement la base de données en utilisant l'authentification. Les fichiers Microsoft SQL Server Express Edition doivent être sécurisés à l'aide de listes de contrôle d'accès (ACL) et de l'authentification SQL.

Remarque :
SQL Server Express Edition ne doit pas être exécuté sous un compte non privilégié lorsque vous enregistrez des événements dans une base de données.

Sécurisation contre les attaques par déni de service

Les événements Web peuvent être déclenchés par une requête HTTP ou par un code d'application qui génère des exceptions ou des événements. Un volume élevé d'événements ou des événements volumineux peuvent entraîner un dépassement de la capacité du fournisseur d'événements. Dans ce cas, l'application ou le serveur ASP.NET peut être submergé, ce qui peut affecter l'utilisation de la mémoire, l'espace disque et le trafic réseau.

Pour limiter l'exposition d'une application à une attaque par déni de service, par défaut, ASP.NET utilise la conception suivante :

• ASP.NET mesure une instance d'un événement par minute. Cette fréquence de limitation de requêtes est configurée dans l'élément profiles et elle est associée aux événements et aux fournisseurs dans l'élément rules.

• La mise en mémoire tampon d'événement est isolée pour chaque type de fournisseur afin d'empêcher la concurrence relative à l'espace de mémoire tampon. Les paramètres de mémoire tampon sont configurés dans l'élément bufferModes. Les fournisseurs peuvent être configurés pour utiliser un jeu spécifique de paramètres de mémoire tampon en spécifiant l'élément bufferModes qui contient les paramètres appropriés.

• Pour déclencher un événement personnalisé, un niveau de confiance moyen ou supérieur est requis.

En tant qu'administrateur système, vous pouvez configurer les paramètres de limitation et de mémoire tampon pour éviter tout dépassement de capacité, en particulier pour les événements qui peuvent être déclenchés par des requêtes HTTP. En outre, vous pouvez définir des modes de mémoire tampon séparés pour prendre en charge les événements importants et insignifiants.

Sécurité pour les messages d'erreur et les événements

Pour empêcher que des informations sensibles ne soient exposées à des sources non autorisées, configurez votre application pour ne pas afficher des messages d'erreur détaillés. Vous pouvez également configurer l'application pour afficher des messages d'erreur détaillés uniquement lorsque le client est le serveur Web lui-même. Pour plus d'informations, consultez customErrors.

Par défaut, ASP.NET enregistre les événements Web par demande, exceptionnels et à volume élevé dans le système d'analyse des performances. Dans la configuration par défaut, cela signifie que les tentatives de session non réussies enregistrent les noms d'utilisateur et les autres informations de diagnostic dans le journal des événements Application. Ces données peuvent être affichées dans l'observateur d'événements Windows. Si le serveur exécute l'un des produits Microsoft Windows Server, vous pouvez améliorer la sécurité de l'application en sécurisant le journal des événements. Vous pouvez également définir des paramètres pour spécifier la taille, la durée de conservation et d'autres caractéristiques du journal des événements pour éviter toute attaque par déni de service indirecte.

Verrouillage de la configuration du contrôle d'état ASP.NET

Dans les scénarios d'hébergement d'applications, vous souhaitez souvent verrouiller certains paramètres d'un site pour empêcher la modification. Par exemple, vous pouvez verrouiller les paramètres de contrôle d'état des applications hébergées pour réduire le risque de modifications accidentelles de la configuration de l'application Web.

Vous pouvez verrouiller les paramètres de configuration en ajoutant un attribut allowOverride="false" à une balise <location>. Ainsi, le système de configuration génère une erreur si un fichier de configuration d'un niveau inférieur dans la hiérarchie tente de substituer une section de configuration définie dans l'élément location.

Le fichier de configuration d'exemple suivant indique comment verrouiller la section healthMonitoring d'une application ASP.NET nommée application1. Les paramètres pourraient être stockés au niveau serveur (dans le fichier machine.config) ou au niveau du site.

<configuration>
  <location path="application1" allowOverride="false">
    <system.web>
      <healthMonitoring
        enabled="true"
        heartBeatInterval="60">
        <bufferModes>
          <add name="Logging"
            maxBufferSize="1000"
            maxFlushSize="200"
            urgentFlushThreshold="800"
            regularFlushInterval="00:30:00"
            urgentFlushInterval="00:05:00"
            maxBufferThreads="1"
          />
        </bufferModes>
        <providers>
           <add name="EventLogProvider"
            type="System.Web.Management.EventLogWebEventProvider, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"
            buffer="true"
            bufferMode="Logging"
          />
        </providers>
        <eventMappings>
          <add name="All Errors"
            type="System.Web.Management.WebBaseErrorEvent, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%" 
          />
        </eventMappings>
        <profiles>
          <add name="Default"
            minInstances="1"
            maxLimit="Infinite"
            minInterval="00:10:00"
          />
        </profiles>
        <rules>
          <add name="All Errors Default"
            eventName="All Errors"
            provider="EventLogProvider"
            profile="Default"
            minInterval="00:01:00" 
          />
        </rules>
      </healthMonitoring>
    </system.web>
  </location>
</configuration>

Vous pouvez verrouiller les éléments avec plus de granularité en utilisant des attributs supplémentaires tels que lockItem, lockAttributes et lockElements. Pour plus d'informations, consultez Attributs généraux hérités par les éléments Section.

Retour au début

Exemples de code

Comment : implémenter et déclencher des événements de contrôle d'état ASP.NET personnalisés

Comment : implémenter l'exemple de fournisseur personnalisé de contrôle d'état

Comment : envoyer un message électronique pour les notifications de contrôle d'état.

Procédure pas à pas : écoute des événements WMI lors du contrôle d'état ASP.NET

Retour au début

Référence de classe

• System.Web.Management
  Espace de noms qui contient des types de gestion et de contrôle de l'état d'applications Web.

• System.Management
  Espace de noms qui contient des types de connexion à l'infrastructure WMI (Windows Management Instrumentation).

• System.Management.Instrumentation
  Espace de noms qui contient des types pour instrumenter des applications pour les consommateurs potentiels de WMI.

• HealthMonitoringSection
  Type qui obtient ou définit par programme les attributs de la configuration healthMonitoring.

Retour au début

Voir aussi

Tâches

Comment : verrouiller des paramètres de configuration ASP.NET

Concepts

Extension des événements de contrôle d'état ASP.NET

Vue d'ensemble de la configuration ASP.NET

Référence

bufferModes, élément de healthMonitoring (Schéma des paramètres ASP.NET)

providers, élément de healthMonitoring (Schéma des paramètres ASP.NET)