Variables d'environnement local

Vous pouvez changer le comportement de agent Microsoft SQL Server en définissant les variables d'environnement local.

Variables de vérification de disponibilité du service SQL Server

Pour vérifier la disponibilité du service SQL Server, ajoutez les variables d'environnement suivantes :
  • COLL_MSSQL_RETRY_INTERVAL : cette variable définit l'intervalle entre deux tentatives (en minutes) de vérification du statut du service SQL Server. Si la valeur est inférieure ou égale à zéro, la variable utilise la valeur par défaut 1 minute.
  • COLL_MSSQL_RETRY_CNT : cette variable définit le nombre de tentatives de l'agent SQL pour vérifier que le service SQL Server est démarré. Si le service SQL Server n'est pas démarré après le nombre de tentatives spécifié dans cette variable, le collecteur s'arrête. Si la valeur de la variable est inférieure ou égale à zéro, la variable utilise la valeur par défaut 3.

Variables de surveillance du fichier journal des événements SQL Server

Pour surveiller l'ensemble de données MS SQL Error Event Details, utilisez les variables d'environnement suivantes :
  • COLL_ERRORLOG_STARTUP_MAX_TIME : cette variable définit l'intervalle de temps (T) de la collecte des erreurs avant le démarrage de l'agent. La valeur par défaut est 0 minutes. Cette variable peut avoir les valeurs suivantes :
    T = 0
    L'agent démarre la surveillance du fichier journal des erreurs lorsqu'il démarre ou redémarre. L'agent ne lit pas les erreurs consignées dans le fichier journal des erreurs avant son démarrage.
    T = 1
    L'agent surveille le fichier journal des erreurs en fonction des valeurs suivantes définies pour la variable COLL_ERRORLOG_STARTUP_MAX_EVENT_ROW représentée par R :
    • Si R < 0, l'agent démarre la surveillance du fichier journal des erreurs lorsqu'il démarre ou redémarre.
    • Si R = 1, l'agent surveille toutes les erreurs consignées dans le fichier journal des erreurs.
    • Si R > 1 et que l'agent est installé pour la première fois, l'agent surveille le fichier journal jusqu'à ce que R erreurs soient surveillées. Si R > 1 et que l'agent est redémarré, l'agent surveille les R erreurs précédemment non prises en compte.
    T > 1
    L'agent surveille toutes les erreurs précédentes consignées jusqu'au nombre de minutes T à partir de son démarrage ou redémarrage. L'agent qui surveille dépend également des valeurs suivantes que vous définissez pour la variable COLL_ERRORLOG_STARTUP_MAX_EVENT_ROW :
    • Si R ≤ 0, l'agent démarre la surveillance du fichier journal des erreurs lorsqu'il démarre ou redémarre.
    • Si R = 1, l'agent surveille toutes les erreurs consignées dans le fichier journal jusqu'à T minutes.
    • Si R > 1, l'agent ne surveille pas plus de R erreurs consignées au cours des T dernières minutes.
  • COLL_ERRORLOG_STARTUP_MAX_EVENT_ROW : cette variable définit le nombre maximum d'erreurs devant être traitées au démarrage de l'agent. La valeur par défaut est 0. Vous pouvez affecter les valeurs suivantes à la variable :
    R = 0
    L'agent démarre la surveillance du fichier journal des erreurs, dès qu'il démarre ou qu'il redémarre. Il ne lit pas les erreurs qui ont été créées dans le fichier journal des erreurs avant son démarrage.
    R = 1
    L'agent surveille les erreurs consignées au cours des T dernières minutes depuis son démarrage ou redémarrage.
    R > 1
    L'agent surveille les erreurs R consignée au cours des T dernières minutes.
  • COLL_ERRORLOG_MAX_EVENT_ROW : cette variable fournit le nombre de lignes d'erreur. La valeur par défaut est 50. Vous pouvez affecter les valeurs suivantes à la variable :
    X = 0
    L'agent n'affiche pas les journaux d'erreur.
    X > 0
    L'agent affiche x lignes d'erreur.
  • COLL_ERRORLOG_RECYCLE_WAIT : cette variable indique l'intervalle de temps (en secondes) pendant lequel l'agent Microsoft SQL Server attend de collecter les données du groupe d'attributs MS SQL Error Event Detail lorsque la situation de ce groupe d'attributs est déclenchée. Attribuez une valeur comprise entre 1 et 30 à cette variable. Si sa valeur est inférieure à 0, la variable utilise la valeur par défaut 0 (seconde). Si sa valeur est supérieure à 30, la variable utilise la valeur par défaut 30 (secondes).

Variable de définition du délai d'expiration de la requête

Pour définir l'intervalle du délai d'attente de requête pour l'agent SQL Server, utilisez les variables d'environnement suivantes :
  • QUERY_TIMEOUT : cette variable d'environnement définit le délai maximum (en secondes) pendant lequel SQL Server attend une réponse pour une requête envoyée à SQL Server. La valeur par défaut de cette variable doit être inférieure à 45 secondes. Cependant, si vous définissez la valeur 0 pour cette variable, l'agent SQL Server attend indéfiniment une réponse de SQL Server. Si l'agent SQL Server accède à un grand nombre de bases de données verrouillées, vous devez affecter à cette variable une valeur comprise entre 10 et 20 secondes. Si la requête n'est pas traitée pendant le délai défini, l'agent SQL Server ignore la requête expiré et passe à la requête suivante dans la file d'attente. L'agent n'affiche pas de données pour la requête qui a expiré.
  • QUERY_THREAD_TIMEOUT : cette variable d'environnement définit le délai maximum (en secondes) pendant lequel SQL Server attend une réponse pour une requête envoyée à SQL Server. Cette variable d'environnement est applicable à quelques groupes d'attributs qui utilisent la collecte basée sur les unités d'exécution. Par exemple, KOQDBD, KOQTBLD, KOQDEVD, etc. La valeur de cette variable n'a aucune limite, contrairement à la variable QUERY_TIMEOUT. Sinon, elle fonctionne de la même manière que la variable QUERY_TIMEOUT.

Variable d'affichage des informations sur les travaux activés

Pour afficher les informations relatives aux travaux activé dans l'ensemble de données MS SQL Job Detail, utilisez la variable d'environnement COLL_JOB_DISABLED. Si vous affectez à cette variable la valeur 1, agent Microsoft SQL Server n'affiche pas les informations relatives aux travaux activés. Si vous ne spécifiez pas cette variable, vous pouvez afficher les informations relatives aux travaux activés et désactivés.

Variable permettant de limiter le nombre de lignes dans l'ensemble de données Détail des groupes de fichiers MS SQL

Pour limiter le nombre de lignes extraites par le service de collecteur pour l'ensemble de données Détail des groupes de fichiers MS SQL, utilisez la variable d'environnement COLL_KOQFGRPD_MAX_ROW. Cette variable d'environnement définit le nombre maximal de lignes que le service de collecteur extrait pour l'ensemble de données Détail des groupes de fichiers. Si vous n'indiquez pas de valeur pour cette variable, le service de collecteur extrait 10000 lignes pour l'ensemble de données Détail des groupes de fichiers. Utilisez cette variable d'environnement pour modifier le nombre maximal de lignes par défaut dans le fichier koqcoll.ctl. Pour modifier le nombre maximal de lignes par défaut, procédez comme suit :
  1. Indiquez le nombre maximal de lignes pour KOQFGRPD dans le fichier koqcoll.ctl.
  2. Ajoutez la variable d'environnement COLL_KOQFGRPD_MAX_ROW et assurez-vous que la valeur de cette variable est identique à la valeur indiquée dans le fichier koqcoll.ctl.

Si la valeur du fichier koqcoll.ctl est inférieure à la valeur indiquée par la variable d'environnement COLL_KOQFGRPD_MAX_ROW, la valeur définie dans le fichier koqcoll.ctl est considérée comme la valeur représentant le nombre maximal de lignes.

Si la valeur du fichier koqcoll.ctl est supérieure à la valeur indiquée dans la variable d'environnement COLL_KOQFGRPD_MAX_ROW, la valeur de la variable d'environnement COLL_KOQFGRPD_MAX_ROW est considérée comme la valeur représentant le nombre maximal de lignes.

Variables d'optimisation de la collecte de l'ensemble de données Détail des groupes de fichiers MS SQL

Utilisez la variable COLL_DBD_FRENAME_RETRY_CNT pour indiquer le nombre de tentatives qui peuvent être effectuées pour déplacer le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__FGRP_TEMP vers le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__FGRP_PREV.

Si vous n'indiquez pas de valeur pour cette variable, l'agent Microsoft SQL Server fait trois tentatives de déplacement du fichier.

Variable permettant de limiter le nombre de lignes dans l'ensemble de données MS SQL Device Detail

Pour limiter le nombre de lignes extraites pour le service de collecteur de l'ensemble de données MS SQL Device Detail, utilisez la variable d'environnement COLL_KOQDEVD_MAX_ROW. Cette variable d'environnement définit le nombre maximal de lignes que le service de collecteur extrait pour l'ensemble de données Device Detail. Si vous n'indiquez pas de valeur pour cette variable, le service de collecteur extrait 10000 lignes pour l'ensemble de données Device Detail. Utilisez cette variable d'environnement pour modifier le nombre maximal de lignes par défaut dans le fichier koqcoll.ctl. Pour modifier le nombre maximal de lignes par défaut, procédez comme suit :
  1. Indiquez le nombre maximal de lignes pour KOQDEVD dans le fichier koqcoll.ctl.
  2. Ajoutez la variable d'environnement COLL_KOQDEVD_MAX_ROW et vérifiez que la valeur de cette variable est identique à celle indiquée dans le fichier koqcoll.ctl.

Si la valeur du fichier koqcoll.ctl est inférieure à la valeur indiquée par la variable d'environnement COLL_KOQDEVD_MAX_ROW, la valeur définie dans le fichier koqcoll.ctl est considérée comme la valeur représentant le nombre maximal de lignes.

Si la valeur du fichier koqcoll.ctl est supérieure à la valeur définie dans la variable d'environnement COLL_KOQDEVD_MAX_ROW, la valeur de la variable d'environnement COLL_KOQDEVD_MAX_ROW est considérée comme la valeur représentant le nombre maximal de lignes.

Variables d'optimisation de la collecte pour l'ensemble de données MS SQL Device Detail

Pour optimiser la collecte de l'ensemble de données MS SQL Device Detail, utilisez les variables d'environnement suivantes :
  • COLL_KOQDEVD_INTERVAL : cette variable d'environnement permet d'indiquer un intervalle (en minutes) entre deux collectes consécutives de l'ensemble de données MS SQL Device Detail.
    Remarque : Par défaut, la collecte des données de l'ensemble de données Device Detail est lancée sur demande. Utilisez la variable COLL_KOQDEVD_INTERVAL pour démarrer une collecte basée sur des unités d'exécution pour l'ensemble de données Device Detail et définir l'intervalle entre deux collectes de ce type.
  • COLL_DBD_FRENAME_RETRY_CNT : utilisez cette variable d'environnement pour indiquer le nombre de tentatives qui peuvent être effectuées pour déplacer le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__DEVD_TEMP vers le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__DEVD_PREV.
Si vous n'indiquez pas de valeur pour cette variable, l'agent Microsoft SQL Server fait une tentative de déplacement du fichier.

Variables d'optimisation de la collecte de l'ensemble de données MS SQL Database Detail

Pour optimiser la collecte de l'ensemble de données MS SQL Database Detail, utilisez les variables d'environnement suivantes :
  • COLL_KOQDBD_INTERVAL : utilisez cette variable d'environnement pour indiquer un intervalle (en minutes) entre deux collectes basées sur une unité d'exécution consécutives de l'ensemble de données MS SQL Database Detail. Si vous n'indiquez pas de valeur pour cette variable ou si l'intervalle de temps spécifié est inférieur à 3 minutes, l'agent Microsoft SQL Server définit l'intervalle par défaut sur 3 minutes. Au cas où la collecte prend plus de temps, ou que les données sont fréquemment vues comme NOT_COLLECTED, vous pouvez vérifier la durée de la collecte en vous référant au journal Database Detail Collection completed in %d seconds et définir la valeur de la variable sur une valeur supérieure à la durée de collecte spécifiée dans le journal.
  • COLL_DBD_FRENAME_RETRY_CNT : utilisez cette variable d'environnement pour indiquer le nombre de tentatives qui peuvent être effectuées pour déplacer le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__DBD_TEMP vers le fichier %COLL_HOME%_tmp_%COLL_VERSION%_%COLL_SERVERID%_%COLL_SERVERID%__DBD_PREV.
Si vous n'indiquez pas de valeur pour cette variable, l'agent Microsoft SQL Server fait une tentative de déplacement du fichier.

Variables d'optimisation de la collecte de l'ensemble de données MS SQL Database Details

Pour améliorer la collecte de l'ensemble de données MS SQL Database Details, utilisez les variables d'environnement suivantes :
  • COLL_AUDIT_TYPE : utilisez cette variable pour activer ou désactiver la surveillance de journaux spécifiques. La valeur par défaut de la variable est [AL][FL][SL]. Par défaut, l'agent surveille les trois types de journaux qui comprennent les journaux d'application, les fichiers de contrôle et les journaux de sécurité. La valeur de la variable inclut un code de deux caractères pour chaque type de journal :
    • [AL] pour les journaux d'application
    • [FL] pour les fichiers de contrôle
    • [SL] pour les journaux de sécurité
    Vous pouvez modifier la valeur de la variable afin de désactiver la surveillance du type de journal spécifique. Par exemple, si vous indiquez [AL][SL] comme valeur de la variable, les fichiers de contrôle ne sont pas surveillés. Si aucune valeur n'est associée à la variable, les détails de l'audit ne sont pas surveillés.
  • COLL_AUDIT_DURATION : utilisez cette variable pour signaler les événements d'audit qui se sont produits lors de l'intervalle indiqué dans cette variable. Par exemple, si vous attribuez la valeur 7 à cette variable, les événements d'audit qui se sont produits au cours des sept dernières heures sont signalés par l'ensemble de données Détails de l'audit. La valeur par défaut de la variable COLL_AUDIT_DURATION est 24 heures.
  • COLL_AUDIT_COLLECTION_INTERVAL : la collecte basée sur les unités d'exécution de l'ensemble de données Détails de l'audit fournit les spécifications de toutes les bases de données incluses dans l'instance SQL Server. Utilisez cette variable pour définir l'intervalle de cette collecte basée sur des unités d'exécution. Par exemple, si vous attribuez la valeur 7 à cette variable, un nouvel ensemble de spécifications de base de données est extrait de l'instance SQL Server toutes les 7 heures. La valeur par défaut de la variable COLL_AUDIT_COLLECTION_INTERVAL est 24.

Variable d'optimisation de la collecte pour l'ensemble de données MS SQL Process Detail

Pour améliorer la collecte de l'ensemble de données MS SQL Process Detail, utilisez la variable COLL_PROC_BLOCK_INTERVAL avec les valeurs suivantes :
  • Si COLL_PROC_BLOCK_INTERVAL = 0, la collecte pour les attributs Durée du processus de blocage et Durée de ressource de blocage est désactivée.
  • Si COLL_PROC_BLOCK_INTERVAL = x, l'intervalle entre les deux collectes de données consécutives pour les attributs Durée du processus de blocage et Durée de ressource de blocage est x minutes.
Si la variable COLL_PROC_BLOCK_INTERVAL n'est pas définie dans le répertoire CANDLE_HOME, l'intervalle entre les collectes de données consécutives est trois minutes.

Variable permettant l'exclusion d'objets verrouillés de la collecte de données

Si les requêtes envoyées pour les espaces de travail Détails de base de données, Détails des groupes de fichiers, Fonction miroir de la base de données et Détails des unités mettent du temps à s'exécuter, utilisez la variable COLL_DBCC_NO_LOCK pour exécuter une requête avec la valeur WITH (NOLOCK). Cette variable permet à la requête de ne pas attendre dans la file d'attente lorsqu'un objet sur lequel elle s'exécute est verrouillé.

Variable permettant de définir les critères de recherche des lignes renvoyées par l'ensemble de données Détails de la table

Les lignes renvoyées par l'ensemble de données Détails de la table sont triées par ordre décroissant en fonction de la valeur définie pour la variable COLL_TBLD_SORTBY. La valeur par défaut de la variable COLL_TBLD_SORTBY est FRAG (pourcentage de fragmentation). Les valeurs admises sont ROWS (nombre de lignes dans une table), SPACE (espace utilisé par la table) et OPTSAGE (date des statistiques de l'optimiseur de la table).

Variable d'optimisation de la collecte pour les ensembles de données MS SQL Problem Detail et Problem Summary

  • COLL_ALERT_SEV : utilisez cette variable pour définir le niveau de gravité des messages d'erreur affichés dans les ensembles de données Problem Detail et Problem Summary. Les messages d'erreur dont le niveau de gravité est supérieur ou égal à la valeur indiquée dans cette variable sont affichés dans les ensembles de données Problem Detail et Problem Summary. Par exemple, si vous définissez la valeur 10 pour cette variable, les messages d'erreur dont le niveau de gravité est supérieur ou égal à 10 sont affichés dans les ensembles de données Problem Detail et Problem Summary. Si vous n'indiquez pas de valeur pour cette variable, les messages d'erreur dont le niveau de gravité est supérieur ou égal à 17 sont affichés dans les ensembles de données Problem Detail et Problem Summary.
  • COLL_SINCE_ERRORLOG_RECY : utilisez cette variable pour surveiller uniquement les erreurs dont le niveau de gravité est élevé dans le fichier ERRORLOG. Si vous n'indiquez pas de valeur pour cette variable, la valeur de la variable est 0, ce qui signifie que pour la collecte des données, l'ensemble de données Problem Summary prend en compte les erreurs de gravité élevée qui sont lues dans le fichier ERRORLOG précédent. Pour surveiller uniquement les erreurs dont le niveau de gravité est élevé dans le fichier ERRORLOG en cours, définissez cette variable en indiquant la valeur 1.

Variables de définition de l'intervalle du délai d'attente

Pour définir l'intervalle du délai d'attente pour l'agent Microsoft SQL Server, vous pouvez utiliser les variables d'environnement suivantes :
  • WAIT_TIMEOUT : utilisez cette variable pour définir le délai d'attente de l'agent Microsoft SQL Server. Si un ensemble de données prend plus de 45 secondes pour collecter des données, l'agent risque de se bloquer ou le déclenchement de situations risque d'être incorrect. Examinez le journal afin d'identifier les ensembles de données qui prennent plus de 45 secondes pour collecter les données et utilisez la variable WAIT_TIMEOUT pour augmenter le délai d'attente entre la procédure de l'agent et la procédure du collecteur.
  • COLL_DB_TIMEOUT : utilisez cette variable pour définir le délai d'attente (en secondes) de n'importe quelle demande, comme l'exécution d'une requête sur une connexion de serveur SQL existante à effectuer avant de revenir à l'application. Si vous indiquez la valeur 0, il n'y a pas de délai d'attente. Si vous n'indiquez pas de valeur pour cette variable, l'agent attend 15 secondes avant de revenir à l'application.

Variables permettant de définir les propriétés des fichiers journaux du collecteur

Pour définir les propriétés des fichiers journaux du collecteur, vous pouvez utiliser les variables d'environnement suivantes :
  • COLL_WRAPLINES : cette variable permet d'indiquer le nombre maximal de lignes dans le fichier col.out. La valeur par défaut de cette variable est 90000 lignes (2 Mo environ).
  • COLL_NUMOUTBAK : cette variable permet d'indiquer le nombre de copies de sauvegarde des fichiers journaux du collecteur à créer. Par défaut, cinq copies de sauvegarde du fichier journal du collecteur sont créées. Le fichier de sauvegarde s'appelle *.out. Lorsque ce fichier de sauvegarde atteint sa taille maximale, il est renommé *.ou1 et les derniers journaux sont placés dans le fichier *.out. Ainsi, pour cinq fichiers de sauvegarde, les journaux les plus anciens sont disponibles dans le fichier *.ou5 et les journaux les plus récents sont disponibles dans le fichier *.out.
    Vous pouvez créer plus de cinq copies de sauvegarde des fichiers journaux du collecteur en indiquant l'une des valeurs suivantes dans la variable COLL_NUMOUTBAK :
    • Pour moins de dix fichiers de sauvegarde, indiquez le nombre de fichiers de sauvegarde que vous souhaitez créer dans la variable COLL_NUMOUTBAK. Par exemple, si vous indiquez 9 dans la variable COLL_NUMOUTBAK, neuf fichiers de sauvegarde sont créés.
    • Si le nombre de fichiers de sauvegarde est supérieur à 9 et inférieur à 1000, indiquez le nombre de fichiers de sauvegarde précédé par un tiret dans la variable COLL_NUMOUTBAK. Par exemple, si vous indiquez -352 dans la variable COLL_NUMOUTBAK, 352 fichiers de sauvegarde sont créés.
  • COLL_DEBUG : utilisez cette variable pour activer le suivi complet du collecteur en attribuant cette variable à la valeur dddddddddd (10 fois d).

Variable de suppression des fichiers temporaires

COLL_TMPFILE_DEL_INTERVAL : cette variable permet d'indiquer l'intervalle (en minutes) au-delà duquel les fichiers temporaires KOQ_<horodatage> doivent être supprimés. Si vous n'indiquez pas de valeur pour cette variable, la valeur de la variable est 0, ce qui signifie que les fichiers temporaires doivent être supprimés immédiatement.

Variable pour le changement de pilote utilisée par l'agent MS SQL Server

Pour changer le pilote utilisé par l'agent Microsoft SQL Server, utilisez la variable d'environnement KOQ_ODBC_DRIVER. Cette variable spécifie le pilote utilisé par l'agent Microsoft SQL Server pour se connecter au serveur SQL. Si vous n'indiquez pas de valeur pour cette variable, l'agent utilise le pilote ODBC SQL Server comme pilote par défaut.
Remarque : Lorsque vous spécifiez le pilote Microsoft SQL Server, vérifiez que le nom du pilote est correct et que le pilote est répertorié sous l'option correspondante dans la source de données (ODBC).

Variable pour la connexion à une base de données SQL Server compatible AlwaysOn

KOQ_APPLICATION_INTENT : cette variable permet d'indiquer l'option de connexion lors de la connexion à SQL Server.
Détails de l'option KOQ_APPLICATION_INTENT :
  • Readonly : la connexion est établie avec ApplicationIntent en tant que readonly.
  • Readwrite : la connexion est établie avec ApplicationIntent en tant que readwrite.
    Lorsque l'option est définie sur Readwrite, l'agent Microsoft SQL Server n'effectue aucune opération d'écriture avec la connexion.
Si cette variable n'est pas définie, la connexion est établie sans propriété ApplicationIntent.
Remarque : Le pilote est spécifié par la variable d'environnement KOQ_ODBC_DRIVER. Si cette variable n'est pas définie, le pilote SQL Server par défaut est utilisé.
Si le pilote ne prend pas en charge ApplicationIntent, la connexion est établie sans propriété ApplicationIntent.