Active Directory Cookbook

15.9. Using the STATS Control to View LDAP Query Statistics

Problem

You want to use the STATS LDAP control to test the efficiency of a query.

Solution

Using a graphical user interface

1. Open LDP.

2. From the menu, select Connection → Connect.

3. For Server, enter the name of a domain controller (or leave blank to do a serverless bind).

4. For Port, enter 389.

5. Click OK.

6. From the menu, select Connection → Bind.

7. Enter credentials of a user to perform the search.

8. Click OK.

9. From the menu, select Options → Control.

10. For the Windows Server 2003 version of LDP, you can select Search Stats from the Load Predefined selection. For Windows 2000, add a control with the OID 1.2.840.113556.1.4.970.

11. Click OK.

12. From the menu, select Browse → Search.

13. Enter your search criteria and then click the Options button.

14. Under Search Call Type, be sure that Extended is selected.

15. Click OK and Click Run.

Discussion

The STATS control is a useful way to obtain statistics about the performance of an LDAP query. With the STATS control, you can find out information, such as the amount of time it took the server to process the query, how many entries were visited versus returned, what the search filter expanded to, and if any indexes were used. Here is an example of what the STATS control returns for a search for all group objects in the cn=Users container:

***Searching . . . ldap_search_ext_s(ld, "cn=users,DC=rallencorp,DC=com", 2, "(objectcategory=group)", attrList, 0, svrCtrls, ClntCtrls, 20, 1000 ,&msg) Result <0>: Matched DNs: Stats: Call Time: ...