Metriken des Notakey Authentication Servers aktivieren

Aktuelle Versionen unseres Authentication Servers liefern verschiedene Betriebsmetriken, mit denen Sie die Nutzung des Dienstes überwachen und Alarme für Anomalien einrichten können. Die Metriken liegen im Prometheus-Format vor und sind direkt auf dem Knoten der Notakey Appliance abrufbar.

Die Statistiken aggregiert das stats-agent-Plugin, das Sie auf einem oder mehreren Knoten konfigurieren. Auch eine Konfiguration mit einer VRRP-Adresse für die Metriken ist möglich.

# minimal plugin configuration

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

Führen Sie ntk plugins update aus, um alle Plugin-Container-Images zu aktualisieren, und anschließend ntk plugins restart.

Nachdem der Agent konfiguriert ist, aktivieren Sie die Statistiken auf dem Authentication Server:

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

Die Metriken des Authentication Servers sind nun unter http://<internal-ip>:9394/metrics abrufbar.

Einige Metriken, die sich messen lassen:

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

Mit den folgenden Befehlen konfigurieren Sie das stats-agent-Plugin für eine VRRP-IP-Adresse:

# 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

Weisen Sie den Authentication Server nach der VRRP-Konfiguration an, die Statistiken an die VRRP-IP zu liefern: Setzen Sie STATS_HOST=10.0.1.97 und starten Sie den Dienst neu (ntk as restart).