CUDB Counters List

1	Introduction
1.1	Document Purpose and Scope
1.2	Revision Information
1.3	Typographic Conventions
2	Counter Descriptions
2.1	LDAP Server Counters
2.2	LDAP Node Counters
2.3	Per Database Cluster Counters
2.4	Notifications Counters
Glossary
Reference List

1 Introduction

This document lists the counters used in the Ericsson Centralized User Database (CUDB).

1.1 Document Purpose and Scope

This document provides information about the different counters made available by the CUDB. For further information on how to create and configure counters, refer to CUDB Performance Guide, Reference [1].

1.2 Revision Information

Rev. A	This document is based on 1/00651-CSH 109 067/9 with the following changes: Section 2.1: Updated section regarding the configuration of LDAP FEs. Section 2.3.2: Updated the description of `failedLdapRequests` in Table 31, and the range of DS `n`.

Rev. B	Other than editorial changes, this document has been revised as follows: Section 2.2.1, Section 2.3.1, and Section 2.3.2: Updated with Key Performance Indicators (KPIs).

Rev. C	Other than editorial changes, this document has been revised as follows: Section 2.2.1: Added new tables, Table 12, Table 13, and Table 14.

1.3 Typographic Conventions

Typographic conventions can be found in the following document:

Typographic Conventions

2 Counter Descriptions

The following table shows a brief description of the counter fields that are provided by CUDB node. This information is shown in following chapters for each counter.

Table 1 Field Description in the Counters Tables
Field	Description
Counter name	Name of the counter as it will appear in the 3GPP XML output file.
Counter group	Group to which this counter belongs.
Counter description	Brief explanation of the counter.
Counter type	A counter may be a gauge (it may increase or decrease) or be cumulative (it always increases).
Triggering event	The event or events that may increase or decrease the counter.

Note:: The maximum size for cumulative counters is 2⁶³-1. Counters are reset once they reach the maximum size.

2.1 LDAP Server Counters

These counters show information about the average of the number of LDAP operations. There is a counter per each possible LDAP server in the CUDB node.

Table 2 LDAP Server Transactions Counter n
Field	Description
Counter name	`ldapTpsAtFrontEnd`n
Counter group	`LdapFrontEnds`
Counter description	Number of LDAP operations per second being carried out by LDAP server number n
Counter type	Gauge
Triggering event	LDAP requests

TPS counter values are initialized to -2 for all LDAP Front Ends (FEs) that can be configured in a CUDB node, that is, LDAP FEs 1 to 34, and will be updated by the LDAP counters process after that.

Typically, CUDB nodes will not be fully configured with all possible LDAP FEs. TPS counters for non-configured LDAP FEs will keep the -2 value.

It is possible that, at the time the LDAP counters process tries to get information from an LDAP FE, the LDAP FE is down or not responding. TPS counters for configured but not-responding LDAP FEs will have a -1 value.

Note:: Where n is the number of the LDAP server, from 1 to 34.

Note:: This counter is incremented both by external LDAP operations received from application FEs connected to CUDB and by internal LDAP operations (that is, dummy LDAP searches used to monitor the LDAP servers).

ssh <CUDB_Node_SYSOAM_MGMT_SC-2-1_IP_Address>
cd /home/coremw_appdata/incoming/cudb-install-temp
./cudbUpgrade --system-validation config/Backup_Restore_Migration_<source_system_version>.con

2.2 LDAP Node Counters

These counters provide information about the LDAP requests handled by a CUDB node.

Note:: Only SEARCH, MODIFY, ADD, or DELETE LDAP requests are counted. BIND, UNBIND LDAP requests or requests with invalid syntax or referring to not configured schemas are not counted.

2.2.1 Overall LDAP Node Counters

This set of counters provide information about how all the LDAP requests received in the CUDB node are handled. These counters indirectly offer a summary of how the CUDB system as a whole is performing when looking at it from this CUDB node.

Table 3 LDAP Requests Received
Field	Description
Counter name	`receivedLdapReqsTotal`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests received in the CUDB node.
Counter type	Cumulative
Triggering event	LDAP requests

Table 4 LDAP Requests Processed Locally
Field	Description
Counter name	`processedLdapReqsLocalNode`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests processed locally, answered by querying any of the local database clusters, PLDB or DSs. This counter only considers the database cluster where the actual data related to the LDAP request is stored; PLDB lookups to figure out where (in which DSG) the requested piece of data are not counted here.
Counter type	Cumulative
Triggering event	LDAP requests

Table 5 LDAP Requests Processed at Other Nodes
Field	Description
Counter name	`processedLdapReqsRemoteNodes`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests processed at other nodes. This counter includes LDAP requests that were proxied to another CUDB node in the system and that were processed locally there or proxied again and processed locally in a third CUDB node.
Counter type	Cumulative
Triggering event	LDAP requests

Table 6 LDAP Requests Dropped Because the Local LDAP Servers Are Overloaded
Field	Description
Counter name	`droppedLdapReqsLocalLdapLayer`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests dropped because the local LDAP servers are overloaded.
Counter type	Cumulative
Triggering event	LDAP requests

Table 7 LDAP Requests Dropped Because the Local Clusters Are Overloaded
Field	Description
Counter name	`droppedLdapReqsLocalClusters`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests dropped because the local database clusters are overloaded. This counter includes: LDAP requests dropped by the LDAP FEs because the clusters are overloaded LDAP requests where any of the related database operations was rejected by the local cluster itself due to overload.
Counter type	Cumulative
Triggering event	LDAP requests

Table 8 LDAP Requests Failed to Be Processed Locally
Field	Description
Counter name	`failedLdapReqsLocalNode`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests failed to be processed locally. This counter includes: LDAP requests intended to be processed at the master replica of a masterless DSG or PLDB. LDAP requests intended to be processed at the master replica of a DSG (or PLDB) when a master election is ongoing. LDAP requests received while the local replica of PLDB is down. LDAP requests intended to be processed at a DSG when no replica of that DSG is available. LDAP requests intended to be processed at a local DS (or PLDB) when the local cluster happens to be unreachable. Write LDAP requests on an entry which is blocked during reallocation when the master replica of the DSG storing that LDAP entry is hosted in the local node. Write LDAP requests on a DSG (or PLDB) whose master replica is hosted in the local node and is full. LDAP requests not processed due to thread limits in the LDAP FE. LDAP search requests intended to be handled locally that were not answered within the time limit set for the operation.
Counter type	Cumulative
Triggering event	LDAP requests

Table 9 LDAP Requests Not Processed at Other Nodes
Field	Description
Counter name	`nonProcessedLdapReqsRemoteNodes`
Counter group	`LdapNodeOverall`
Counter description	Number of LDAP requests not processed on other nodes. This counter includes every kind of operation to be processed on a different node but that was not, because: they were proxied to another node but turned out to be "Dropped Because the Local LDAP FEs Are Overloaded", "Dropped Because the Local Clusters Are Overloaded" or "Failed to Be Processed Locally" operations in that remote node. they were proxied to another node but the time limit for the operation was reached before a response was received from the remote node.
Counter type	Cumulative
Triggering event	LDAP requests

Table 10 Processing Capacity Used by LDAP Requests
Field⁽¹⁾	Description
KPI name	`kpiLdapFeLoad`
KPI group	`LdapNodeOverall`
KPI description	Processing capacity used by LDAP requests, in %.⁽²⁾
KPI type	Gauge
Triggering event	LDAP requests

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) The average of the LDAP FE load of the associated virtual cores within the node for the previous 15 minute monitoring period.

Table 11 Percentage of LDAP Requests Dropped Because LDAP FE Is Overloaded
Field⁽¹⁾	Description
KPI name	`kpiRatioDroppedLdap`
KPI group	`LdapNodeOverall`
KPI description	Ratio of LDAP requests dropped due to the overload of the local LDAP FE over the total number of LDAP requests received during the same period, in ⁰`/`₀₀₀^o/_ooo.⁽²⁾
KPI type	Gauge
Triggering event	LDAP requests

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) Calculated as the average of the values collected during the previous 15 minute monitoring period.

The following relationship holds among the above counters:

receivedLdapReqsTotal = processedLdapReqsLocalNode + processedLdapReqsRemoteNodes + droppedLdapReqsLocalLdapLayer + droppedLdapReqsLocalClusters + failedLdapReqsLocalNode + nonProcessedLdapReqsRemoteNodes

Table 12 Number of Local Read LDAP Requests Processed in the Replica of Current Node
Field	Description
Counter name	`processedLocalReadsLocalNode`
Counter group	`LdapNodeOverall`
Counter description	Number of local read LDAP requests processed at a local DS replica. It counts direct requests received from a client application FE (it does not count incoming proxy operations from other CUDB nodes) that fulfill all the following conditions: LDAP search operations, excluding distributed searches, received from an LDAP user configured with `ReadModeInDS=LP` and which are not overridden by the `ReadMode` LDAP control. For more information, refer to the ReadMode Control section of CUDB LDAP Interwork Description, Reference [2]. Operations processed at this node.
Counter type	Cumulative
Triggering event	LDAP search requests

Table 13 Number of Local Read LDAP Requests Processed at a DS Replica within the Same Site
Field	Description
Counter name	`processedLocalReadsOtherNodesInSite`
Counter group	`LdapNodeOverall`
Counter description	Number of local read LDAP requests processed at a DS replica within the same site. It counts direct requests received from a client application FE (it does not count incoming proxy operations from other CUDB nodes) that fulfill all the following conditions: LDAP search operations, excluding distributed searches, received from an LDAP user configured with `ReadModeInDS=LP` and which are not overridden by the `ReadMode` LDAP control. For more information, refer to the ReadMode Control section of CUDB LDAP Interwork Description, Reference [2] . Operations proxied towards nodes within the same site, because either there is no available replica of the target DS in the same site or the conditions to apply local reads are not met.
Counter type	Cumulative
Triggering event	LDAP search requests

The total number of Local Reads for users with ReadModeInDS=LP configuration, that is, the total count of LDAP search requests terminated in any node sitting in the same site where the original client search was received, is the sum of the previous two counters (processedLocalReadsLocalNode + processedLocalReadsOtherNodesInSite). Thus, either a local read ended in the same node or in another peer node but still in the same network site.

Table 14 Number of Local Read LDAP Requests Processed at a DS Replica in a Different Site
Field	Description
Counter name	`processedLocalReadsRemoteSites`
Counter group	`LdapNodeOverall`
Counter description	Number of local read LDAP requests processed at a DS replica in a different site. It counts direct requests received from a client application FE (it does not count incoming proxy operations from other CUDB nodes) that fulfill all the following conditions: LDAP search operations, excluding distributed searches, received from an LDAP user configured with `ReadModeInDS=LP` and which are not overridden by the `ReadMode` LDAP control. For more information, refer to the ReadMode Control section of CUDB LDAP Interwork Description, Reference [2]. Operations proxied towards nodes in a different site, because either there is no available replica of the target DS in the same site or the conditions to apply local reads are not met.
Counter type	Cumulative
Triggering event	LDAP search requests

2.2.2 Per-Application Group LDAP Node Counters

This subset of counters provides information about the LDAP requests handled by a CUDB node on a per-application group basis. LDAP users can be mapped to application groups by means of a configuration parameter, countersGroup, part of the CudbLdapUser class. For details on this parameter, refer to CUDB Node Configuration Data Model Description, Reference [3].

There are four configurable application groups, AppGroupn, with n ranging from 1 to 4. A fifth, "catch all", application group gathers any LDAP users not assigned to one of the four configurable application groups.

Table 15 LDAP Requests Received from LDAP Users Belonging to Application Group n
Field	Description
Counter name	`receivedLdapReqsAppGrp`n
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users belonging to application group n.
Counter type	Cumulative
Triggering event	LDAP requests

Table 16 LDAP Requests Received from LDAP Users Belonging to Application Group n That Were Processed
Field	Description
Counter name	`processedLdapReqsAppGrp`n
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users belonging to application group n and that were processed.
Counter type	Cumulative
Triggering event	LDAP requests

Table 17 LDAP Requests Received from LDAP Users Belonging to Application Group n That Were Dropped or Failed to Be Processed
Field	Description
Counter name	`droppedAndFailedLdapReqsAppGrp`n
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users belonging to application group n and that were: dropped because any of the components in the CUDB was overloaded, or failed to be processed due to one of the reasons indicated in Table 8.
Counter type	Cumulative
Triggering event	LDAP requests

Table 18 LDAP Requests Received from LDAP Users That Do Not Belong to Any Application Group
Field	Description
Counter name	`receivedLdapReqsCatchAll`
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users that do not belong to any of the four configurable application groups.
Counter type	Cumulative
Triggering event	LDAP requests

Table 19 LDAP Requests Received from LDAP Users That Do Not Belong to Any Application Group That Were Processed
Field	Description
Counter name	`processedLdapReqsCatchAll`
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users that do not belong to any of the four configurable application groups and that were processed.
Counter type	Cumulative
Triggering event	LDAP requests

Table 20 LDAP Requests Received from LDAP Users That Do Not belong to Any Application Group That Were Dropped or Failed to Be Processed
Field	Description
Counter name	`droppedAndFailedLdapReqsCatchAll`
Counter group	`LdapNodePerApplication`
Counter description	Number of LDAP requests received from LDAP users that do not belong to any of the four configurable application groups and that were: dropped because any of the components in the CUDB was overloaded, or failed to be processed due to one of the reasons indicated in Table 8.
Counter type	Cumulative
Triggering event	LDAP requests

The following relationship holds among the above counters:

receivedLdapReqsAppGrpn = processedLdapReqsAppGrpn + droppedAndFailedLdapReqsAppGrpn

receivedLdapReqsCatchAll = processedLdapReqsCatchAll + droppedAndFailedLdapReqsCatchAll

2.3 Per Database Cluster Counters

2.3.1 PLDB Cluster Counters

This set of counters provides information about the local PLDB database cluster. Some counters report how the cluster is performing as far as LDAP processing is concerned. Other counters reports cluster memory usage and used processing capacity.

PLDB lookups to figure out where (in which DSG) the requested piece of data is are counted here. So, if an LDAP operation involves a PLDB lookup and after that one or several other databases are accessed, the counters incremented are: a PLDB counter and a counter for each of the other databases that have been accessed.

Note:: Only SEARCH, MODIFY, ADD or DELETE LDAP requests are counted. BIND, UNBIND LDAP requests or requests with invalid syntax or referring to not configured schemas are not counted.

Table 21 LDAP Requests That Required Access to the PLDB Cluster
Field	Description
Counter name	`intendedLdapRequests`
Counter group	`Pldb`
Counter description	Number of LDAP requests that required access to the PLDB.
Counter type	Cumulative
Triggering event	LDAP requests

Table 22 LDAP Requests That Actually Accessed the PLDB
Field	Description
Counter name	`processedLdapRequests`
Counter group	`Pldb`
Counter description	Number of LDAP requests that actually accessed the PLDB.
Counter type	Cumulative
Triggering event	LDAP requests

Table 23 LDAP Requests Dropped Because the PLDB Cluster Is Overloaded
Field	Description
Counter name	`droppedLdapRequests`
Counter group	`Pldb`
Counter description	Number of LDAP requests dropped because the PLDB is overloaded. This counter includes: LDAP requests dropped by the LDAP FEs (first line of defense) because the cluster is overloaded, and LDAP requests where any of the related database operations was rejected by the local cluster itself due to overload.
Counter type	Cumulative
Triggering event	LDAP requests

Table 24 LDAP Requests Failed to Be Processed by the PLDB
Field	Description
Counter name	`failedLdapRequests`
Counter group	`Pldb`
Counter description	Number of LDAP requests failed to be processed by the PLDB. These would fall in one of the following cases: LDAP requests intended to be processed at the local PLDB when the local PLDB happens to be unreachable. Write LDAP requests on the PLDB when the master replica is hosted in the local node and is full.
Counter type	Cumulative
Triggering event	LDAP requests

Table 25 PLDB Cluster Memory Usage
Field⁽¹⁾	Description
KPI name	`memoryUsage`
KPI group	`Pldb`
KPI description	Used database memory pages over total database memory pages, in %.
KPI type	Gauge
Triggering event	Changes in the amount of data stored in PLDB

(1) Valid for CUDB systems deployed on native BSP 8100 only.

Table 26 Used Processing Capacity of the PLDB Cluster
Field⁽¹⁾	Description
KPI name	`kpiClusterLoad`
KPI group	PLDB load indicator
KPI description	Used processing capacity of the PLDB cluster, in %.⁽²⁾
KPI type	Gauge
Triggering event	PLDB cluster requests

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) The average value of the peak PLDB load in the associated virtual cores for the previous 15 minute monitoring period.

Table 27 Percentage of LDAP Requests Dropped Because PLDB Is Overloaded
Field⁽¹⁾	Description
KPI name	`kpiRatioDroppedCluster`
KPI group	PLDB dropped LDAP requests ratio indicator.
KPI description	Ratio of LDAP requests dropped due to the overload of PLDB, including requests dropped by the LDAP FE and by the local cluster, over the total number of LDAP requests that attempted to access PLDB during the same period, in ⁰`/`₀₀₀^o/_ooo.⁽²⁾
KPI type	Gauge
Triggering event	PLDB cluster requests

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) Calculated as the average of the values collected during the previous 15 minute monitoring period.

2.3.2 DS Cluster Counters

These sets of counters provide information about each of the local DSn database clusters, with n ranging from 1 to 17. Some counters report how the DSn cluster is performing as far as LDAP processing is concerned. Other counters report DSn cluster memory usage and used processing capacity.

Note:: Only SEARCH, MODIFY, ADD or DELETE LDAP requests are counted. BIND, UNBIND LDAP requests or requests with invalid syntax or referring to not configured schemas are not counted.

Table 28 LDAP Requests That Required Access to DSn
Field	Description
Counter name	`intendedLdapRequests`
Counter group	`Ds`n
Counter description	Number of LDAP requests that required access to DSn.
Counter type	Cumulative
Triggering event	LDAP requests

Table 29 LDAP Requests That Actually Accessed DSn
Field	Description
Counter name	`processedLdapRequests`
Counter group	`Ds`n
Counter description	Number of LDAP requests that actually accessed DSn.
Counter type	Cumulative
Triggering event	LDAP requests

Table 30 LDAP Requests Dropped Because DSn Is Overloaded
Field	Description
Counter name	`droppedLdapRequests`
Counter group	`Ds`n
Counter description	Number of LDAP requests dropped because DSn is overloaded. This counter includes: LDAP requests dropped by the LDAP FEs (first line of defense) because the cluster is overloaded. LDAP requests where any of the related database operations was rejected by the local cluster itself due to overload. Note: In case of LDAP search operations that affect several DSs, if the operation is rejected due to overload in any of the DSs, this counter will be incremented for all the affected DSs and not for just the ones overloaded.
Counter type	Cumulative
Triggering event	LDAP requests

Table 31 LDAP Requests Failed to Be Processed by DSn
Field	Description
Counter name	`failedLdapRequests`
Counter group	`Ds`n
Counter description	Number of LDAP requests failed to be processed by DSn. LDAP requests are intended to be processed at a local DS when that local DS happens to be unreachable. Note: Even though it may seem reasonable to also count as failed operations for a DS those that fail either because of a lock due to reallocation, they will not be counted as such. In these cases, the overall counter for failed operations will be incremented as well as the one for processed operations in the per local cluster counters group for the PLDB but no update will be done on the per local cluster counters for the target DS. Note: In case of LDAP search operations that affect several DSs, if the processing in any of the DS fails, this counter will be incremented for all the affected DSs and not for just the ones for which the operation failed.
Counter type	Cumulative
Triggering event	LDAP requests

Table 32 DS Cluster Memory Usage
Field⁽¹⁾	Description
KPI name	`memoryUsage`
KPI group	`Ds`n
KPI description	Used database memory pages over total database memory pages, in %.
KPI type	Gauge
Triggering event	Changes in the amount of data stored in DSn

(1) Valid for CUDB systems deployed on native BSP 8100 only.

Table 33 Used Processing Capacity of the DSn Cluster
Field⁽¹⁾	Description
KPI name	`kpiClusterLoad`
KPI group	DSG load indicator
KPI description	Used processing capacity of the DS `n` cluster, in %.⁽²⁾
KPI type	Gauge
Triggering event	DS `n` cluster requests

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) The average value of the peak PLDB load in the associated virtual cores for the previous 15 minute monitoring period.

Table 34 Percentage of LDAP Requests Dropped Because DSn Is Overloaded
Field⁽¹⁾	Description
KPI name	`kpiRatioDroppedCluster`
KPI group	Dropped LDAP requests ratio indicators
KPI description	Ratio of dropped LDAP requests due to overload of the DS `n`, including requests dropped by the LDAP FE and by the local cluster, over the total number of LDAP requests that attempted to access DS `n` during the same period, in ⁰`/`₀₀₀^o/_ooo.⁽²⁾
KPI type	Gauge
Triggering event	DS `n`

(1) Valid for CUDB systems deployed on native BSP 8100 only.

(2) Calculated as the average of the values collected during the previous 15 minute monitoring period.

2.4 Notifications Counters

These counters show information about notifications sent to other application FEs. For more details, refer to CUDB Notifications, Reference [4].

Table 35 Notifications Counter
Field	Description
Counter name	`notificationsSent`
Counter group	`SoapNotifications`
Counter description	The accumulated number of total notifications sent from a CUDB node.
Counter type	Cumulative
Triggering event	Any event configured in CUDB to trigger a notification.

Table 36 Failed Notifications Counter
Field	Description
Counter name	`notificationsFailed`
Counter group	`SoapNotifications`
Counter description	The accumulated number of failures detected in the acknowledgement from notification recipients, accounted per CUDB node.
Counter type	Cumulative
Triggering event	Any faulty acknowledgement to a notification sent by any CUDB node.

Glossary

For the terms, definitions, acronyms and abbreviations used in this document, refer to CUDB Glossary of Terms And Acronyms, Reference [5].

Reference List

CUDB Documents
[1] CUDB Performance Guide.
[2] CUDB LDAP Interwork Description.
[3] CUDB Node Configuration Data Model Description.
[4] CUDB Notifications.
[5] CUDB Glossary of Terms And Acronyms.