Métricas ampliables a la supervisión y las alertas

Las métricas se habilitan de forma predeterminada cuando se utilizan los gráficos Helm de HCL Commerce. También se pueden habilitar al configurar la variable del entorno:

EXPOSE_METRICS=true

Las métricas se exponen en cada pod en las siguientes vías de acceso y puertos:

Contadores

Un conteo positivo que puede incrementar una cantidad fija. Por ejemplo, "número de solicitudes". Prometheus incluye funciones como rate() y increase() que se pueden utilizar como protección ante los restablecimientos del contador

Consulte los siguientes ejemplos para definir un tipo de contador:

Añadir un nuevo contador con etiquetas de valor conocido

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();
}

Añadir por adelantado un nuevo contador con etiquetas desconocidas

if ( Metrics.isEnabled() ) {

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

Temporizadores

Los temporizadores se utilizan para realizar un seguimiento de la duración y frecuencia de los sucesos. Además de calcular las duraciones promedio, la API permite configurar un conjunto de objetivos de nivel de servicio (SLO), los cuales se convierten en sectores de histograma. Los SLO también pueden utilizarse para calcular cuantiles. Para obtener más información, consulte Histogramas y resúmenes en el sitio web de Prometheus.

La clase de métricas define los SLO para su uso común. Por ejemplo, Metrics.DEFAULT_SLO_REST_DURATIONS_NAME define los grupos que son adecuados para los tiempos de ejecución de REST típicos. Si el temporizador no coincide con estas duraciones, puede establecer valores nuevos como una matriz larga. Para obtener más información, consulte .sla() en la definición de clase Timer. Builder en el sitio web de Micrometer.

Ejemplo: Agregar de un nuevo temporizador con etiquetas de valor conocido

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 );
}

Cuando se utiliza un temporizador con valores de etiqueta que no se conocen de antemano, la API de Micrometer no permite especificar el(.sla(..)) del SLO . Para poder conseguirlo, debe establecer un filtro del medidor para fusionar su configuración. Los métodos Metrics.applySLO(final String metricName, final long[] slos) o Metrics.applySLO(final String metricName, final String name) del programa de utilidad se pueden utilizar para el mismo.

Ejemplo: Agregar un nuevo temporizador con valores de etiqueta no conocidos de antemano

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 ); 

}

Calibradores

Un medidor contiene un valor que puede aumentar y disminuir con el tiempo. El medidor se correlaciona con una función para obtener el valor. Algunos ejemplos son: el número de sesiones activas y los tamaños de las memorias caché actuales.

Ejemplo: Definición de un medidor

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; 
 }
}