Skip to content

Doc 442 copyedit, part 4 #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/modules/cp-subsystem/pages/atomic-long.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Atomic Longs
= Atomic longs

You can see a list of all the xref:{page-latest-supported-hazelcast}@hazelcast:data-structures:iatomiclong.adoc[atomic longs] in your cluster
by clicking on the **Atomic Longs** menu item in the left menu.
Expand All @@ -7,4 +7,4 @@ image:ROOT:AtomicLongs.png[Atomic Longs View]

An atomic long has only a single metric: The current long value.

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
4 changes: 2 additions & 2 deletions docs/modules/cp-subsystem/pages/atomic-ref.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Atomic References
= Atomic references

You can see a list of all the xref:{page-latest-supported-hazelcast}@hazelcast:data-structures:iatomicreference.adoc[atomic references] in your cluster
by clicking on the **Atomic References** menu item in the left menu.

image:ROOT:AtomicReferences.png[Atomic References View]

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
4 changes: 2 additions & 2 deletions docs/modules/cp-subsystem/pages/countdown-latch.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Countdown Latches
= Countdown latches

You can see a list of all the xref:{page-latest-supported-hazelcast}@hazelcast:data-structures:icountdownlatch.adoc[countdown latches] in your cluster
by clicking on the **Countdown Latches** menu item in the left menu.
Expand All @@ -11,4 +11,4 @@ A countdown latch has three metrics:
- *Count*: Initial countdown.
- *Remaining*: Remaining number of expected countdowns.

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
2 changes: 1 addition & 1 deletion docs/modules/cp-subsystem/pages/cpmap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ A CPMap has two metrics:
- *Entries*: The number of entries in the map
- *Size*: The size of the map in memory

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
36 changes: 18 additions & 18 deletions docs/modules/cp-subsystem/pages/dashboard.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
= CP Subsystem
:description: You can use the CP Subsystem menu section to manage and monitor the CP subsystem in a cluster.
:description: You can use the CP Subsystem menu section to manage and monitor the CP Subsystem in a cluster.
:page-aliases: clusters:promoting-cp-member.adoc, clusters:removing-cp-member.adoc, clusters:restarting-cp-subsystem.adoc, clusters:cp-subsystem.adoc

You can use the *CP Subsystem* menu item to manage and monitor the xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:cp-subsystem.adoc[CP subsystem] in a cluster.
You can use the *CP Subsystem* menu item to manage and monitor the xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:cp-subsystem.adoc[CP Subsystem] in a cluster.

image:ROOT:CPSubsystemDashboard.png[Status]

== Data and Metrics
== Data and metrics

The CP subsystem dashboard displays the following tables:
The CP Subsystem dashboard displays the following tables:

.CP subsystem
.CP Subsystem
[cols="20%s,80%a"]
|===
|Field|Description
Expand All @@ -28,7 +28,7 @@ The CP subsystem dashboard displays the following tables:
|This button is available only to admin users.
|===

.CP subsystem stats
.CP Subsystem stats
[cols="20%s,80%a"]
|===
|Field|Description
Expand Down Expand Up @@ -94,17 +94,17 @@ To see more details about a particular session, click on the down arrow next to

image:ROOT:CPSessionMetricsTable.png[CP Session Metrics Table]

== Status Banner
== Status banner

A banner is always displayed at the top of the page with a message about the current CP subsystem status.
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
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
Expand All @@ -115,15 +115,15 @@ members are missing.
members are missing.

[[promote]]
== Promoting Members to CP Members
== Promoting members to CP members

You can promote any existing member that is not part of the CP subsystem to a CP member.
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.

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

. Select an AP member (one of the members that do not participate in the CP subsystem) from the dropdown.
. 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.

Expand All @@ -134,11 +134,11 @@ image:ROOT:CPPromoteDialog.png[Promote Member to CP Confirmation]
If an exception occurs, an error notification is displayed.

[[remove]]
== Removing CP Members
== Removing CP members

You can manually remove a disconnected CP member from the CP subsystem, using Management Center.
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 xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:configuration.adoc[] in the Platform documentation.
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 xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:configuration.adoc[] in the Platform documentation.

This action is available only to admin users.

Expand All @@ -147,7 +147,7 @@ This action is available only to admin users.
. 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.
the cluster's CP Subsystem.

If everything goes well, a success message is displayed.

Expand All @@ -157,7 +157,7 @@ If an exception occurs, an error notification is displayed.
[[restart]]
== Restarting 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.
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.

Expand All @@ -167,7 +167,7 @@ If everything goes well, a success message is displayed.

If an exception occurs, an error notification is displayed.
[[terminate]]
== Forcing a Session to Close
== Forcing 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.

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/cp-subsystem/pages/fenced-lock.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Fenced Locks
= Fenced locks

You can see a list of all the xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:fencedlock.adoc[fenced locks] in your cluster
by clicking on the **Fenced Locks** menu item in the left menu.
Expand All @@ -10,9 +10,9 @@ A fenced lock has two fixed metrics:
- *Acquire Limit*: Maximum number of reentrant acquires, which is configured in the CP member's xref:{page-latest-supported-hazelcast}@hazelcast:cp-subsystem:configuration.adoc#fencedlock-configuration[`lock-acquire-limit`] option.
- *Lock Count*: Total number of times the lock has been acquired.

If lock is held by an endpoint, the following additional metrics are displayed:
If the lock is held by an endpoint, the following additional metrics are displayed:

- *Owner Session Id*: xref:dashboard.adoc#session[Session] ID of the lock owner.
- *Owner*: Address of the lock owner.

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
2 changes: 1 addition & 1 deletion docs/modules/cp-subsystem/pages/semaphore.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ A semaphore has two metrics;
- *Initialized*: Whether the semaphore is initialized with a value.
- *Available*: Number of remaining permits.

You can sort the table by clicking on the column headers.
Sort the table by clicking on the column headers.
21 changes: 11 additions & 10 deletions docs/modules/troubleshoot/pages/hazelcast-clusters.adoc
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
= Troubleshooting Hazelcast Clusters
= Troubleshooting Hazelcast clusters
:description: Management Center writes log entries for each connection failure and allows you to trigger garbage collection and take thread dumps.

{description} This section describes how to work with these operations to help identifying the issues in a Hazelcast cluster.
{description} This topic describes how to work with these operations to help identify the issues in a Hazelcast cluster.

== Logs for Cluster Connection Failures
== Logs for cluster connection failures

Management Center logs all cluster connection failures, their reasons and retry attempts to `hz-client.log` in `hazelcast.mc.home` directory.

== Running Garbage Collection
== Running garbage collection

Running a garbage collection means cleaning up a member's memory, e.g., removing the unused
data structure objects. It is not recommended to run it unless instructed by the Hazelcast support team.
Running a garbage collection means cleaning up a member's memory, for example, removing the unused
data structure objects.
Hazelcast do not recommend you run it unless instructed to do so by the Hazelcast support team.

To run garbage collection for a specific member, go to **Cluster** > **Members** and select
the member in question. In the member details screen, you will see **Run GC**.

image:run-gc.png[RUN GC button]

Once you click the button, you will be asked to confirm. Note that this operation
does not write information to a file, only cleans up the member's memory in the background.
Click the button, and you will be prompted to confirm. Note that this operation
does not write information to a file, it only cleans up the member's memory in the background.

== Taking a Thread Dump
== Taking a thread dump

Thread dumps may be useful to troubleshoot a member that is deadlocked or slow;
they provide detailed information on threads, including the state for each thread.
We recommend collecting and providing multiple thread dumps when submitting a support ticket.

To take a thread dump for a member, go to **Cluster** > **Members** and select
the member in question. In the member details screen, you will see **Thread Dump** next to **Run GC**
as shown in the above screenshot. This operation shows the collected thread dump in a separate dialog.
as shown in the above screenshot. This operation shows the collected thread dump in a separate dialog box.

image:thread-dump.png[Thread Dump]

Expand Down
17 changes: 4 additions & 13 deletions docs/modules/troubleshoot/pages/management-center.adoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
= Troubleshooting Management Center
:page-aliases: ROOT:automated-security-scan.adoc, ROOT:troubleshooting.adoc, ROOT:ui-logs.adoc

This section describes how to deal with known issues and also how to read the user interface logs of Management Center.
This topic describes how to deal with known issues and also how to read the user interface logs of Management Center.

== Automated Security Scanning

When you scan Management Center artifacts, your tool might warn you about the following
vulnerabilities. Management Center security is *not* affected by them. It uses a custom
version of H2DB which is patched against these vulnerabilities.

* https://nvd.nist.gov/vuln/detail/CVE-2018-10054[CVE-2018-10054^]
* https://nvd.nist.gov/vuln/detail/CVE-2018-14335[CVE-2018-14335^]

== Horizontal Scrollbar in Tables when Using Mac
== Horizontal scrollbar in tables when using Mac

Mac automatically shows a horizontal scrollbar in the status tables of Management Center, when you scroll through a table content.

The scrollbar should hide shortly after you stop scrolling. This is the default behavior and it shouldn't
cause any inconvenience. However, if you still want to change it, address "Show scroll bars" section of the
cause any inconvenience. However, if you still want to change it, see the "Show scroll bars" section of the
link:https://support.apple.com/guide/mac-help/change-general-preferences-mchlp1225/mac["Change General preferences on Mac" guide].

== Experience Timeout
== Experience timeout

If you experience a timeout when running scripts or SQL queries, you can increase the timeout value
in the xref:deploy-manage:system-properties.adoc#hazelcast-mc-cluster-operation-timeout[`hazelcast.mc.cluster.operation.timeout.millis`] property.