Chat now with support
Chat with Support

SharePlex 8.6.6 - Administration Guide

About this Guide Conventions used in this guide Overview of SharePlex Run SharePlex Run multiple instances of SharePlex Execute commands in sp_ctrl SharePlex parameters Prepare an Oracle environment for replication Create a configuration file Configure replication to Open Target targets Configure a replication strategy Configure partitioned replication Configure named queues Configure SharePlex to maintain a change history target Replicate Oracle DDL Set up error handling Transform data Configure SharePlex security features Activate replication in your production environment Monitor SharePlex Prevent and solve replication problems Repair out-of-sync Data Procedures to maintain Oracle high availability Make changes to an active replication environment Apply an Oracle application patch or upgrade Back up Oracle data on the source or target Tune the Capture process Tune the Post process Appendix A: Peer-To-Peer Diagram Appendix B: SharePlex environment variables

Monitor processes with sp_ps

Monitor SharePlex > Run monitor scripts on UNIX > Monitor processes with sp_ps

The sp_ps monitoring utility monitors all SharePlex processes, including child processes, associated with a specified sp_cop instance. It scans the processes at regular intervals and reports abnormal conditions to one or more log files. It can monitor multiple installations of SharePlex on one or more systems, and it supports uni-directional and bi-directional (peer-to-peer) configurations.

Prepare to run sp_ps

Before running the script, perform the following tasks.

Satisfy requirements

See Requirements for using the monitoring scripts before using this script. Note: The script must be run in the ksh shell.

Set the scan interval

The scan interval specifies how long the sp_ps program waits between checks. The default is 2,000 seconds. To specify a different scan interval, follow these steps.

  1. Open the sp_ps file in the app-modules directory of the SharePlex product directory.
  2. Set the interval= parameter to the required scan interval. Use any positive integer, for example:

    interval=1500

Define email addresses

To use the e-mail notification feature, define the e-mail address(es) in the script before running it.

  1. Open the script in the util directory of the SharePlex product directory.
  2. Add any number of address strings after the MailUserName= variable. Use the full e-mail and/or pager address. Separate multiple entries with a comma, as shown in the following example:

    MailUserName=scott@company.com,12345678910@pageservice.com

Note: The e-mail/paging option is enabled by default for sp_ps, but confirm that it was not changed. In the script, MAILOPTION=TRUE enables e-mail notifications and MAILOPTION=FALSE disables them.

Run sp_ps

Run the script from the util sub-directory of the SharePlex product directory.

Syntax

nohup sp_ps ['sp_cop -u name'] CONFIGURATION [> /dev/null] [ &]

 

Table 19: Required arguments

Argument Description
nohup sp_ps Directs the script to continue running in the background if the user logs out. This ensures continuous monitoring. The sp_ps component runs the script.
'sp_cop -u name' Use this parameter if you are running more than one sp_cop process. Use it to specify each one of those processes that you want to monitor. This argument must reflect exactly the same name that was used when sp_cop was started with the -u option. It must be enclosed within single quote marks.Without the -uname option, sp_ps assumes you want to monitor the sp_cop that uses the default SharePlex port of 2100.
CONFIGURATION

Specifies the type of configuration of the SharePlex instance being monitored. This value must be entered in CAPITAL letters. Valid values:

SOURCE — Use for uni-directional replication to monitor the Capture, Read and Export processes on the source system.

TARGET — Use for uni-directional replication to monitor the Import and Post processes on the target system.

MULTI-SOURCE — Use for peer-to-peer replication. It directs the script to monitor the Capture, Read, Export, Import and Post processes on each system.

Note: If replicating between source and target tables on the same system, there are no Export or Import processes.

> /dev/null Redirects the notification output to the /dev/null device on the local system so that the monitoring process can continue to run in the background and generate output. To have the output appear on screen, omit this argument
& (Ampersand) Runs the script in the background.

Monitor queues with sp_qstatmon

Monitor SharePlex > Run monitor scripts on UNIX > Monitor queues with sp_qstatmon

The sp_qstatmon script monitors the status of the capture and post queues for message backlogs. You can configure the script to alert you if the number of messages in a queue exceeds a defined threshold (limit), indicating that there is a potential data, system or network problem. This gives you time to correct the problem before the queues exceed their allocated space on the filesystem.

After each analysis of the queues, the sp_qstatmon script prints a notice in the capstat.log file for the capture queue or the poststat.log file for the post queue, as well as an e-mail message if that option is enabled.

Prepare to run sp_qstatmon

Before running the script, perform the following tasks.

Satisfy requirements

See Requirements for using the monitoring scripts before using this script. Note: The script must be run in the ksh shell.

Assign permission to create temporary files

The script creates some temporary files in the util sub-directory of the SharePlex product directory. Assign write permission to that directory to the sp_qstatmon module.

Define email addresses

To execute sp_qstatmon with e-mail notification, you must first must define the e-mail address(es) in the script. Notification messages are sent to all addresses coded in the script. Unless email notification is enabled, sp_qstatmon only logs errors to the log file.

You can specify as many addresses as you want.

  1. Open the sp_qstatmon script in any ASCII text editor. The script is in the .app-modules directory in the SharePlex installation directory.
  2. Add the address strings after the MailUserName= variable. Use the full e-mail and/or pager address. Separate multiple entries with a comma, as shown in the following example.

    scott@company.com, 12345678910@pageservice.com

  3. Save and close the file.

Run sp_qstatmon

Run the script from the util sub-directory of the SharePlex product directory, not from app-modules. When you run it from the util directory, you actually make a soft link that runs a utility which first sets up the correct environment before running the script itself.

Syntax

nohup sp_qstatmon -v path -t n -p port_number [-c integer ] [-d integer ] [-m] > /dev/null &

Table 20: Required arguments

Argument Description
nohup sp_qstatmon Directs the script to continue running in the background if the user logs out. This ensures continuous monitoring. The sp_qstatmon component runs the script.
-v path Sets the path to the SharePlex variable data directory for the instance of sp_cop that you want to monitor. Without this variable, sp_qstatmon fails and prints an error message requesting a valid path.
-t n Sets the time interval between scans in seconds. This value can be any positive integer.
-p port Sets the port number for the instance of sp_cop that you are monitoring. You can monitor different SharePlex instances by running sp_qstatmon for each one, using different values for this argument.
& Runs the script in the background.

Table 21: Optional arguments

Argument Description
/dev/null Redirects the notification output to the /dev/null device on the local system so that the monitoring process continues to run in the background and generate output. To have the output appear on screen, omit this argument.
-c integer Sets the number of messages in the capture queue at which the script issues a warning message. This value can be any positive integer. Without this parameter, sp_qstatmon defaults to 100 messages.
-d integer Sets the number of messages in the post queue at which the script issues a warning message. This value can be any positive integer. Without this parameter, sp_qstatmon defaults to 100 messages.
-m Enables the e-mail/paging option. Without this parameter, sp_qstatmon only logs errors to the log file.

Run a monitor script on Windows

Monitor SharePlex > Run a monitor script on Windows

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

  1. Run the SpClient utility from the SharePlex programs group.
  2. On the SpClient toolbar, click the SpMonitor button.
  3. Select the port number of the instance of SharePlex that you want to monitor, then click Configure Monitor.
  4. 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.

    Property Default Value Description
    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.
  5. 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.

Monitor with SNMP

Monitor SharePlex > Monitor with SNMP

SharePlex provides agent support for Simple Network Management Protocol (SNMP) on all Unix, Linux, and 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.

Parameter Value
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.

Parameter Value
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).

Parameter SharePlex Event
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
Related Documents