Product analytics

Introduction

The product analytics report contains information about the usage of the nevis components, such as the number of patterns used in the nevisAdmin 4 projects, the used auth states in the running nevisAuth instances or the number of active users in nevisIDM.

The information is based on a group of metrics queried from a connected Prometheus instance.

Requirements

The generation of the report requires connection to a Prometheus instance, and metrics forwarding configured for the nevis components including nevisAdmin 4. For more information see: OpenTelemetry

Change the Configuration

The settings below are configured in /var/opt/nevisadmin4/conf/nevisadmin4.yml.

Configure the base url where the Prometheus instance is reachable. Username and password is required in case basic authentication is enabled for the instance.

nevisadmin:
  product-analytics:
    prometheus:
      url: https://prometheus.example.dev/
      password: <password>
      username: <username>

Usage

The product analytics report can be downloaded from the top right context menu by selecting the Download analytics data option.

A report with some example metrics can be seen below:

{
  "resultType" : "vector",
  "result" : [ {
    "metric" : {
      "__name__" : "nevisadmin_user_count",
      "instance" : "nevisadmin4-0",
      "job" : "nevisadmin4-monitoring",
      "type" : "nevis-product-analytics"
    },
    "value" : [ 1.710242830342E9, "1" ]
  }, {
    "metric" : {
      "__name__" : "nevisadmin_version",
      "instance" : "nevisadmin4-0",
      "job" : "nevisadmin4-monitoring",
      "type" : "nevis-product-analytics",
      "version" : "8.2405.0.SNAPSHOT"
    },
    "value" : [ 1.710242830342E9, "1" ]
  }, {
    "metric" : {
      "__name__" : "nevisauth_authstate_classes",
      "classes" : "[ch.nevis.esauth.auth.states.scripting.ScriptState, ch.nevis.esauth.auth.states.sectoken.TokenAssemblerState, ch.nevis.esauth.auth.states.standard.AuthDone, ch.nevis.esauth.auth.states.standard.AuthGeneric, ch.nevis.esauth.auth.states.standard.AuthLogout, ch.nevis.esauth.auth.states.standard.ConditionalDispatcherState, ch.nevis.idm.authstate.IdmChangePasswordState, ch.nevis.idm.authstate.IdmGetPropertiesState, ch.nevis.idm.authstate.IdmPasswordVerifyState]",
      "instance" : "auth-586dcfc4cb-djxx5",
      "job" : "auth",
      "type" : "nevis-product-analytics"
    },
    "value" : [ 1.710242830342E9, "1" ]
  }, {
    "metric" : {
      "__name__" : "nevislogrend_loginapp_count",
      "instance" : "login-7974cc579c-h66vb",
      "job" : "login",
      "type" : "nevis-product-analytics"
    },
    "value" : [ 1.710242830342E9, "1" ]
  }, {
    "metric" : {
      "__name__" : "number_of_active_users",
      "instance" : "idm-fbdffd694-b4znv",
      "job" : "idm",
      "type" : "nevis-product-analytics"
    },
    "value" : [ 1.710242830342E9, "6" ]
  } ]
}