SLAPO-RESULTSTATS(5)

NAME
slapo-resultstats - Operation result statistics for slapd

SYNOPSIS
ETCDIR/slapd.conf

DESCRIPTION
The resultstats overlay adds per-operation counters for LDAP operation results and exposes them via cn=monitor. Result codes from LdapSuccess(0) to LdapOther(80) are counted separately as individual values. Codes higher than that are counted together.

The overlay can be configured on a particular database, or on the front-end, or both. When configured on the front-end, it will count operations processed by all databases. When configured on a particular databases, only operations processed by that database will be counted. Monitoring must be enabled for the database (mdb databases have monitoring on by default), and cn=monitor bust be configured.

Note: Bind request responses will be counted for the database where the identity used is located. For example, binding with the rootdn of the database will be counted for that database, but anonymous binds will be counted only at the front-end level. Failed schema checks (such as undefinedAttributeType) cannot be counted at all, since they happen before a database is chosen.

When enabled, the resultstats overlay will add a cn=Result Stats container under the database entry in cn=monitor, and under it entries for all types of LDAP operations. The statistic is exposed via the olmResultCodeStat attribute with the x-resultcode-<number> tag. Errors higher than 80 will be exposed under the x-resultcode-more tag. Only result codes with counters higher than 0 will be displayed.

EXAPLES
This is an example entry for search requests, where we have 1 successful operation and one that returned NoSuchObject(32)

dn: cn=Search,cn=Result Stats,cn=database 2,cn=databases,cn=monitor
objectClass: olmResultStatOperation
olmResultCodeStat;x-resultcode-0: 1
olmResultCodeStat;x-resultcode-32: 1
entryDN: cn=Search,cn=Result Stats,cn=database 2,cn=databases,cn=monitor

CONFIGURATION
This overlay does not have any configuration directives.

Configuration Example
moduleload resultstats.la
database config
rootdn cn=config
rootpw password
#resultstats configured on the front-end
#entries will appear under cn=Result Stats,cn=database 0,cn=databases,cn=monitor
overlay resultstats
database monitor
database mdb
suffix dc=example,dc=com
rootdn cn=admin,dc=example,dc=com
rootpw password
#resultstats configured on this database
#entries will appear under cn=Result Stats,cn=database 2,cn=databases,cn=monitor
overlay resultstats

FILES

ETCDIR/slapd.conf
    default slapd configuration file

SEE ALSO
slapd.conf(5), slapd-monitor(5),

AUTHOR
Nadezhda Ivanova, on behalf of Symas Corp.