Modifier les niveaux d'enregistrement

Par défaut, Tableau Services Manager (TSM) et Tableau Server enregistrent les événements au niveau Informations. Vous pouvez modifier le niveau d'enregistrement si vous souhaitez collecter davantage d'informations (par exemple, si vous travaillez avec l'équipe d'assistance Tableau).

Il est recommandé de ne pas augmenter les niveaux d'enregistrement sauf lorsque vous résolvez un problème, conformément aux instructions de l’assistance. Nous vous recommandons d'utiliser le niveau « debug » uniquement lorsque vous souhaitez régler un problème particulier. Modifier les niveaux d’enregistrements peut avoir les impacts suivants :

  • Le passage au niveau d'enregistrement supérieur debug ou trace augmente la quantité d'informations enregistrées. Cela peut avoir un impact important sur les performances. Une fois le problème réglé, redéfinissez le niveau d'enregistrement sur« info ».
  • Définir le niveau d’enregistrement sur warn ou error peut réduire la quantité d’informations au point qu’elles ne seront plus guère utiles à l’assistance Tableau.

Niveaux d'enregistrement

Les niveaux d'enregistrement suivants sont classés par ordre croissant selon la quantité d'informations enregistrées :

  • off (désactivé)
  • fatal (irrécupérable)
  • error (erreur)
  • warn (avertir)
  • info (the default) (info (valeur par défaut))
  • debug (déboguer)
  • trace (suivre)

Modifier les niveaux d'enregistrement

Vous pouvez définir les niveaux d'enregistrement pour TSM et les processus Tableau Server à l'aide des clés de configuration tsm configuration set. La clé que vous utilisez dépend du composant de TSM ou de Tableau Server dont vous souhaitez modifier le niveau d'enregistrement.

Configuration dynamique du niveau d'enregistrement

Dans la version 2020.2, nous avions introduit la configuration dynamique, qui comprenait l’enregistrement configurable de manière dynamique pour les services tsm (tsm.log.level) et les services d’application de contrôle (tsm.controllerapp.log.level). Cette fonctionnalité a été étendue dans les versions ultérieures. La version 2020.3 ajoute le backgrounder (backgrounder.log.level), le contrôleur de cluster (clustercontroller.log.level), le serveur de données (dataserver.log.level), le répertoire de fichiers (filestore.log.level), les propriétés de la source de données (tdsservice.log.level) et VizQL Server (vizqlserver.log.level). La version 2020.4 ajoute un conteneur de microservice interactif (tomcatcontainer.log.level) et un serveur d’applications (vizportal.log.level). Si vous modifiez les niveaux d’enregistrement pour un ou plusieurs de ces composants seulement, vous pouvez le faire sans redémarrer Tableau Server.

Clé de configuration Emplacement des fichiers journaux affectés

(le chemin d'accès commence par C:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs\)

tsm.log.level

Modifie les niveaux d’enregistrement TSM pour : clientfileservice, licenseservice, tabadminagent, tabadmincontroller, tabsvc

\<service>\<service>_node<n>-<instance>.log

exemple : \clientfileservice\clientservice_node1-0.log

tsm.controlapp.log.level

Modifie les niveaux d’enregistrement TSM pour : Applications de contrôle

\<service>\control_<service>_node<n>-<instance>.log

exemples : \clientfileservice\control_clientservice_node1-0.log

\filestore\control_filestore_node1-0.log

<process>.native_api.log.level

Les noms de processus valides sont backgrounder, vizportal, vizqlserver ou dataserver

Remarque : ils ne sont pas configurables de manière dynamique.

\vizqlserver\*.txt

backgrounder.log.level

Modifie les niveaux d’enregistrement pour : Backgrounder

\backgrounder\*.log

clustercontroller.log.level

Modifie les niveaux d’enregistrement pour : Contrôleur de cluster

\clustercontroller\*.log

dataserver.log.level

Modifie les niveaux d’enregistrement pour : Serveur de données

\dataserver\*.log

filestore.log.level

Modifie les niveaux d’enregistrement pour : Répertoire de fichiers

\filestore\*.log

gateway.log.level

Modifie les niveaux d’enregistrement pour : Processus de contrôle de passerelle

\gateway\*.log

gateway.httpd.loglevel

Remarque : ajouté dans la version 2021.3.0

Modifie les niveaux d’enregistrement pour : Passerelle

\gateway\*.log

tdsservice.log.level

Modifie les niveaux d’enregistrement pour : Service Propriétés de la source de données

\tdsservice\*.log

tomcatcontainer.log.level

Modifie les niveaux d’enregistrement pour les microservices dans : Conteneur de microservices interactif et Conteneur de microservices non interactif

\tomcatcontainer\*.log

vizportal.log.level

Modifie les niveaux d’enregistrement pour : Serveur d'applications

\vizportal\*.log

vizqlserver.log.level

Modifie les niveaux d’enregistrement pour : VizQL Server

\vizqlserver\*.log

Consultez Options tsm configuration set pour plus d'informations.

Si vous modifiez uniquement les niveaux d’enregistrement configurables de manière dynamique, vous n’avez pas besoin d’arrêter ou de démarrer le serveur (pour plus d’informations, voir Configuration dynamique du niveau d'enregistrement ci-dessus). Si vous modifiez les niveaux d’enregistrement de Tableau Server, vous devez arrêter Tableau Server avant de modifier les niveaux d'enregistrement, et le redémarrer par la suite. Sur une installation distribuée de Tableau Server, définissez les niveaux d'enregistrement depuis le nœud initial.

Pour changer le niveau d'enregistrement :

  1. (Facultatif pour les niveaux d'enregistrement configurables de manière dynamique dans la version 2020.2.0 et versions ultérieures) Arrêtez Tableau Server en ouvrant une invite de commande et en tapant :

    tsm stop

  2. Définissez le niveau d'enregistrement en entrant tsm configuration set -k <config.key> -v <config_value>

    <config.key> est l’une des clés dans la table ci-dessus et <config_value> est un niveau d’enregistrement valide.

    Exemples :

    • tsm configuration set -k backgrounder.native_api.log.level -v debug                    
    • tsm configuration set -k tsm.log.level -v debug
    • tsm configuration set -k tsm.controlapp.log.level -v debug
  3. Appliquez les modifications en attente à l'aide de la commande tsm pending-changes apply.
  4. (Facultatif, seulement si le serveur est arrêté) Démarrez Tableau Server en exécutant la commande suivante :

    tsm start

Réinitialiser les niveaux d'enregistrement

Après avoir reproduit le problème et recueilli les informations liées au problème, réinitialisez les niveaux d’enregistrement afin qu’il n’y ait pas d’impact durable sur les performances et qu'aucun espace de disque supplémentaire ne soit utilisé.

Vous pouvez réinitialiser le niveau d'enregistrement par défaut (info) à l'aide de la commande appropriée et d'une option -d. Vous devez appliquer les modifications en attente après la réinitialisation du niveau, et si vous réinitialisez les niveaux d'enregistrement pour les processus Tableau Server, vous devez arrêter le serveur avant d’effectuer la modification, et le démarrer en appliquant les modifications en attente.

Exemples :

  • tsm configuration set -k backgrounder.native_api.log.level -d
  • tsm configuration set -k tsm.log.level -d
Merci de vos commentaires !