Utiliser les journaux de ArcGIS Notebook Server

ArcGIS Notebook Server consigne dans des journaux tous les événements qui se produisent sur un site, ainsi que toutes les erreurs associées à ces événements. Ces journaux sont disponibles pour les administrateurs du site.

Les journaux constituent un outil important de contrôle et de résolution des problèmes que présente votre site ArcGIS Notebook Server. Les informations fournies par ces journaux peuvent vous aider à identifier les erreurs et à disposer d’un contexte pour la résolution des problèmes et des erreurs. Les journaux servent également de système d’enregistrement des événements qui se produisent sur votre site.

Les types d’événements suivants sont ainsi enregistrés dans les journaux :

• Installation et mise à niveau, par exemple autorisation logicielle et création de sites
• Ouverture et fermeture des ArcGIS Notebooks
• Tâches de nettoyage effectuées par le site
• Tâches de gestion du site effectuées par les administrateurs, par exemple ajout ou suppression des runtimes de notebook, création de répertoires de serveur ou configuration des paramètres de sécurité.
• Événements de sécurité, par exemple connexion des utilisateurs au site ou importation et exportation de certificats SSL.

Certains événements ne sont pas enregistrés dans les journaux ArcGIS Notebook Server. Il s’agit notamment de la fédération du site avec un portail. Les événements qui ont lieu sur les ArcGIS Notebooks (ajout de contenu, exécution de cellules, etc.) ne sont pas enregistrés. Les événements qui ont lieu dans les conteneurs Docker de votre machine ne sont pas non plus enregistrés ; pour consulter des journaux propres au conteneur, reportez-vous à la section Consulter les journaux des conteneurs Docker ci-dessous.

Niveaux de consignation disponibles

Chaque journal est associé à un niveau de consignation des détails, qui peut être l’un des suivants (du moins détaillé au plus détaillé) :

• Severe (Grave) - Problèmes graves nécessitant une attention immédiate.
• Warning (Avertissement) - Problèmes modérés nécessitant votre attention.
• Info (Informations) - Messages courants sur l’administration du site Notebook Server, y compris les messages relatifs à la création et au démarrage de services.
• Fine (Fin) - Messages courants sur l’utilisation du serveur, comme le nom des demandes d’opération reçues.
• Verbose (Commentaires) - Messages fournissant plus d’informations sur la façon dont le serveur exécute les opérations.
• Debug (Débogage) - Messages très détaillés destinés aux développeurs et aux techniciens désireux de mieux comprendre l’état du serveur dans le cadre du dépannage. Utilisation non recommandée sur les systèmes de production en raison du nombre de journaux créés.

Dans le répertoire administrateur ArcGIS Notebook Server, vous pouvez spécifier le niveau de consignation le plus détaillé à créer. Par exemple, si vous définissez le niveau sur Fine (Fin), le site de votre serveur consignera les messages des niveaux de détail Severe (Grave), Warning (Avertissement), Info et Fine (Fin).

Rechercher des paramètres du journal dans Manager

À compter de la version 10.8, ArcGIS Notebook Server Manager inclut une page Logs (Journaux). Dans cette page, vous pouvez interroger tous les journaux de votre site ArcGIS Notebook Server.

1. Connectez-vous à votre portail ArcGIS Enterprise en tant qu’administrateur et ouvrez ArcGIS Notebook Server Manager.
2. Ouvrez la page Logs (Journaux).
3. Les paramètres de filtre de l’interrogation se trouvent en haut de la page. Utilisez n’importe lequel des paramètres pour limiter ou étendre votre recherche.

   • Log level (Niveau de consignation) - Niveau de consignation minimum disponible pour l’interrogation (voir la section ci-dessus). Il renvoie seulement les enregistrements dont le niveau de consignation est égal ou supérieur au niveau spécifié. Le niveau par défaut est WARNING.
   • Log time (Durée de consignation) - Période de recherche dans les journaux. Il est possible de limiter une recherche aux 15 dernières minutes, à la dernière heure, aux dernières 6 ou 24 heures, à la semaine dernière ou aux 30 derniers jours ou encore d’afficher tous les journaux qui existent depuis la création du site.

     Conseil :

     Utilisez le répertoire administrateur pour interroger les journaux si vous voulez spécifier une fin différente du jour actuel (par exemple, des journaux qui remontent à deux ou trois jours).

   • Machine - Limite la recherche aux journaux de l’une des machines ArcGIS Notebook Server ou affiche les journaux de toutes les machines.
   • Log codes (Codes de consignation) - Un code ou une plage de codes de consignation attribués à un message de consignation. Si la zone est vide, tous les codes sont affichés.
   • Users (Utilisateurs) - Le nom d’utilisateur d’un ou plusieurs utilisateurs (séparés par des virgules) dont vous interrogez les journaux correspondants. Certains messages de consignation sont associés à une action d’un utilisateur spécifique.

4. Cliquez sur Search (Rechercher) pour exécuter l’interrogation. Tous les journaux correspondant à vos paramètres s’affichent dans la table finale.

Modifier les paramètres de consignation dans Manager

Vous pouvez également utiliser ArcGIS Notebook Server Manager pour modifier les paramètres de consignation applicables à votre site.

1. Connectez-vous à votre portail ArcGIS Enterprise en tant qu’administrateur et ouvrez ArcGIS Notebook Server Manager.
2. Ouvrez la page Settings (Paramètres) et cliquez sur Logs (Journaux).
3. Vous pouvez modifier les paramètres suivants :

   • Log directory (Répertoire des journaux) - Emplacement du disque de votre répertoire des journaux. Si vous possédez plusieurs machines dans votre site, assurez-vous que ce chemin désigne un partage UNC.
   • Log level (Niveau de consignation) - Le niveau de consignation le plus élevé disponible pour votre site. Si ce paramètre est défini sur FINE, par exemple, votre site ne conserve pas les journaux de niveaux VERBOSE ou DEBUG.
   • Days to keep logs (Nombre de jours de conservation des journaux) - Nombre de jours au terme duquel les messages sont supprimés. Tenez compte de la mémoire disponible dans le lecteur renfermant le répertoire des journaux, ainsi que du paramètre Log level (Niveau de consignation) sélectionné et du niveau d’activité de votre site. Si, par exemple, vous changez de niveau de consignation pour faire appel à un niveau plus détaillé, il faudra peut-être diminuer le nombre de jours de conservation des journaux.

4. Cliquez sur Save (Enregistrer) pour confirmer les modifications.

Interroger les journaux de serveur dans le répertoire administrateur

Utilisez le répertoire administrateur ArcGIS Notebook Server pour interroger, afficher, configurer et supprimer les journaux de serveur.

Pour accéder aux journaux, procédez comme suit :

1. Connectez-vous au répertoire administrateur. L’URL est au format https://notebookserver.domain.com:11443/arcgis/admin ou https://notebookserver.domain.com/<webadaptorname>/admin.
2. Cliquez sur Logs (Journaux) > Query (Requête) pour interroger et consulter les journaux actuels. Utilisez les contrôles de filtre sur la page pour vous aider à restreindre les événements par catégories, par exemple la période ou le niveau de consignation.
3. Cliquez sur Logs (Journaux) > Settings (Paramètres) pour gérer les paramètres des journaux, tels que le niveau de consignation par défaut (comme expliqué ci-dessus), la durée de conservation des journaux sur le disque et l’emplacement auquel les journaux sont écrits.
4. Cliquez sur Clean Logs (Effacer les journaux) pour supprimer tous vos fichiers journaux du site ArcGIS Notebook Server.

Afficher les journaux de conteneur Docker avec ArcGIS Notebook Server Manager

Vous pouvez afficher les journaux propres aux conteneurs Docker de votre site à l’aide de ArcGIS Notebook Server Manager.

1. Connectez-vous à ArcGIS Notebook Server Manager sur votre portail en tant qu’administrateur. L’URL est au format https://webadaptorhost.domain.com/webadaptorname/home/notebook/manager.html.
2. Accédez à l’onglet Containers (Conteneurs).
3. Cliquez sur le bouton View logs (Afficher les journaux) pour afficher les journaux de conteneur de la machine choisie.

Afficher les journaux de conteneur Docker à l’aide de la ligne de commande Docker

Vous pouvez afficher les journaux propres aux conteneurs Docker de votre site grâce à l’interface de ligne de commande Docker, en procédant comme suit.

1. Connectez-vous au répertoire administrateur. L’URL est au format https://notebookserver.domain.com:11443/arcgis/admin ou https://notebookserver.domain.com/<webadaptorname>/admin.
2. Accédez à System (Système) > Containers (Conteneurs). Localisez le conteneur dont vous voulez afficher les journaux, puis cliquez sur son ID.
3. Ouvrez l’affichage JSON de la page d’informations sur le conteneur en ajoutant ?f=pjson à son URL. L’URL est alors au format https://notebookserver.arcgis.com/<webadaptorname>/admin/system/containers/<container>?f=pjson.
4. Localisez le paramètre containerId du conteneur et enregistrez sa valeur.
5. Ouvrez un terminal en tant qu’utilisateur disposant de privilèges Docker.
6. Exécutez la commande docker logs <containerId> en utilisant la valeur que vous avez enregistrée. Cette opération renverra les journaux Docker spécifiques à ce conteneur.