Métriques extensibles pour la surveillance et les alertes

Les métriques sont activées par défaut lors de l'utilisation des graphiques HCL Commerce Helm. Ils peuvent également être activés en configurant la variable d'environnement :

EXPOSE_METRICS=true

Les métriques sont exposées sur chaque pod sur les chemins et ports suivants :

Compteurs

Nombre positif pouvant être augmenté d'un nombre fixe. Par exemple, "nombre de requêtes". Prometheus inclut des fonctions telles que rate() et increase() qui peuvent être utilisées pour se protéger contre les réinitialisations de compteur.

Voir les exemples suivants pour définir un type de compteur :

Ajout d'un nouveau compteur dont les libellés de valeur sont connus

private static Counter BACKEND_COUNTER = 
        Metrics.isEnabled() 
            ? Counter.builder( "backend.calls.total" )
               .tags( "result", "ok" )
               .description("Number of successful backend requests")
               .builder.register( Metrics.getRegistry())
            : null;
…

if ( BACKEND_COUNTER != null ) {
   BACKEND_COUNTER.increment();
}

Ajout d'un nouveau compteur dont les libellés ne sont pas connus à l'avance

if ( Metrics.isEnabled() ) {

   Metrics.getRegistry().counter( 
      "backend.calls.total", 
      "result",
      myGetResult()
     ).increment();  
}

Temporisateurs

Les temporisateurs sont utilisés pour suivre la durée et la fréquence des événements. Outre le calcul des durées moyennes, l'API permet de configurer un ensemble d'objectifs de niveau de service (SLO), qui sont traduits en périodes d'histogramme. Les SLO peuvent également être utilisés pour calculer les quantiles. Pour plus d'informations, voir Histograms and Summaries (Histogrammes et résumés) sur le site Web de Prometheus.

La classe Metrics définit les SLO pour les usages courants. Par exemple, Metrics.DEFAULT_SLO_REST_DURATIONS_NAME définit les périodes adaptées aux temps d'exécution typiques de REST. Si votre temporisateur ne correspond pas à ces durées, vous pouvez spécifier de nouvelles valeurs en tant que tableau long. Pour plus d'informations, voir .sla() dans la définition de la classe Timer.Builder sur le site Web de Micrometer.

Exemple : Ajout d'un nouveau temporisateur dont les libellés de valeur sont connus

private static Timer BACKEND_TIMER = 
        Metrics.isEnabled() 
            ? Timer.builder( "backend.calls.duration" )
               .tags( "result", "ok" )
               .sla( Metrics.getSLOsByName(Metrics.DEFAULT_SLO_REST_DURATIONS_NAME) )  
               .description("Duration of successful backend requests")
               .builder.register( Metrics.getRegistry())
            : null;

…

if (BACKEND_TIMER != null ) {
  startTime = System.nanoTime();
}

doWork();

if (BACKEND_TIMER != null ) {
  final long deltaTime = System.nanoTime() - startTime;
  BACKEND_TIMER .record(deltaTime, TimeUnit.NANOSECONDS );
}

Lorsque vous utilisez un temporisateur avec des valeurs d'étiquette qui ne sont pas connues à l'avance, l'API Micrometer ne permet pas de spécifier le SLO (.sla(..)). Pour ce faire, définissez un filtre de mètre pour fusionner la configuration. Les méthodes d'utilitaire Metrics.applySLO(final String metricName, final long[] slos) ou Metrics.applySLO(final String metricName, final String name) peuvent également être utilisées.

Exemple : Ajout d'un nouveau temporisateur dont les valeurs de libellés ne sont pas connues à l'avance

private static String TIMER_NAME = "backend.calls.duration";

static {
   Metrics.applySLO( TIMER_NAME, Metrics.DEFAULT_SLO_REST_DURATIONS_NAME );
}

…

if ( Metrics.isEnabled() ) {
  startTime = System.nanoTime();
}

doWork();

if ( Metrics.isEnabled() ) {
   final long deltaTime = System.nanoTime() - startTime;
   Metrics.getRegistry().timer(
        TIMER_NAME,
        "result",
        getResult() )
            .record( deltaTime , TimeUnit.MILLISECONDS ); 

}

Jauges

Une jauge détient une valeur qui peut augmenter et diminuer au fil du temps. Le mètre est mappé à une fonction pour obtenir la valeur. Le nombre de sessions actives et la taille actuelle du cache en sont des exemples.

Exemple : Définition d'une jauge

class MyService {

 private Gauge myActiveClientsGauge;

 final void setup() {
   if (Metrics.isEnabled()) {
     myActiveClientsGauge = Gauge.builder( "myservice.activeclients", this,       
                                MyService::getActiveClients )
      .tags("endpoint", getEndpointName())
      .register(Metrics.getRegistry());
   }
 }
 
 private double getActiveClients() {		
   return nActiveClients; 
 }
}