Metrics & Endpoints

Plusieurs métriques sont mises à disposition afin d’avoir des retours quantitatifs sur l’utilisation de Flower. Ces métriques sont mises à dispostion à travers :

  • une API REST
  • des MBeans JMX accessibles depuis une JConsole ou JVisualVM (avec le plugin MBean installé)

Certains endpoints nécessite une authentification qui doit être fournie par un jeton utilisateur :

  • via un paramètre token de l’URL
  • via une en-tête HTTP token

Health

Un endpoint permettant d’avoir un aperçu sur la santé d’une instance de Core est exposé sur /health Ce endpoint ne nécessite aucune authentification.

Connexions par profile

Ces métriques permettent d’obtenir des informations sur les utilisateurs s’étant connecté pour un profile particulier. Pour obtenir ces métriques, il est nécessaire de disposer du rôle ADMIN.

  • /rest/metrics/profiles/{profile} : Liste les connexions pour un profile donné
  • /rest/metrics/profiles/{profile}/count : Compte les connexions pour un profile donné
Paramètre Description
start Paramètre facultatif permettant d’indiquer le début de la plage de date sur laquelle la mesure doit portée.
Par défaut, ce paramètre est valorisé à 24 heures avant la fin de la plage de date. timestamp
end Paramètre facultatif permettant d’indiquer la fin de la plage de date sur laquelle la mesure doit portée.
Par défaut, ce paramètre est valorisé à l’instant présent. timestamp

Exemple :

GET http://localhost:8080/flower-docs-ws/rest/metrics/profiles/ALL_USERS?token=<token>

Opérations

Sur le endpoint /metrics un ensemble de métriques sont fournies notamment celles concernant les opérations effectuées au sein du Core Flower. Ces métriques sont nommées tel que scope.categorie.operation (en minuscule).

Les métriques liées aux opérations nécessitent le rôle ADMIN.

Exemple : Métriques de recherche de document

GET http://localhost:8080/flower-docs-ws/rest/metrics/gec.document.search.*?token=<token>