Activar las métricas del servidor Notakey Authentication

Las últimas versiones de nuestro servidor Authentication proporcionan diversas métricas operativas que permiten supervisar el uso del servicio y crear alertas ante anomalías. Las métricas están en formato Prometheus y disponibles directamente desde el nodo Notakey Appliance.

Las estadísticas las agrega el plugin stats-agent, que hay que configurar en uno o varios nodos. También es posible una configuración con una dirección VRRP para las métricas.

# minimal plugin configuration

ntk cfg set :plugins.\"stats-agent\" '{
   "ports": [
      "9394:9394"
    ],
    "tag": "statsagent"
  }' --json-input

Ejecute ntk plugins update para actualizar las imágenes de contenedor de todos los plugins y, a continuación, ntk plugins restart.

Una vez configurado el agente, debe activar las estadísticas en el servidor Authentication:

ntk cfg set :nas.custom_params "ENABLE_STATS=1,STATS_HOST=stats-agent"
ntk as restart

A partir de ahora, las métricas del servidor Authentication estarán accesibles en http://<internal-ip>:9394/metrics.

Algunas métricas que conviene medir:

ntk_as_auth_requests_created: Number of created auth requests per service
ntk_as_auth_requests_failed: Number of failed creations of auth requests
ntk_as_auth_requests_signed: Number of signing events for auth requests per service
ntk_as_api_auth_success_total: Number of successful API client authentication requests
ntk_as_api_auth_failures_total: Number of failed API client authentication requests
ntk_as_api_token_auth_fail_total: Token auth validation requests that failed
ntk_as_api_tokens_emitted_total: Number of issued authentication tokens
ntk_as_seats_issued_total: Total number of issued licensed seats
ntk_as_seats_total: Total number of available licensed seats
ntk_as_seat_destroy_count: Number of license seat removal events
ntk_as_seat_create_count: Number of license seat create events
ntk_as_http_duration_seconds_count: Request count of HTTP reqs, per endpoint
ntk_as_http_duration_seconds_sum: Time spent in HTTP reqs in seconds, per endpoint

Para configurar el plugin stats-agent de modo que utilice una dirección IP VRRP, use los siguientes comandos:

# VRRP service must be configured on every node running stats-agent

# 172.17.0.1 is the default internal bridge IP address, available on every node
ntk cfg set vrrp.track.generic.url 'http://172.17.0.1:9394/metrics'

# Adjust IP address and select different priorities for each node
ntk cfg set vrrp.services.stats  '{
      "prio": "100",
      "vrid": "54",
      "interface": "eth0",
      "address": "10.0.1.97",
      "preempt": "off",
      "track": [
        "generic"
      ]
    }' --json-input

# Any VRRP config changes require restart
ntk vrrp restart

Tras configurar VRRP, indique al servidor de autenticación que publique las estadísticas en la IP VRRP estableciendo STATS_HOST=10.0.1.97 y reiniciando el servicio (ntk as restart).