Home
Administering
This documentation provides information about the administration tools for managing and monitoring servers and databases.
Monitoring servers
This section describes how to use the tools and features that help you monitor a Domino® system.
Monitoring the Domino® system
You can monitor system activity and platform use using the Domino® Administrator or the server console.
Event handlers
An event handler defines the action that Domino® takes when a specific event occurs.
Event handler notification methods
Depending on the type or severity of an event, you may want to be notified immediately by an alarm, email message, or server-console message. When you specify a handler notification method, you also specify where events are reported.
Using an API to create an event notification method
If you use an API, there may be additional types of notification methods. To use one of these methods, create a notification based on the name and description provided by the API.

Administering
This documentation provides information about the administration tools for managing and monitoring servers and databases.
- Administration tools
  Topics in this section describe the tools you can use to administer a Domino® server.
- Managing users
  The Administration Process helps you manage users by automating many of the associated administrative tasks. For example, if you rename a user, the Administration Process automates changing the name throughout databases in the Notes® domain by generating and carrying out a series of requests, which are posted in the Administration Requests database.
- Monitoring servers
  This section describes how to use the tools and features that help you monitor a Domino® system.
  - Monitoring the Domino® system
    You can monitor system activity and platform use using the Domino® Administrator or the server console.
    - Monitoring Configuration application (EVENTS4.NSF)
      The Monitoring Configuration application includes a configuration user interface for use with Domino® Domain Monitoring (DDM). Use this interface to set up DDM probes and a collection hierarchy of servers that collect information from other servers.
    - Monitoring server shutdown
      Domino's Shutdown Monitor task ensures that Domino® terminates when requested to do so, that is, the server does not hang while attempting to shut down.
    - Monitoring processes running in the Domino® server environment
      Domino's "Process Monitor" task applies to Domino® on Microsoft™ Windows™ platforms only. This task monitors the processes that should be running as part of the Domino server environment.
    - Monitoring events on the Domino® system
      Events signal both that the system is working smoothly, processing data, and performing tasks; or that the system is malfunctioning, perhaps by not processing data or performing required tasks.
    - Event generators
      Event generators gather information by monitoring a task or a statistic or by probing a server for access or connectivity. Each event generator has a specified threshold or condition, which, when met, causes an event to be created The event is passed to the Event Monitor task, which checks whether an associated event handler has been defined. If an event handler has not been defined, the Event Monitor task does nothing. If an event handler has been defined, the Event Monitor carries out the instructions in the event handler. The Event Monitor task, formerly know as the Event task, starts automatically when you start the server and must run on all servers that you want to monitor.
    - Monitoring iNotes® activity
      You can determine the number of active HCL iNotes® users on a system and log iNotes request information. To monitor this activity, set up activity logging to include iNotes.
    - Event handlers
      An event handler defines the action that Domino® takes when a specific event occurs.
      - Event handler notification methods
        Depending on the type or severity of an event, you may want to be notified immediately by an alarm, email message, or server-console message. When you specify a handler notification method, you also specify where events are reported.
        Using an API to create an event notification method
        If you use an API, there may be additional types of notification methods. To use one of these methods, create a notification based on the name and description provided by the API.
        Forwarding an event to the Tivoli Enterprise Console®
        You can use the event handler notification method, Forward event to Tivoli Enterprise Console®, to allow the Tivoli Enterprise Console (TEC) to receive Domino® events and reformat them as TEC events. The reformatted TEC event is then sent to the TEC server that you specify in the Configuration Settings document.
        Passing event parameters using the Run Program notification method
        To use the Run Program notification method, you must have created a program that you want to run when a particular event occurs. You must have a comprehensive understanding of the programming language you use to create the program in order to know which parameters you want to use. The run program event handler passes information to the program as a parameter when the program runs.
        Setting, modifying or deleting the Java™ server controller user's ID properties
        Use this dialog box to set, modify or delete the user ID and Internet password used to access the Java™ controller. The ID properties for the server controller are stored in the server's ID file.
        Creating a Connection document for use with a Java™ controller command
        To use the event handler of notification type Send Java Controller command, you must create a Connection document between the server running the Java™ controller and the server sending the Java controller command.
      - Event types used to specify event criteria
        When you create an event handler based on matching the event criteria, you must specify the type of event.
      - Creating an event handler
        When you create an event generator, you can launch the event handler wizard to create an event handler at the same time. You can also manually create an Event Handler document in the Monitoring Configuration database (EVENTS4.NSF).
      - Disabling an event handler
        You may want to disable an event handler that you created. For example, if you create an event handler to help you troubleshoot replication problems, after you resolve the problems, you can disable the event handler. Then, when you need to do replication troubleshooting again, just enable the event handler.
      - Creating log filters
        By default, Domino® logs all events to the log file (LOG.NSF), which can become quite large, depending on the log level set for each event. To prevent events from being logged either to the log file or to the server console, create a log filter that specifies both the type and severity of the event to filter. Then only events that meet the specified criteria appear in the log file.
      - Viewing event handlers and log filters
        You can view default and custom event handlers and log filters.
    - Viewing an event report
      The Monitoring Results database (STATREP.NSF) stores statistic and event information, depending on how you configured the Statistic Collector server task and event handler documents. For each event, a report records the server that originated the event; the time, severity, type and error code of the event; and a brief description of the event.
    - Viewing event messages, causes, and solutions
      Each event that occurs on the Domino® system has an associated event message that is stored in the Monitoring Configuration database (EVENTS4.NSF). The message text often provides information about possible causes and solutions.
    - Customizing the Domino® server and administrator console
      By creating a Server Console configuration document for the server you are monitoring, you can specify the text, background, and color attributes that the Domino® server console uses to display monitoring information. By default, the Domino Administrator server console uses the same attributes, but you can override the defaults and customize the appearance of the Domino Administrator server console.
    - Monitoring system statistics
      Domino® continuously generates and updates server statistics, which you can collect and monitor in a number of ways. From the server, you can use the Show Statistic or Show Platform Statistic commands. From the Domino Administrator, you can create statistics profiles and charts.
    - Platform statistics
      In addition to tracking server statistics, Domino® tracks operating-system performance statistics. You can view these statistics from the Domino Administrator, along with your Domino statistics, which helps you with Domino server monitoring and tuning. You can include platform statistics in any statistic monitoring task you perform with the Domino statistics, including using them in monitoring and statistic profiles, and charting them.
    - Using the Domino® Administrator to monitor statistics
      Using the Domino® Administrator, you can create a statistic profile that you use to monitor the same set of statistics periodically or to compare performance on different servers.
    - Using mail-in statistics
      If you can access Notes® mail on a server, you can collect statistics from the server and mail them to yourself. Use mail-in statistics when the Domino® Administrator is not available or you do not have administrator access to a server.
    - Charting statistics
      You can graphically display the statistics generated by Domino®, by creating statistics charts. To chart sets of statistics on a regular basis, you can define statistics profiles. Using statistics charts you can track and visualize statistics in real time or historically. Real-time charts reflect the current server activity. Historical charts pull information from the local Monitoring Results database (STATREP.NSF). You can also create statistic profiles so that you can chart a specified set of statistics routinely.
    - Publishing Domino statistics to external services
      You can set up Domino to publish Domino statistics to an external monitoring service, for example, Hosted Graphite. The service must be able to accept time series data via HTTP POST requests.
  - Server Health Monitor
    You can monitor and troubleshoot performance issues using a number of different tools.
  - Entitlement tracking
    As of Domino 12.0, a new internal mechanism is provided for collecting the highest entitlement that individual users have across a Domino domain. When a user appears in the ACL of a database with Reader access or above and that person has the right to access the server, the user is said to be an entitled user.
  - Domino® domain monitoring (DDM)
    Domino® domain monitoring (DDM) provides one location in the Domino Administrator client that you can use to view the overall status of multiple servers across one or more domains, and then use the information provided by DDM to quickly resolve problems.
  - The Domino® SNMP Agent
    The Domino® SNMP Agent enhances the monitoring and control features of Domino by enabling third-party management stations, which use industry standard SNMP, to manage aspects of the Domino server.
  - Overview of server maintenance
    As a Domino® administrator, a major part of your job is maintaining each server that you administer.
  - Tools for mail monitoring
    Domino® provides three tools that you can use to monitor mail. Message tracking allows you to track specific mail messages to determine if the intended recipients received them. Mail usage reports provide the information you need to resolve mail problems and improve the efficiency of your mail network. Mail probes test and gather statistics on mail routes.
  - Monitoring directory assistance
    You can monitor directory assistance by using Show Xdir command to display information about all the directories a server uses for directory services. You can also view directory assistance statistics.
  - Monitoring databases
    You can monitor database activity, replication, and document deletions.
  - Monitoring a cluster
    Domino® provides several ways to find out what is happening in a cluster and make adjustments to keep the cluster running smoothly and efficiently, so that no server is overloaded. You can monitor failover, workload balancing, and cluster replication to see how efficiently the cluster is running.
  - Monitoring slow or unresponsive servers with the Domino® Diagnostic Probe
    Use the Domino® Diagnostic Probe (DDP), a Java™ utility provided by Support, to monitor servers that have been intermittently slow or unresponsive. The probe is a Java process (dbopen.jar) that runs in the background. The utility probes a specific Domino server over time by invoking database open transactions. If the probe detects a slow response, it will invoke Notes® System Diagnostic (NSD) to gather diagnostic data. This data is used by Support to troubleshoot and determine the cause or causes of the performance degradation.
  - Monitoring Smart Server Startup
    With Smart Server Startup, users are prevented from connecting to a Domino server until it is fully up and ready to accept user requests. For example, during startup of the Domino server after a crash, users can connect to the Domino server only after the server has fully recovered.
  - Monitoring quality of service
    Quality of Service, or QoS, is designed to react to the general operation of a Domino® server in order to keep that server functioning reliably and always available. If QoS detects that a server is not responding or hung, QoS probing can be configured to email an administrator about the problem and/or automatically terminate the server and restart it. QoS log information can also be useful for analysis by Support.
  - Understanding Quality of Service (QoS) behavior and logging
    This topic covers details of QoS including server and server controller behavior during kill events, failover trigger, and log file content.
- Managing servers
  Manage Domino® servers by performing any of these tasks.
- Managing databases
  Topics in this section describe how to set up and manage Domino® databases.

Using an API to create an event notification method

If you use an API, there may be additional types of notification methods. To use one of these methods, create a notification based on the name and description provided by the API.

Procedure

From the Domino® Administrator, click the Configuration tab, and open the Monitoring Configuration view.
Open the Names & Messages (Advanced) > Notification Methods view, and click New Notification Method.
Enter a description of the notification method.
Enter the name of the notification method.