SharePlex reports errors and other abnormal conditions in the following ways.
Event Log
SharePlex reports operational errors, notices and warning conditions to the Event Log. This log provides a perpetual step-by-step record of replication activities, errors, and events. The Event Log can help you replay the sequence of events that led up to a problem.
Examples of replication events include:
- Start or stop of sp_cop or a replication process
-
Execution of a command in sp_ctrl. User-issued commands are recorded for every SharePlex command that is issued.
Note: A user-issued command appears in the Event Log as a notice, as in the following example:
Notice 08-07-02 16:13:24.641582 23696 1 User command: rjones activate config 1route (from mycomp14)
- Database errors
- Failure of a network connection or SharePlex process
- Start or stop of a utility or script
-
Login or logout of a user
Each entry in the Event Log includes:
- The date and time of the event.
- A description of the event and any related messages (error or non-error).
- The event’s process ID number, if it is associated with a SharePlex process.
To view the Event Log
Use the show log command in sp_ctrl or open the file named event_log in the log sub-directory of the SharePlex variable-data directory.
SharePlex provides a script for unattended monitoring of this log. For more information, see Monitor events with sp_eventmon.
Note: To control the number of out-of-sync messages that Post logs when a target table is very out-of-sync, use the SP_OPO_SYNC_LOG_FREQUENCY parameter. For more information, see the SharePlex Reference Guide.
Status Database
The Status Database contains a summary of the conditions reported in the Event Log, including events that did not generate an error message or warning at the sp_ctrl user interface. This information alerts you to potential problems and helps you resolve existing ones. The Status Database may refer you to the Event Log for a more detailed explanation of a warning, notice or event.
To view the Status Database
Use the show statusdb command in sp_ctrl or open the file in the data sub-directory of the SharePlex variable-data directory.
Error Log
When the Post process detects that source and target tables are out of synchronization, it logs the first 100 SQL statements and data for the out-of-sync transactions to an error file on the target system. You can use this log to determine the extent of the out-of-sync condition, and you can use the SQL statements to repair target tables if the condition is not too severe, after first correcting the cause of the problem.
To view the Error Log
Open the ID_errlog.sql file in the log sub-directory of the SharePlex variable-data directory (where ID is the identifier of the SharePlex target, for example a target database).
Process logs
When a SharePlex process cannot process a record, the process not only logs the record to the Event Log, but also to its process log file. The process logs are primarily for use in debugging.
The name of a process log consists of the datasource identifier (such as the ORACLE_SID), the short name of the process (such as ocap, ord, opo, rcl), the file number, and the file extension (.log).
Examples:
Capture: ora10_ocap02.log
Read: ora10_ord01.log
Post: ora10_opo03.log
Reconcile: ora10_rcl01.log
The aging of old log files is performed in a circular pattern. The numbering begins with 01 and ends with 03. Up to three logs can exist at any time, including the current one. When all three logs are full (50 MB), the process starts overwriting them, beginning with the oldest one.
To view a process log
Open the file in the log sub-directory of the SharePlex variable-data directory.
Activation log
When you activate a configuration, it generates a log.
To view the activation log
Open the file named SID_oconf##.log in the log sub-directory of the SharePlex variable data directory.
Compare/repair log
The compare and repair commands log errors, messages and warnings to a log. For more information about these logs, see the compare commands in the SharePlex Reference Guide.
The information commands in sp_ctrl help you monitor different aspects of replication. Issue them frequently to:
- Monitor for out-of-sync tables.
- Verify that replication processes are running.
- View the number of replicated messages in the queues.
- View the Event Log to view warnings, errors and other notifications.
- View process statistics that are helpful for tuning and problem solving.
- Detect tables or operations that are slowing down the replication process.
List of information commands
append status |
3 |
Displays status and results of the append using and append commands. |
copy status |
3 |
Displays status and results of the copy using and copy commands. |
compare status |
3 |
Displays the status and results of the compare using and compare commands. |
lstatus |
3 |
Displays detailed information about the state of SharePlex replication. |
job status |
3 |
Displays current status and history for append, compare, copy and repair commands. |
orainfo |
3 |
Displays the Oracle database information. |
qstatus |
3 |
Displays the state of the capture, export and post queues. |
repair status |
2 |
Disaplys the status and results of the repair and repair using commands. |
report |
3 |
Displays append, compare, copy and/or repair history for a table. |
show |
3 |
Displays the source and destination of the data being processed by each replication process on a system, and displays the status of each process. |
show capture |
3 |
Displays brief or detailed statistics for the Capture process for use in tuning and problem solving. |
show config |
3 |
Displays properties of the active configuration. |
show export |
3 |
Displays the number of messages sent to the target system(s). |
show import |
3 |
Displays the number of messages received from the source system(s). |
show log |
3 |
Displays the Even Log, Command Log, Verify Log, Trace Log, or a process log. |
show post |
3 |
Displays brief or detailed statistics for the Post process for use in tuning and problem solving. |
show read |
3 |
Displays brief or detailed statistics for the Read process for use in tuning and problem solving. |
show sql |
3 |
Displays the current or last SQL statement processed by the Post process. |
show statusdb |
3 |
Displays the Status Database, which contains records of important replication events. |
show sync |
3 |
Displays information about out-of-sync conditions. |
status |
3 |
Displays an overview of the state of SharePlex replication. |
See the SharePlex Reference Guide for details about these commads.
SharePlex provides the Sp_Nt_Mon script for monitoring processing Windows systems. Sp_Nt_Mon runs in the background to monitor SharePlex and notify you of events and conditions that can adversely affect replication. This script provides a monitoring mechanism without the need for frequent status checks through sp_ctrl.
Important! Do not rename this script.
The Sp_Nt_Mon script detects and reports the following conditions by email:
- The status of the Capture, Read, Export, Import, Post, and Sp_Copsrv.exe processes.
- The volume of the capture and post queues.
- Latency between transactions being processed by Oracle and by SharePlex.
- Specific messages in the Event Log (described later in this topic)
To configure and run Sp_Nt_Mon
- Run the SpClient utility from the SharePlex programs group.
- On the SpClient toolbar, click the SpMonitor button.
- Select the port number of the instance of SharePlex that you want to monitor, then click Configure Monitor.
-
Refer to the following table to modify the properties in the sp_nt_mon.txt file. Sp_Nt_Mon reads input from this file. To make comments in this file, start each comment line with the # symbol.
Time Interval |
60 seconds |
Sets a time interval, in seconds, between monitoring polls. |
Send Email alert |
1 (enabled) |
Enables or disables email alerts. Email is the only reporting option.
0 = disabled
1 = enabled |
SMTP Server Name |
none |
Specifies the name of the SMTP server for the e-mail account. |
Email Address |
none |
Specifies one or more email addresses that will receive monitor notifications. Separate each email address with a space, for example:
Email Address: Your.Name@YourCompany.com Other.Name@YourCompany.com |
Cop
Capture
Read
Export
Import
Post |
0 (do not monitor) |
Specifies processes to monitor. A value of 1 enables monitoring and must be set for each process that you want to monitor. For example, to monitor Capture and Export, set the properties as follows:
Cop: 0
Capture: 1
Read: 0
Export: 1
Import: 0
Post: 0 |
Capture Threshold
Post Threshold |
0 (do not monitor) |
Sets the maximum number of messages that a queue can contain before an alert message is triggered.
Set a positive numeric value for each queue that you want to monitor. Set a value that is well below the amount of disk space that is allocated to this queue. This gives you enough time to add disk space or resolve any problems that are causing a backlog. |
Monitor the Event Log |
0 (do not monitor) |
Enables or disables the monitoring of supported Event Log messages.
0 = disabled
1 = enabled
The following messages are monitored:
SharePlex was shutdown
System call error
Queue partition is full
Host is down
Internal error
Out of sync
Poster failure
Parameter was changed Activate config
Deactivate config
Bad config file
sp_cop was shutdown
Child process failed
Error
ORA-error number errors |
Monitor Redo Logs |
0 (do not monitor) |
(Oracle only) Enables or disables the monitoring of Capture latency.
0 = disabled
1 = enabled |
Redo Threshold |
2 logs |
(Oracle only) Sets a value for the maximum permissible number of logs for Oracle to be ahead of SharePlex in the redo stream. When the value is reached, an alert is triggered. Use when Monitor Redo Logs is enabled. |
- Click Start to run the script. The script starts and the word Start becomes Stop. The script runs continuously to monitor SharePlex until you click Stop.
SharePlex provides agent support for Simple Network Management Protocol (SNMP) on Windows platforms supported by SharePlex replication.
Note: SharePlex provides only agent support for SNMP. It only sends SNMP traps. SharePlex does not provide an SNMP signal daemon (SNMP manager) to intercept the traps. Use the SharePlex SNMP feature only if you have a Network Management Station (NMS) to manage SNMP signals. The SharePlex SNMP agent is named snmptrap and is installed with SharePlex in the bin sub-directory of the SharePlex product directory. Do not run this program.
Enable SNMP
To enable SNMP monitoring of SharePlex replication, set the SP_SLG_SNMP_ACTIVE parameter to 1. By default, the parameter is set to 0 (disabled).
Configure the SNMP agent
The following parameters configure the SNMP agent to communicate with the NMS. Each parameter must have a value if the SP_SLG_SNMP_ACTIVE parameter is enabled.
SP_SLG_SNMP_HOST |
The name of the system (host) to which the traps will be sent |
SP_SLG_SNMP_COMMUNITY |
The community security string |
SP_SLG_SNMP_MJR_ERRNUM |
The major error number to be used by the traps |
SP_SLG_SNMP_MNR_ERRNUM |
The minor error number to be used by the traps |
Custom MIB parameters
The following parameters specify required information for a custom MIB.
SP_SLG_SNMP_ENTERPRISE_OID |
The enterprise object identifier to send with the trap. The default is 1.3.6.1.4.1.3.1.1 . |
SP_SLG_SNMP_TRAP_OID |
A custom object identifier to bind to the trap. The default is 1.3.6.1.2.1.1.1.0. |
SP_SLG_SNMP_TRAP_PROGRAM |
The name of the trap program. The default is iwsnmptrap. |
Configure the SNMP traps
The following parameters configure the SNMP agent to send traps for specific replication events. The message or error text for the event is included in the trap and is the same error that appears in the Event Log.
To enable an SNMP trap for an event, set the corresponding parameter to a value of 1. By default all traps are disabled (parameter value of 0).
SP_SLG_SNMP_INT_ERROR |
SharePlex logic errors and errors that cause processes to exit |
SP_SLG_SNMP_SYS_ERROR |
System-related errors encountered by SharePlex |
SP_SLG_SNMP_ERROR |
Other SharePlex errors |
SP_SLG_SNMP_OUT_OF_SYNC |
Replication is out of synchronization |
SP_SLG_SNMP_STARTUP |
SharePlex starts up |
SP_SLG_SNMP_SHUTDOWN |
SharePlex shuts down |
SP_SLG_SNMP_LAUNCH |
A SharePlex process starts |
SP_SLG_SNMP_EXIT |
A SharePlex process stops |