Skip to main content
Version: 5.12

CP Subsystem

You can use the CP Subsystem menu item to manage and monitor the CP Subsystem in a cluster.

Status

Data and metrics​

The CP Subsystem dashboard displays the following tables:

FieldDescription
CP MembersThe number of accessible CP members and the CP member count that's configured on the cluster.
Promote Member to CPThis button is available only to admin users.
Remove CP MemberThis button is available only to admin users.
Restart CP SubsystemThis button is available only to admin users.
FieldDescription
MemberAddress of the CP member.
NodesNumber of Raft nodes that the member is running.
Destroyed GroupsTotal number of Raft groups that have been destroyed.
Active MembersTotal number of active CP members.
Missing MembersTotal number of missing CP members.
FieldDescription
Group NameName of the Raft group.
Group IdGroup identifier.
Member CountTotal number of members in the group.

To see more details about a particular group, click on the down arrow next to the group name.

CP Group Metrics Table

FieldDescription
IdSession ID.
Endpoint NameThe name of the client that initiated the session (only if the name is set by the client).
EndpointThe address of the client that initiated the session.
Endpoint TypeThe type of the client that initiated the session.
ActionsRelated actions that can be applied to the session.

To see more details about a particular session, click on the down arrow next to the Id.

CP Session Metrics Table

Status banner​

A banner is always displayed at the top of the page with a message about the current CP Subsystem status.

This banner may display one of the following messages:

  • CP Subsystem is not enabled: The cluster is not configured with a CP member count of at least 3.
  • All CP members are accessible: Number of accessible CP members is at least the same as the configured CP member count.
  • One CP member is not accessible: One CP member is missing and the minority count in the CP Subsystem is greater than 1. For example, this value is shown when 6 accessible CP members are available and the configured count is 7. In this example, the minority count is 3 members and the majority count is 4 members.
  • Multiple CP members are not accessible: Multiple CP members are missing, but their count is less than the minority.
  • Minority of the CP members are not accessible: The minority of CP members are missing.
  • Majority of the CP members are not accessible: The majority of CP members are missing.

Promote members to CP members​

You can promote any existing member that is not part of the CP Subsystem to a CP member.

This action is available only to admin users.

  1. Go to CP Subsystem > Dashboard, and click Promote.

  2. Select an AP member (one of the members that do not participate in the CP Subsystem) from the dropdown.

    note

    Lite members are not displayed in the dropdown list because they do not store data and cannot be promoted to CP members.

If everything goes well, a success message is displayed.

Promote Member to CP Confirmation

If an exception occurs, an error notification is displayed.

Remove CP members​

You can manually remove a disconnected CP member from the CP Subsystem, using Management Center.

If a CP member loses connection with the rest of the cluster, the CP Subsystem will wait for 4 hours by default before connecting to a new CP member. You can configure this time in the missing-cp-member-auto-removal-seconds option. See Configure the CP Subsystem in the Platform documentation.

This action is available only to admin users.

  1. Go to CP Subsystem > Dashboard, and click Remove.

  2. Select a CP member from the dropdown.

    Although this member is not connected to the Management Center, it is known by the cluster's CP Subsystem.

If everything goes well, a success message is displayed.

Remove CP Member Confirmation

If an exception occurs, an error notification is displayed.

Restart CP Subsystem​

If the majority of CP members crash, you can restart the CP Subsystem to delete all CP data and trigger a new round of the discovery process.

This action is available only to admin users.

Go to CP Subsystem > Dashboard, and click Restart.

If everything goes well, a success message is displayed.

If an exception occurs, an error notification is displayed.

Force a session to close​

If a session owner is not temporarily partitioned and crashed, an admin user can manually close the session to release its resources immediately.

To manually close the session, complete the following steps:

  1. Select CP Subsystem > Dashboard.
  2. In the CP Session Metrics Table, find the CP session that you want to close.
  3. Select the Terminate button in the Actions column for the related session.

If the session is successfully closed, a confirmation message displays.

Terminate CP Session Confirmation

If an exception occurs, an error displays.