linotp.controllers.monitoring module

monitoring controller - interfaces to monitor LinOTP

class linotp.controllers.monitoring.MonitoringController(*args, **kw)[source]

Bases: linotp.lib.base.BaseController

monitoring

activeUsers()[source]
method:
monitoring/activeUsers
description:
for each realm, display the resolvers and the number of users which have at least one assigned active token per resolver the ‘total’ gives the number of all users, which are in an allowed realm and own an active token users are conted per resolver (not per realm), so if resolver is in multiple realms and one user ons tokens in 2 realms, the user will be counted only once
arguments:
  • realms - optional: takes realms, only information on these realms

    will be displayed

config()[source]

check if Config- Database exists

touches DB and checks if date of last read is new :return:

a json result with: { “head”: [], “value”: {“sync”: “True”} }
exception:
if an error occurs an exception is serialized and returned
license()[source]

return the support status, which is community support by default or the support subscription info, which could be the old license :return: json result with license info

storageEncryption()[source]

check if hsm/enckey encrypts value before storing it to config db :return: true if a new value gets encryptet before beeing stored in db

tokens()[source]
method:
monitoring/tokens

description:

Displays the number of tokens (with status) per realm (one token might be in multiple realms). The Summary gives the sum of all tokens in all given realms and might be smaller than the summ of all tokens as tokens which have two realms are only counted once!
arguments:
  • status - optional: takes assigned or unassigned, give the number

    of tokens with this characteristic

  • realms - optional: takes realms, only the number of tokens in

    these realms will be displayed

returns:
a json result with: { “head”: [], “data”: [ [row1], [row2] .. ] }
exception:
if an error occurs an exception is serialized and returned
userinfo()[source]
method:
monitoring/userinfo
description:
for each realm, display the resolvers and the number of users per resolver
arguments:
  • realms - optional: takes a realm, only information on this realm

    will be displayed

returns:
a json result with: { “head”: [], “data”: [ [row1], [row2] .. ] }