Activer les métriques du serveur Notakey Authentication

Les dernières versions de notre serveur Authentication fournissent diverses métriques opérationnelles qui permettent de surveiller l’utilisation du service et de créer des alertes en cas d’anomalie. Les métriques sont au format Prometheus et disponibles directement depuis le nœud Notakey Appliance.

Les statistiques sont agrégées par le plugin stats-agent, qu’il faut configurer sur un ou plusieurs nœuds. Une configuration avec une adresse VRRP pour les métriques est également possible.

# minimal plugin configuration

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

Exécutez ntk plugins update pour mettre à jour les images de conteneur de tous les plugins, puis ntk plugins restart.

Une fois l’agent configuré, vous devez activer les statistiques sur le serveur Authentication :

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

Les métriques du serveur Authentication seront désormais accessibles sur http://<internal-ip>:9394/metrics.

Quelques métriques à mesurer :

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

Pour configurer le plugin stats-agent afin qu’il utilise une adresse IP VRRP, utilisez les commandes suivantes :

# 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

Après la configuration de VRRP, indiquez au serveur d’authentification de publier les statistiques sur l’IP VRRP en définissant STATS_HOST=10.0.1.97 et en redémarrant le service (ntk as restart).