Surveiller les ressources de serveur à l’aide de la console JMX monitoring-server-resources-using-the-jmx-console

La console JMX permet de surveiller et de gérer des services sur le serveur CRX. Les sections suivantes récapitulent les attributs et les opérations exposés par le biais de la structure JMX.

Pour plus d’informations sur l’utilisation des commandes de la console, consultez la section Utilisation de la console JMX. Pour obtenir des informations d’ordre général sur JMX, consultez la page Technologie Java Management Extensions (JMX) (en anglais) sur le site web d’Oracle.

Pour plus d’informations sur la création de MBeans pour gérer vos services à l’aide de la console JMX, voir Intégration de services à la console JMX.

Maintenance des workflows workflow-maintenance

Opérations d’administration des instances de workflow en cours d’exécution, terminées, obsolètes et ayant échoué.

Opérations operations

listRunningWorkflowsPerModel Indique le nombre d’instances de workflows exécutées pour chaque modèle de workflow.

listCompletedWorkflowsPerModel Indique le nombre d’instances de workflows terminées pour chaque modèle de workflow.

returnWorkflowQueueInfo Répertorie les informations sur les éléments de workflows traités et mis en file d’attente pour le traitement.

returnWorkflowJobTopicInfo Répertorie les informations de traitement des tâches de workflow, organisées par rubrique.

returnFailedWorkflowCount Affiche le nombre d’instances de workflow ayant échoué. Vous pouvez spécifier un modèle de workflow pour interroger ou extraire les informations pour tous les modèles de workflow.

returnFailedWorkflowCountPerModel Affiche le nombre d’instances de workflow ayant échoué pour chaque modèle de workflow.

terminateFailedInstances Interrompt les instances de workflow ayant échoué. Vous pouvez interrompre toutes les instances ayant échoué ou uniquement les instances ayant échoué pour un modèle spécifique. Vous avez la possibilité de redémarrer les instances après les avoir interrompues. Vous avez la possibilité de tester l’opération pour afficher les résultats sans effectuer réellement l’opération.

retryFailedWorkItems Tente d’exécuter les étapes d’une tâche ayant échoué. Vous pouvez tenter de réexécuter toutes les tâches ayant échoué ou seulement les tâches ayant échoué pour un modèle de workflow spécifique. Vous avez la possibilité de tester l’opération pour afficher les résultats sans effectuer réellement l’opération.

PurgeActive Supprime les instances de workflows actives d’une ancienneté déterminée. Vous pouvez purger des instances actives pour tous les modèles ou pour un modèle spécifique seulement. Vous avez la possibilité de tester l’opération pour afficher les résultats sans effectuer réellement l’opération.

countStaleWorkflows Renvoie le nombre d’instances de workflows obsolètes. Vous pouvez récupérer le nombre d’instances obsolètes pour tous les modèles de workflow ou pour un modèle spécifique.

restartStaleWorkflows Redémarrez les instances de workflows obsolètes. Vous pouvez redémarrer toutes les instances obsolètes ou seulement les instances obsolètes pour un modèle spécifique. Vous avez la possibilité de tester l’opération pour afficher les résultats sans effectuer réellement l’opération.

fetchModelList Répertorie tous les modèles de workflows.

countRunningWorkflows Renvoie le nombre d’instances de workflows en cours d’exécution. Vous pouvez récupérer le nombre d’instances en cours d’exécution pour tous les modèles de workflow ou pour un modèle spécifique.

countCompletedWorkflows Renvoie le nombre d’instances de workflows terminées. Vous pouvez récupérer le nombre d’instances terminées pour tous les modèles de workflow ou pour un modèle spécifique.

purgeCompleted Supprime du référentiel les enregistrements des workflows terminés disposant d’une ancienneté spécifique. Utilisez régulièrement cette opération pour réduire la taille du référentiel lorsque vous utilisez intensivement des workflows. Vous pouvez purger les instances terminées pour tous les modèles ou pour un modèle spécifique seulement. Vous avez la possibilité de tester l’opération pour afficher les résultats sans effectuer réellement l’opération.

Référentiel repository

Informations sur le référentiel CRX

Attributs attributes

Name Nom de la mise en œuvre du référentiel JCR. Lecture seule.

Version Version de la mise en œuvre du référentiel. Lecture seule.

HomeDir Répertoire dans lequel se trouve le référentiel. L’emplacement par défaut est <QuickStart_Jar_Location>/crx-quickstart/repository. Lecture seule.

CustomerName Nom du client pour lequel la licence du logiciel est émise. Lecture seule.

LicenseKey Clé de licence unique pour cette installation du référentiel. Lecture seule.

AvailableDiskSpace Espace disque disponible pour cette instance du référentiel, en mégaoctets (Mo). Lecture seule.

MaximumNumberOfOpenFiles Nombre de fichiers pouvant être ouverts simultanément. Lecture seule.

SessionTracker Valeur de la variable système crx.debug.sessions. La valeur true indique une session de débogage. La valeur false indique une session normale. Lecture/écriture.

Descriptors Ensemble de paires clé-valeur, qui représentent les propriétés du référentiel. Toutes les propriétés sont en lecture seule.

WorkspaceNames Nom des espaces de travail dans le référentiel. Lecture seule.

DataStoreGarbageCollectionDelay Délai, en millisecondes, pendant lequel le nettoyage est mis en veille après l’analyse de chaque dixième nœud. Lecture/écriture.

BackupDelay Délai, en millisecondes, pendant lequel le processus de sauvegarde est mis en veille entre chaque étape de la sauvegarde. Lecture/écriture.

BackupInProgress Une valeur true indique qu’un processus de sauvegarde est en cours d’exécution. Lecture seule.

BackupProgress Pour la sauvegarde actuelle, pourcentage de tous les fichiers sauvegardés. Lecture seule.

CurrentBackupTarget Pour la sauvegarde actuelle, fichier ZIP dans lequel les fichiers de sauvegarde sont enregistrés. Lorsqu’il n’y a pas de sauvegarde en cours, aucune valeur ne s’affiche. Lecture seule.

BackupWasSuccessful La valeur true indique qu’aucune erreur ne s’est produite lors de la sauvegarde actuelle ou qu’aucune sauvegarde n’est en cours. La valeur false indique qu’une erreur s’est produite lors de la sauvegarde actuelle. Lecture seule.

BackupResult Statut de la sauvegarde actuelle. Les valeurs suivantes sont valides :

Lecture seule.

TarOptimizationRunningSince Heure à laquelle le processus d’optimisation actuel du fichier TAR a commencé. Lecture seule.

TarOptimizationDelay Délai, en millisecondes, pendant lequel le processus d’optimisation du fichier TAR est mis en veille entre chaque étape du processus. Lecture/écriture.

ClusterProperties Ensemble de paires clé-valeur, qui représente les propriétés et les valeurs du cluster. Chaque ligne du tableau représente une propriété du cluster. Lecture seule.

ClusterNodes Membres du cluster de référentiel.

ClusterId Identifiant de ce cluster de référentiel. Lecture seule.

ClusterMasterId Identifiant du nœud maître de ce cluster de référentiel. Lecture seule.

ClusterNodeId Identifiant de ce nœud du cluster de référentiel. Lecture seule.

Opérations operations-1

createWorkspace Crée un espace de travail dans ce référentiel.

runDataStoreGarbageCollection Exécute le nettoyage sur les nœuds du référentiel.

stopDataStoreGarbageCollection Arrête le nettoyage en cours d’un entrepôt de données.

startBackup Sauvegarde les données du référentiel dans un fichier ZIP.

cancelBackup Arrête le processus de sauvegarde en cours et supprime l’archive temporaire créée par le processus pour archiver les données.

blockRepositoryWrites Empêche d’apporter des modifications aux données du référentiel. Tous les listeners de sauvegarde du référentiel sont informés du bloc.

unblockRepositoryWrites Supprime le blocage du référentiel. Tous les listeners de sauvegarde du référentiel sont informés de la suppression du bloc.

startTarOptimization Commence le processus d’optimisation du fichier TAR à l’aide de la valeur par défaut pour tarOptimizationDelay.

stopTarOptimization Interrompt l’optimisation du fichier TAR.

tarIndexMerge Fusionne les fichiers d’index de niveau supérieur de tous les ensembles TAR. Les fichiers d’index de niveau supérieur sont des fichiers comportant des versions principales différentes. Par exemple, les fichiers ci-dessous sont fusionnés dans le fichier file index_3_1.tar: index_1_1.tar, index_2_0.tar, index_3_0.tar. Les fichiers fusionnés sont supprimés (dans l’exemple précédent, index_1_1.tar, index_2_0.taret index_3_0.tar sont supprimés).

becomeClusterMaster Définit ce nœud de référentiel comme nœud maître du cluster. S’il n’est pas déjà le nœud principal, cette commande arrête le programme d’écoute de l’instance principale actuelle et démarre un programme d’écoute sur le nœud actuel. Ce nœud est ensuite défini comme nœud principal et redémarre, ce qui fait que tous les autres nœuds du cluster (c’est-à-dire ceux qui sont contrôlés par le nœud principal) se connectent à cette instance.

joinCluster Ajoute ce référentiel à un cluster en tant que nœud contrôlé par le nœud principal du cluster. Vous devez fournir un nom d’utilisateur ou d’utilisatrice et un mot de passe pour l’authentification. La connexion utilise l’authentification de base. Les informations d’identification de sécurité sont codées en base 64 avant d’être envoyées au serveur.

traversalCheck Parcourt et corrige, éventuellement, les incohérences d’une sous-arborescence, en commençant par un nœud spécifique. Cet aspect est abordé en détail dans la documentation sur les gestionnaires de persistance.

consistencyCheck Vérifie et corrige, éventuellement, les incohérences dans l’entrepôt de données. Cet aspect est abordé en détail dans la documentation sur l’entrepôt de données.

Statistiques du référentiel (TimeSeries) repository-statistics-timeseries

Valeur du champ TimeSeries pour chaque type de statistiques défini par org.apache.jackrabbit.api.stats.RepositoryStatistics.

Attributs attributes-1

Les attributs suivants sont fournis pour chaque type de statistique signalé :

Statistiques de requête du référentiel repository-query-stats

Informations statistiques sur les requêtes de référentiel.

Attributs attributes-2

SlowQueries Informations sur les requêtes dans le référentiel qui ont pris le plus de temps. Lecture seule.

SlowQueriesQueueSize Nombre maximal de requêtes à inclure dans la liste de SlowQueries. Lecture-écriture.

PopularQueries Informations sur les requêtes dans le référentiel exécutées le plus souvent. Lecture seule.

PopularQueriesQueueSize Nombre maximal de requêtes dans la liste de PopularQueries. Lecture-écriture.

Opérations operations-2

clearSlowQueriesQueue Supprime toutes les requêtes de la liste SlowQueries.

clearPopularQueriesQueue Supprime toutes les requêtes de la liste PopularQueries.

Agents de réplication replication-agents

Surveillez les services pour chaque agent de réplication. Lorsque vous créez un agent de réplication, le service s’affiche automatiquement dans la console JMX.

Attributs attributes-3

Id Valeur de chaîne qui représente l’identifiant de la configuration de l’agent de réplication. Plusieurs agents peuvent utiliser la même configuration. Lecture seule.

Valid Valeur booléenne qui indique si l’agent est configuré correctement :

Lecture seule.

Enabled Valeur booléenne qui indique si l’agent est activé :

QueueBlocked Valeur booléenne qui indique si la file d’attente existe et si elle est bloquée :

Lecture seule.

QueuePaused Valeur booléenne qui indique si la file d’attente de tâches est suspendue :

Lecture-écriture.

QueueNumEntries Valeur d’entier (int) représentant le nombre de tâches dans la file d’attente de l’agent. Lecture seule.

QueueStatusTime Valeur Date indiquant le temps passé sur le serveur une fois que les valeurs de statut affichées ont été obtenues. La valeur correspond au délai de chargement de la page. Lecture seule.

QueueNextRetryTime Pour les files d’attente bloquées, valeur Date indiquant le moment auquel la tentative automatique suivante aura lieu. Lorsque aucun délai ne s’affiche, la file d’attente n’est pas bloquée. Lecture seule.

QueueProcessingSince Valeur Date indiquant le moment auquel le traitement a commencé pour la tâche actuelle. Lorsque aucun délai ne s’affiche, la file d’attente est bloquée ou inactive. Lecture seule.

QueueLastProcessTime Valeur Date indiquant le moment auquel la tâche précédente s’est terminée. Lecture seule.

Opérations operations-3

queueForceRetry Pour les files d’attente bloquées, exécute la commande retry dans la file d’attente.

queueClear Supprime toutes les tâches de la file d’attente.

Moteur Sling sling-engine

Fournit des statistiques sur les requêtes HTTP afin que vous puissiez surveiller les performances du service SlingRequestProcessor.

Attributs attributes-4

RequestsCount Nombre de demandes exécutées depuis que les statistiques ont été réinitialisées pour la dernière fois.

MinRequestDurationMsec Délai le plus court (en millisecondes) nécessaire pour traiter une demande depuis que les statistiques ont été réinitialisées pour la dernière fois.

MaxRequestDuratioMsec Durée la plus longue (en millisecondes) nécessaire pour traiter une demande depuis que les statistiques ont été réinitialisées pour la dernière fois.

StandardDeviationDurationMsec Écart-type du délai nécessaire pour traiter des demandes. L’écart-type est calculé à l’aide de toutes les demandes depuis que les statistiques ont été réinitialisées pour la dernière fois.

MeanRequestDurationMsec Délai moyen nécessaire pour traiter une demande. La moyenne est calculée à l’aide de toutes les demandes depuis que les statistiques ont été réinitialisées pour la dernière fois.

Opérations operations-4

resetStatistics Définit toutes les statistiques sur zéro. Réinitialisez les statistiques lorsque vous devez analyser les performances de traitement des requêtes pendant une période spécifique.

id Représentation sous forme de chaîne de l’ID du package.

installed Valeur booléenne indiquant si le package est installé :

installedBy ID du dernier utilisateur ayant installé le package.

installedDate Date à laquelle le package a été installé pour la dernière fois.

size Valeur longue contenant la taille du package en octets.

Lanceur de démarrage rapide quickstart-launcher

Informations sur le processus de démarrage et le lanceur de démarrage rapide.

Opérations operations-5

log

Affiche un message dans la fenêtre QuickStart.

Arguments :

startupFinished

Appelle la méthode startupFinished du lanceur du serveur. La méthode tente d’ouvrir la page d’accueil dans un navigateur web.

startupProgress

Définit la valeur de fin du processus de démarrage du serveur. La barre de progression de la fenêtre QuickStart représente la valeur de fin.

Services tiers third-party-services

Plusieurs ressources de serveur tiers installent des beans gérés (MBeans), qui exposent des attributs et des opérations dans la console JMX. Le tableau suivant répertorie les ressources tierces et fournit des liens vers d’autres informations.

Utiliser la console JMX using-the-jmx-console

La console JMX affiche des informations sur plusieurs services exécutés sur le serveur :

Les MBeans déployés avec un service OSGi exposent les attributs et les opérations du service dans la console. Le MBean détermine les attributs et les opérations exposés et si les attributs sont en lecture seule ou en lecture/écriture.

La page principale de la console JMX comporte un tableau des services. Chaque ligne du tableau représente un service exposé par un MBean.

Utiliser des applications JMX externes pour la surveillance using-external-jmx-applications-for-monitoring

CRX permet aux applications externes d’interagir avec les beans gérés (MBeans) par le biais de Java Management Extensions (JMX). Utiliser des consoles génériques telles que JConsole ou des applications de surveillance spécifiques à un domaine permet d’obtenir et de définir des configurations et des propriétés CRX, ainsi que de surveiller les performances et l’utilisation des ressources.

Utiliser JConsole pour se connecter à CRX using-jconsole-to-connect-to-crx

Pour vous connecter à CRX à l’aide de JConsole, procédez comme suit :

JConsole démarre et la fenêtre JConsole s’affiche.

Connexion à un processus CRX local connecting-to-a-local-crx-process

JConsole affiche une liste des processus locaux de machine virtuelle Java. La liste contient deux processus QuickStart. Sélectionnez le processus « ENFANT » de démarrage rapide dans la liste des processus locaux (généralement celui avec la PID supérieure).

Connexion à un processus CRX distant connecting-to-a-remote-crx-process

Pour se connecter à un processus CRX distant, la JVM qui héberge le processus CRX distant doit être activée pour accepter les connexions JMX distantes.

Pour activer les connexions JMX à distance, la propriété système ci-dessous doit être définie au démarrage de la machine virtuelle Java :

com.sun.management.jmxremote.port=portNum

Dans la propriété ci-dessus, portNum correspond au numéro de port sur lequel vous souhaitez activer les connexions RMI JMX. Veillez à spécifier un numéro de port inutilisé. Outre la publication d’un connecteur RMI pour l’accès local, la définition de cette propriété publie un connecteur RMI supplémentaire dans un registre privé en lecture seule sur le port spécifié à l’aide d’un nom bien connu, « jmxrmi ».

Par défaut, lorsque vous activez l’agent JMX pour la surveillance à distance, il utilise l’authentification par mot de passe basée sur un fichier de mot de passe qui doit être spécifié à l’aide de la propriété système suivante lors du démarrage de la machine virtuelle Java :

com.sun.management.jmxremote.password.file=pwFilePath

Pour obtenir des instructions détaillées sur la configuration d’un fichier de mot de passe, consultez la documentation JMX correspondante.

Exemple :

$ java
  -Dcom.sun.management.jmxremote.password.file=pwFilePath
  -Dcom.sun.management.jmxremote.port=8463
  -jar ./cq-quickstart.jar

Utilisation des MBeans fournis par CRX using-the-mbeans-provided-by-crx

Après la connexion au processus de démarrage rapide, JConsole fournit une gamme d’outils de surveillance généraux pour la JVM dans laquelle CRX est exécuté.

Pour accéder aux options de surveillance et de configuration internes de CRX, accédez à l’onglet MBeans et, dans l’arborescence à gauche, sélectionnez la section Attributs ou Opérations qui vous intéresse. Par exemple, la section com.adobe.granite/Repository/Operations.

Dans cette section, sélectionnez l’attribut ou l’opération de votre choix dans le volet de gauche.