Monitoring performance
Active Roles includes Windows Performance Monitor (perfmon) counters, which can be used to monitor and assess the health of the Administration Service.
NOTE: One Identity Support cannot provide health thresholds, as health metrics are unique to each environment. Because of this, One Identity recommends gathering a baseline by monitoring a normal business week and noting daily patterns when the server is under an average load.
The following object groups are available on the Administration Service instance:
-
Requests: Counts data management requests submitted to the Administration Service. Contains the following counters:
-
Request average execution time: The average run time of a request.
-
Requests failed: The total number of failed requests.
-
Requests failed (Access Denied): The total number of requests that failed due to insufficient permissions.
-
Requests failed (Other): The total number of requests that failed due to other errors.
-
Requests failed (Policy Violation): The total number of requests that failed due to Active Roles policy violation.
-
Requests in progress: The current number of requests that are being processed.
-
Requests total: The total number of requests.
-
Requests/sec: The number of requests that are received by the Administration Service per second.
-
LDAP operations: Counts LDAP requests issued by the Administration Service. Contains the following counters:
-
LDAP operation average time: The average runtime of LDAP operations that the Administration Service runs.
-
LDAP operation count: The total number of LDAP operations that the Administration Service runs.
-
LDAP operations in progress: The current number of Administration Service LDAP operations in progress.
-
LDAP operations/sec: The number of LDAP operations that the Administration Service runs per second.
-
Permissions propagation: Counts changes to Active Directory security that were made by the Administration Service. Contains the following counters:
-
Permission propagation: objects modified/sec: The number of objects that were modified as a result of permission propagation per second.
-
Permission propagation: objects pending: The number of objects to be evaluated for permission propagation.
-
Permission propagation: total objects modified: The total number of objects that were modified as a result of permission propagation.
-
External changes: Counts data changes polled by the Administration Service from Active Directory, and changes made to the Administration Database. Contains the following counters:
-
AD changes processed/sec: The number of changes that are received from Active Directory and processed by the Administration Service per second.
-
Changes queue length (AD + Database): The number of unprocessed changes that are received from Active Directory and from the Administration Database.
-
Database changes processed/sec: The number of changes that are received from the Administration Database and processed by the Administration Service per second.
-
Script modules: Counts the average runtime of Active Roles script modules, the number of times a particular script module was initiated, and the number of script module instances currently running. Contains the following counters:
-
Script module average execution time: The average runtime of the script module.
-
Script module execution count: The number of times the script module was initiated.
-
Script modules executing: The current number of script module instances being initiated.
-
Miscellaneous: Counts the number of clients connected to the Administration Service and the number of queued post-policy processing operations. Contains the following counters:
To add Administration Service performance counters
-
To start perfmon, in the Windows Search box, type perfmon and press Enter.
-
In the Console tree, click Monitoring Tools > Performance Monitor.
-
To display the Add Counters dialog, in the details pane, click + or press Ctrl+N.
-
Select the Show description check box to display a description of the selected performance counter.
-
From the list in the Performance object box, select an object that begins with the AR Server prefix. For example, AR Server:Requests.
-
Select the item or items from the list of counters. For example, Requests/sec.
-
Click Add. Then, when you finished adding items, click Close.
Perfmon then adds the monitoring data for the selected counters in the details pane.
Customizing the Console
The Active Roles Console provides a convenient way to customize object creation wizards and property pages found in the Console, and to customize display names for object types and object properties. Customization is performed through the use of Active Directory objects called display specifiers.
Each display specifier object holds information describing the various user interface elements for a particular object type. These elements include (but not limited to) creation wizard pages, property pages, and names to use for object types and properties in user interfaces.
The following sections summarize the customization-related features that are based on the use of display specifiers:
-
Other Properties page in the object creation wizard
-
Other Properties tab in the Properties dialog
-
Customizing display names
Other Properties tab in the Properties dialog
The Active Roles Console also makes it possible to extend the Properties dialog for directory objects with an extra tab named Other Properties, allowing the management of a custom set of object properties through the use of the Properties command.
The Active Roles Console makes it easy to view or modify the set of properties on the Other Properties tab by using a separate tab in the Properties dialog for display specifier objects. In this way, you can customize the set of properties included on the Other Properties tab. Note that the Properties dialog only includes the Other Properties tab if there are any properties to display on that tab.
The Other Properties to Display tab can be used to add or remove properties from the Other Properties tab, only affecting the object type that the display specifier is associated with. The Other Properties to Display tab lists the object properties included on the Other Properties tab for that object type, and allows you to make changes to the list.
You can use the following instructions to add the Other Properties tab to the Properties dialog for user objects. Similarly, you can extend the property pages for a different object type by creating and configuring a custom display specifier for that object type. For example, to extend the Properties dialog for Group, Computer, or Organizational Unit, create and configure a custom display specifier named group-Display, computer-Display, or organizationalUnit-Display, respectively.
NOTE: The names of display specifiers are case-sensitive, so you must type the name exactly as specified in the Active Directory schema. To view the names of display specifiers, you can use the Console to examine the Active Directory > Configuration Container > Display Specifiers > 409 container in the Raw view mode.
To extend the Properties dialog for User objects
-
Open the Active Roles Console and switch into Raw view mode: Select View > Mode, then click Raw Mode and click OK.
-
In the Console tree, expand Configuration > Application Configuration, and select the Active Roles Display Specifiers (Custom) container.
-
Use the All Tasks > Advanced Create command to create the appropriate locale container.
The custom display specifier must be created in the locale container matching the locale of your environment. These locale containers are named using the hex representation of that locale’s LCID. Thus the US/English locale’s container is named 409, the German locale’s container is named 407, the Japanese locale’s container is named 411, and so forth.
You may need to first create the appropriate locale container. You can do this by using the All Tasks > Advanced Create command to create an object of the EDS-Display-Specifier-Container class.
-
In the locale container, create the custom display specifier named user-Display.
You can do this by using the All Tasks > Advanced Create command on the locale container to create an object of the Display-Specifier class. Note that the name of the display specifier is case-sensitive, so you should type the name for the new display specifier exactly user-Display, not user-display or User-display.
-
In the details pane, right-click user-Display and click Properties.
-
Navigate to the Other Properties to Display tab.
-
Add one or more properties to the Other properties on the object property pages list. Then, click OK.
-
Restart the Administration Service and reconnect the Console to the Service, for your changes to take effect.
As a result of these steps, the Properties dialog includes the Other Properties tab where you can view or modify values of the properties you selected in Step 7. You can access that tab in the Active Roles Console by right-clicking a user account and clicking Properties.
Other Properties page in object creation wizard
In the Active Roles Console, directory objects are created using creation wizards. Thus, creating a user account starts the New Object - User wizard. The Active Roles Console makes it possible to extend creation wizards with an extra page allowing additional properties to be populated in the course of the object creation process.
The Active Roles Console makes it easy to view or modify the set of properties on the wizard extension page by using a separate tab in the Properties dialog for display specifier objects. The Other Properties to Display tab provides a way to customize the set of properties included on the extension page of object creation wizards. If there are no properties to include on the extension page, the page is not displayed.
The Other Properties to Display tab can be used to add or remove properties from the extension page of the creation wizard for the object type that the display specifier is associated with. The tab lists the object properties included on the extension page, and allows you to make changes to that list.
You can use the following instructions to add the Other Properties page to the New Object - User wizard. Similarly, you can extend the creation wizard for a different object type by creating and configuring a custom display specifier for that object type. For example, to extend the wizard for Group, Computer, or Organizational Unit, create and configure a custom display specifier named group-Display, computer-Display, or organizationalUnit-Display, respectively.
NOTE: The names of display specifiers are case-sensitive, so you must type the name exactly as specified in the Active Directory schema. To view the names of display specifiers, you can use the Console to examine the Active Directory > Configuration Container > Display Specifiers > 409 container in the Raw view mode.
To extend the New Object - User wizard
-
Open the Active Roles Console and switch into Raw view mode: Select View > Mode, then click Raw Mode and click OK.
-
In the Console tree, expand Configuration > Application Configuration, and select the Active Roles Display Specifiers (Custom) container.
-
Use the All Tasks > Advanced Create command to create the appropriate locale container.
The custom display specifier must be created in the locale container matching the locale of your environment. These locale containers are named using the hex representation of that locale’s LCID. Thus the US/English locale’s container is named 409, the German locale’s container is named 407, the Japanese locale’s container is named 411, and so forth.
You may need to first create the appropriate locale container. You can do this by using the All Tasks > Advanced Create command to create an object of the EDS-Display-Specifier-Container class.
-
In the locale container, create the custom display specifier named user-Display.
You can do this by using the All Tasks > Advanced Create command on the locale container to create an object of the Display-Specifier class.
NOTE: The name of the display specifier is case-sensitive, so you should type the name for the new display specifier exactly user-Display, not user-display or User-display.
-
In the details pane, right-click user-Display and click Properties.
-
Navigate to the Other Properties to Display tab.
-
Add one or more properties to the Other properties in the object creation wizard list. Then, click OK.
-
Restart the Administration Service and reconnect the Console to the Service for your changes to take effect.
As a result of these steps, the New Object - User wizard includes an extra page where you can specify values for the properties you selected in Step 7. You can start the wizard in the Active Roles Console by right-clicking an organizational unit in the Console tree and selecting New > User. Follow the wizard steps to reach the page containing the list of “other” properties.