Chat now with support
Chat with Support

SharePlex Manager 3.1 - User Guide

Manage Monitoring

After running the Discovery Wizard and organizing the replication streams you want to monitor by adding them to user-defined replication views, you can open the Manage Monitoring console and perform various tasks to keep your monitoring environment easier to use and up to date:

•
You can edit instances and replication streams by changing their system-assigned names and adding descriptions. In the case of instances, you can also edit their usernames or passwords (which may be a periodic security requirement).
•
You can edit replication views by changing their names and descriptions and by adding or removing replication streams. You can also create new replication views and delete views.
•
You can specify which users can execute control commands on processes in selected replication streams.
•
You can discover new or additional replication streams by running the Discovery Wizard again.

To open the Manage Monitoring console:

•
In the SharePlex Manager tab, click Administration. Then click Manage Monitoring.
You must have at least one replication view already defined to open the Manage Monitoring console. If not, SharePlex Manager opens the Discovery Wizard when you click Manage Monitoring. For more information, see the section, “Running the Discovery Wizard” on page 11.
Note
Access to the Manage Monitoring console is controlled by security rights. If you do not have proper security rights, the Manage Monitoring option is deactivated.
Editing SharePlex Instances

You can edit instances by changing their system-assigned names, adding or modifying descriptions, and by changing usernames or passwords (which may be a periodic security requirement).

To edit an instance:
1
In the Manage Monitoring console, click Instances.
This opens a list of all the currently identified SharePlex instances.
2
Click the name of the instance you want to edit.
Note
By default instance names consist of the host name concatenated with the port number
This opens the SharePlex Instance Properties window which shows the connection properties of the instance, the configuration files defined for that instance, as well as details regarding the last time SharePlex Manager attempted to connect to the instance.
Note
If at no time SharePlex Manager was able to connect to the instance, the date/time stamp will be blank.
3
Click Edit.
4
Edit the instance by renaming it, adding or modifying its description, or by changing its username or password.
Caution
If you are not able to monitor an instance after editing it, it may be because the username and password is not valid. Check the log and/or validate the current username/password.
5
Click Save.
Caution
An inactive Instance, which is persisted in SPM due to running “Setup Replication Stream” or “Discovery” on an inactive Instance, will not be cleared in two situations: 1) Manually clicking the Discovery link from within SharePlex Management or 2) Auto discovery. The inactive Instance is cleared if the user successfully completes the "Setup Replication Stream" wizard or successfully discovers Streams from the discovery required warning link. The user can also manually remove the inactive Instance via the Instances Property dialog.
Editing Replication Views

You can edit replication views by changing their names and descriptions and by adding or removing replication streams. You can also create new replication views and delete views you do not want.

To edit a replication view:
1
In the Manage Monitoring console, click Views.
This opens a list of all the currently identified replication views.
2
Click the name of the replication view you want to edit.
Note
If you want to create a new replication view, click New Replication View. Then specify a name for view, add a description (optional), and lastly select the replication streams you want to add to the view.
3
In the Replication View window, click Edit.
This opens the Replication View Edit window, which shows the name and description of the view as well as all the replication streams that currently belong to the view (selected) and all the other replication streams that have been identified by the Discovery Wizard.
4
Do any of the following to edit the view:
•
Modify the view name
•
Add or modify the view description
•
Select the replication streams you want to add to the view and de-select any replication stream you want to remove from the view
5
Click Save.
Editing Replication Streams

You can edit a replication stream by removing it, changing its name, adding a description. or adjusting its baseline time remaining value.

To edit a replication stream:
1
In the Manage Monitoring console, click Streams.
This opens a list of all the currently identified replication streams.
2
Click the name of the replication stream.
Note
By default, replication stream names consist of the system-assigned name of the source instance plus the port number.
This opens the Stream window.
Note
If you have the security rights to set control permissions, you can click Permissions and specify which users have the right to execute control commands on replication processes for the selected stream. For more information on setting control permissions, see the section, “Setting Control Permissions” on page 28.
3
(Optional) Click Remove to delete the replication stream from any replication views. Then when prompted to confirm the removal, click OK.
Caution
When you remove a stream, it is removed from all the replication views in which it is monitored. Also, all the data that SharePlex Manager has compiled regarding that stream is deleted. If you want to monitor a replication stream you removed, it must be identified again by the Discovery Wizard.
4
Click Edit.
This opens the Stream Properties Edit window.
5
Rename the replication stream or modify its description as needed.
Because the time remaining baseline is a weekly moving average, values may be misleading within the first week of monitoring the instances in a particular replication stream, especially if the replication stream was discovered while processing a large amount of data. For this reason, SharePlex Manager allows you to reset the baseline time remaining value on a replication stream.
6
(Optional) Specify the baseline time remaining value for the replication stream in seconds.
7
Click Save.
Setting Control Permissions

If you have the security rights to set control permissions, you can specify which users can execute control commands on processes in selected replication streams. The right to execute control commands can be granted on either a per-stream or a per-user basis.

Note
Control permissions in SharePlex Manager do not correspond to user authorization levels defined in SharePlex. This means that while users may have control permissions on a replication stream in SharePlex Manager, they may still be unable to execute control commands because the username that was specified to connect to the SharePlex instances does not have the proper authorization level. See your SharePlex documentation for more information on authorization levels.

SharePlex Manager Permissions can also be set for individual streams in the Stream window. For more information, see the section, “Managing SharePlex Configuration Files” on page 18.

To set control permissions:
1
In the Manage Monitoring console, click Permissions.
This opens the Permissions window, which is divided into two tabs: Streams and Users.
2
Do the following to set permissions on a per-stream basis:
a
Click the stream or user you want.
If you selected a stream, this opens a window displaying a list of all the users currently defined in the database. If you selected a user, the window displays a list of all the replication streams.
b
To set permissions on a per-stream basis, select each user you want to grant control rights.
c
To set permissions on a per-user basis, select each stream for which you want to grant the user control rights.
d
Click Save.

Alert and Alarm Rules

Contents 
Global SharePlex Manager Rules
Specific SharePlex Manager Rules
Setting Up E-mail Notifications

Global SharePlex Manager Rules

You can configure SharePlex Manager to execute an alert or alarm rule whenever the performance of a monitored replication stream or SharePlex instance falls below an acceptable level.

SharePlex Manager comes installed with a number of pre-defined alert and alarm rules that, when enabled, apply to all the replication stream and instances that are currently being monitored.

You can customize pre-defined SharePlex Manager rules as you see fit, or you can use them as the basis for alert and alarm rules that are applied to specific replication streams or instances.

Note
Creating and modifying rules is a Foglight administration function restricted to user groups that have been granted administrator privileges. See “Introduction to Rules” and “Creating and Editing Rules” in the Foglight Administration and Configuration Guide for more information.

Most of the pre-defined rules for SharePlex Manager are disabled by default. A rule must be enabled before you can use it. For more information, see the section, “Enabling SharePlex Manager Rules” on page 43.

To view the pre-defined alert and alarm rules for SharePlex Manager:
1
Open the Foglight Navigation panel.
2
Select Administration>Rules & Notifications> Rules.
3
Filter the list of rules by the SharePlex Manager Cartridge.
Note
The SharePlex Manager Cartridge only includes the pre-defined SharePlex Manager rules. User-defined rules and rules applied to specific SharePlex Manager replication streams and instances are not included in the list.
Types of Rules

Most global SharePlex Manager rules are categorized according to the three factors that most affect performance levels in a SharePlex environment:

•
Latency Rules
•
Time Remaining Rules
•
Queue Size Rules

SharePlex Manager also includes four miscellaneous rules. These include:

Latency Rules

In SharePlex Manager, latency is the amount of time it takes to process a redo log record after it has been posted by Oracle for a particular process. Latency is measured in seconds. Pre-defined Latency Alerts and Alarms include the following:

•
SharePlex Capture Process Latency
•
SharePlex Read Process Latency
•
SharePlex Post Process Latency
•
SharePlex Replication Stream Latency
SharePlex Capture Process Latency
Description
Capture Process Latency is represented by the Latency Metric found on the SharePlexCaptureProcess Topology Object. By default, the alert fires when Latency is greater than 2 minutes. The alarm fires when Latency is greater than 10 minutes.
Field
SharePlexCaptureProcess Latency
Alert/Alarm Levels
2 Minutes/10 Minutes
SharePlex Read Process Latency
Description
Read Process Latency is represented by the Latency Metric found on the SharePlexReadProcess Topology Object. By default, the alert fires when Latency is greater than 2 minutes. The alarm fires when Latency is greater than 10 minutes.
Field
SharePlexReadProcess Latency
Alert/Alarm Levels
2 Minutes/10 Minutes
SharePlex Post Process Latency
Description
Post Process Latency is represented by the Latency Metric found on the SharePlexPostProcess Topology Object. By default, the alert fires when Latency is greater than 2 minutes. The alarm fires when Latency is greater than 10 minutes.
Field
SharePlexPostProcess Latency
Alert/Alarm Levels
2 Minutes/10 Minutes
SharePlex Replication Stream Latency
Description
Replication Stream Latency is represented by the Latency Metric found on the SharePlexStream Topology Object. Alert fires when Latency is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlexStream Latency
Alert/Alarm Levels
5 Minutes/10 Minutes
Time Remaining Rules

In SharePlex Manager, time remaining metrics indicate the amount of time remaining in seconds to complete processes:

•
For source instances, time remaining equals the slowest current Export process plus the time to complete the current Capture and Read processes.
•
For target instances, time remaining equals the time to complete the slowest current Post process

Pre-defined Time Remaining Alerts and Alarms include the following:

•
SharePlex Capture Process Time Remaining
•
SharePlex Read Process Time Remaining
•
SharePlex Export Process Time Remaining
•
SharePlex Post Process Time Remaining
•
SharePlex Source Instance Time Remaining
•
SharePlex Source Instance Time Remaining
SharePlex Capture Process Time Remaining
Description
Capture Process Time Remaining is represented by the TimeRemaining Metric found on the SharePlexCaptureProcess Topology Object. By default, the alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlexCaptureProcess Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
SharePlex Read Process Time Remaining
Description
Read Process Time Remaining is represented by the TimeRemaining Metric found on the SharePlexReadProcess Topology Object. By default, the alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlexReadProcess Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
SharePlex Export Process Time Remaining
Description
Export Process Time Remaining is represented by the TimeRemaining Metric found on the SharePlexExportProcess Topology Object. By default, the alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlexExportProcess Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
SharePlex Post Process Time Remaining
Description
Post Process Time Remaining is represented by the TimeRemaining Metric found on the SharePlexPostProcess Topology Object. By default, the alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlex Post Process Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
SharePlex Source Instance Time Remaining
Description
Source Instance Time Remaining is represented by the TimeRemaining Metric found on the SharePlexSource Topology Object. Alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlex Source Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
SharePlex Target Instance Time Remaining
Description
Target Instance Time Remaining is represented by the TimeRemaining Metric found on the SharePlexTarget Topology Object. Alert fires when TimeRemaining is greater than 5 minutes. The alarm fires when TimeRemaining is greater than 10 minutes.
Field
SharePlex Target Time Remaining
Alert/Alarm Levels
5 Minutes/15 Minutes
Queue Size Rules

In SharePlex Manager, queue size is the number of messages in the backlog for a particular process. Pre-defined Queue Size Alerts and Alarms include the following:

•
SharePlex Capture Queue
•
SharePlex Export Queue
•
SharePlex Post Queue
SharePlex Capture Queue
Description
Capture Queue size is represented by the Backlog Metric found on the SharePlexReadProcess Topology Object. Alert fires when Backlog is greater than 500 messages. The alarm fires when Backlog is greater than 1000 messages
Field
SharePlexReadProcess Backlog
Alert/Alarm Levels
100.000 messages/1,000,000 messages
SharePlex Export Queue
Description
Export Queue size is represented by the Backlog Metric found on the SharePlexExportProcess Topology Object. Alert fires when Backlog is greater than 500 messages. The alarm fires when Backlog is greater than 1000 messages.
Field
SharePlexExportProcess Backlog
Alert/Alarm Levels
100.000 messages/1,000,000 messages
SharePlex Post Queue
Description
Post Queue size is represented by the Backlog Metric found on the SharePlexPostProcess Topology Object. Alert fires when Backlog is greater than 500 messages. The alarm fires when Backlog is greater than 1000 messages.
Field
SharePlexPostProcess Backlog
Alert/Alarm Levels
100.000 messages/1,000,000 messages
Miscellaneous SharePlex Manager Rules

SharePlex Manager includes four additional rules that are triggered when errors occur pertaining to Post processing, stream configuration files, and connections to Web Services. Because these rules are triggered by errors, they are all configured at the alarm level, which means alert levels do not apply. These pre-defined alert and alarm rules include the following:

•
SharePlex Manager No Active Configuration
•
SharePlex Manager Out of Sync
•
SharePlex Manager Bad Configuration File
•
SharePlex Manager Web Services Unavailable
Note
Except for the SharePlex Manager Bad Configuration File rule, miscellaneous rules are enabled by default.
SharePlex Manager No Active Configuration
Description
This rule fires when there's no active configuration for a SharePlex Source Instance
Field
SharePlexSource
SharePlex Manager Bad Configuration File
Description
This rule fires when an error event with a condition id of 15 exists on a SharePlex Source Instance
Field
SharePlexSource
SharePlex Manager Out of Sync
Description
This rule fires when a post process gets an out of sync error (an error with a condition id of 19).
Field
SharePlexPostProcess
SharePlex Manager Web Services Unavailable
Description
Fires when the agent cannot communicate to the SharePlex Web Services.
Field
SharePlexMonitoringParameters
Enabling SharePlex Manager Rules

Each global SharePlex Manager rule is a multiple-severity type rule and defines conditions for both alerts (warnings) and alarms (fatal errors).

Note
There are many ways to edit or enhance rules in Foglight. See “Introduction to Rules” and “Creating and Editing Rules” in the Foglight Administration and Configuration Guide for more information.
To activate a global rule:
1
Navigate to the Rules page and filter the list of rules by the SharePlex Manager Cartridge.
2
Click the SharePlex Manager global rule you want to enable in the Rule Name table.
The Edit Rule page appears.
3
Click the drop-down button to open the Rule Summary page.
4
Click on the icon () next to the Rule Status property to enable the rule.
A confirmation dialog appears.
5
Click OK in the confirmation dialog.
The Edit Rule - <Rule Name> page is refreshed.
6
The Rule Summary page to confirm that the rule has been enabled.
After enabling a global SharePlex Manager rule, you can make a copy of it and then use that copy as the basis for a new rule that is applied to specific SharePlex objects. See the section “Specific SharePlex Manager Rules” on page 44 for more information.

Specific SharePlex Manager Rules

By default, the pre-defined global SharePlex Manager alert and alarm rules apply to all the SharePlex objects that are currently monitored. If you want to apply an alert and alarm rule to a specific stream, instance or queue, you can do so by making a copy of the appropriate global rule and adding logic that applies the rule to the object you want.

Note
There are many ways to edit or enhance rules in Foglight. See “Introduction to Rules” and “Creating and Editing Rules” in the Foglight Administration and Configuration Guide for more information.
To make an alert and alarm rule specific:
1
Navigate to the Manage Rules page and filter the list of rules by the SharePlex Manager Cartridge.
2
Click the copy icon () in the Rule Name table to create a copy of the rule and open it for editing
This opens the Rule Definition page.
3
Specify a unique name for the rule that will make it easily identifiable.
4
In the Rule Scope section, select and delete the topology type value that is currently displayed in the text area.
5
Click the Topology Type field and in the drop-down list select the SharePlex topology type you the rule is based on, i.e., SharePlex Capture Process.
Note
It is necessary to delete the original topology value even if it is the same value you select in the drop-down list.
6
Click the wrench icon ().
This opens the Scoping Query Editor.
7
Select the replication stream or SharePlex instance to which you want to apply the rule.
8
Click Insert Query.
9
Close the Scoping Query Editor and click Save.
At this point, you to need to edit either alert portion of the rule or the alarm portion. The Fatal severity level is the trigger event value for alarms, while the Warning severity level is the trigger event value for alerts.
10
Navigate to the Conditions, Alarms & Actions tab for the new rule.
11
(Optional) Click the Fatal severity level to edit the alarm portion of the rule.
This opens the Condition tab for the severity. The conditions for each global SharePlex Manager rule have been pre-defined in the Condition field with default trigger event values.
For example, the pre-defined Fatal condition for the SharePlex Read Process Latency rule is the following:
#Latency# > 600
12
Make the changes you want in the Condition field.
For example, if you made a copy of the global rule SharePlex Read Process Latency and are applying it to a specific SharePlex instance, you might edit the rule as follows:
#Latency# > 500
This way, the alarm would be displayed when the latency on the Read process of the specific SharePlex instance reached 500 seconds, as opposed to 600 seconds for the global rule.
13
(Optional) In the Conditions & Actions tab, click the Warning severity level and edit the alert portion of the rule the same way you did the alarm portion.
14
Click Save.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating