Configuring the Directory Server
Configuring Security in the Directory Server
Monitoring the Directory Server
Working With Monitor Providers
Viewing Monitoring Information Using the cn=monitor Entry
To View the Available Monitoring Information
To Monitor General-Purpose Server Information
To Monitor Version Information
To Monitor the User Root Back End
To Monitor the Backup Back End
To Monitor the monitor Back End
To Monitor the Schema Back End
To Monitor the adminRoot Back End
To Monitor the ads-truststore Back End
To Monitor the LDAP Connection Handler
To Monitor LDAP Connection Handler Statistics
To Monitor Connections on the LDAP Connection Handler
To Monitor the Administration Connector
To Monitor Administration Connector Statistics
To Monitor Connections on the Administration Connector
To Monitor the LDIF Connection Handler
To Monitor the userRoot Database Environment
To Monitor JVM Stack Trace Information
To Monitor the JVM Memory Usage
Monitoring Using Managed Tasks
Configuring Alert Notifications and Account Status Notification Handlers
To View the Replication Repair Logs
General Purpose Enterprise Monitoring Solutions
Monitoring the Directory Server With JConsole
To Configure JMX on a Directory Server Instance
Accessing a Directory Server Instance From JConsole
Viewing Directory Monitoring Information With JConsole
Monitoring the Directory Server With SNMP
Configuring SNMP in the Directory Server
To Configure SNMP in the Directory Server
To View the SNMP Connection Handler Properties
To Access SNMP on a Directory Server Instance
Monitoring the Directory Server With the Control Panel
To View Monitoring Information With the Control Panel
Configuring Logs With dsconfig
Overview of Directory Server Logs
To Configure Log Retention Policies
To Configure Log Rotation Policies
Logging Access Control Information
Differences Between Logging in Sun OpenDS Standard Edition and Sun Java System Directory Server
Configuring Alerts and Account Status Notification Handlers
Managing Account Status Notification Handlers
To View the Configured Account Status Notification Handlers
To Enable Account Status Notification Handlers
To Create a New Account Status Notification Handler
To Delete an Account Status Notification Handler
Monitoring a Replicated Topology
Monitoring Replication Status With dsreplication
The directory server supports the following alert handlers:
JMX alert handler for JMX notifications
SMTP alert handler for email notifications.
Custom alert handlers
The directory server stores alert handlers information in the configuration file under the cn=Alert Handlers,cn=config subtree. You can access the information using the dsconfig command.
$ dsconfig -D "cn=directory manager" -w password -n list-alert-handlers Alert Handler : Type : enabled ------------------:------:-------- JMX Alert Handler : jmx : false
The JMX alert handler is disabled by default. Before you begin, you must configure JMX on the directory server. For more information, see Monitoring the Directory Server With JConsole.
$ dsconfig -D "cn=directory manager" -w password -n get-alert-handler-prop \ --handler-name "JMX Alert Handler" Property : Value(s) --------------------:--------------------------------------------- disabled-alert-type : - enabled : false enabled-alert-type : -
$ dsconfig -D "cn=directory manager" -w password -n set-handler-prop \ --handler-name "JMX Alert Handler" --set enabled:true
$ dsconfig -D "cn=directory manager" -w password -n get-alert-handler-prop \ --handler-name "JMX Alert Handler" Property : Value(s) --------------------:--------------------------------------------- disabled-alert-type : - enabled : true enabled-alert-type : -
You can create a new alert handler by using dsconfig. This example configures a new SMTP handler. Before starting this procedure, ensure that you have configured an SMTP server for your directory.
$ dsconfig -D "cn=directory manager" -w password -n create-alert-handler \ --handler-name "my SMTP Handler" --type smtp --set enabled:true \ --set message-body:"Alert Type: %%alert-type%%\n\nAlert ID: \ %%alert-id%%\n\nAlert Message: %%alert-message%%" \ --set message-subject:"Alert Message" \ --set recipient-address:directorymanager@example.com \ --set sender-address:OpenDS-Alerts@directory.example.com
$ dsconfig -D "cn=directory manager" -w password -n list-alert-handlers
Note that you can disable an alert handler instead of deleting it. In this case, the alert handler is available if you need to enable it again in the future. This example removes an alert handler from the directory server.
$ dsconfig -D "cn=directory manager" -w password -n delete-alert-handler \ --handler-name "JMX Alert Handler"
The directory server sends out message alerts when an alert type event occurs in the system. The supported alert types are defined in the following table.
|
By default, all alert types are allowed. If you specify a value for the enabled-alert-type property, only alerts with one of those types are allowed. If you specify a value for the disabled-alert-type property, all alert types except for the values in that property are allowed. Alert types are specified by their Java class, as shown in this example.
This command disables the startup alert from the JMX Alert Handler.
$ dsconfig -D "cn=directory manager" -w password -n set-alert-handler-prop \ --handler-name "JMX Alert Handler" \ --set disabled-alert-type:org.opends.server.DirectoryServerStarted -n