Chat now with support
Chat with Support

Welcome, ApexSQL customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

SharePlex 9.0 - 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 Set SharePlex parameters Configure SharePlex to replicate data Configure replication to and from a container database Configure named queues Configure partitioned replication Configure SharePlex to maintain a change history target Configure a replication strategy Configure SharePlex to 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

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

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

Prevent and solve replication problems

This section contains solutions to many of the common questions and problems that can arise during replication, and it also suggests preventive measures for avoiding problems.

Contents

Find the problem in the SharePlex Knowledge Base

If the issue you are experiencing is not listed in this documentation, search the SharePlex Knowledge Base at:

https://support.quest.com.

The Knowledge Base provides filtering options and links to other resources that can help you use and troubleshoot SharePlex.

Related Documents