Plusieurs métriques sont mises à disposition afin d’avoir des retours quantitatifs sur l’utilisation de FlowerDocs Core.
Ces métriques sont mises à dispostion à travers :
- une API REST
- des MBeans JMX accessibles depuis une JConsole ou JVisualVM (avec le plugin MBean installé)
Elles sont exposées sur le endpoint /actuator/metrics
et comme les autres endpoints Actuator, elles sont soumises à une authentification basic.
Opérations
Chaque opération effectuée sur FlowerDocs Core peut être mesurée à l’aide des métriques.
Pour chaque couple scope / catégorie de composant, une métrique <scope>.<categorie>
est exposée (par exemple : gec.document) via le framework Micrometer.
Exemple : Métrique de dossier pour le scope GEC
GET core/actuator/metrics/gec.folder
La métrique est exposée à partir du moment où l’opération a été exécutée une première fois.
Pour chaque métrique d’opération, un tag method
est ajouté permettant ainsi de filtrer par méthode appelée.
Exemple : Métrique de création de tâche pour le scope GEC
GET core/actuator/metrics/gec.task?tag=method:create
OperationHandler
Comme pour les opérations, une métrique est exposée pour les OperationHandler avec le nom <scope>.handlers.<categorie>
(par exemple : gec.handlers.document)
Pour chacune de ces métriques, plusieurs tags sont populés afin de filtrer les valeurs de la métrique :
Nom | Description |
---|---|
phase | Phase d’exécution de l’opération |
action | Action de l’opération |
registration | Identifiant de l’abonnement ayant déclenché l’exécution de l’OperationHandler |
Exemple : Métrique d’OperationHandler exécuté après la création de document
GET core/metrics/gec.handlers.document?tag=phase:AFTER,action:CREATE