Skip to content

Doc 439 copyedit, part 3 #498

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 5 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
8 changes: 4 additions & 4 deletions docs/modules/clusters/pages/changing-cluster-state.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Changing the Cluster State
= Change the cluster state
:description: Cluster states determine what cluster operations are available. By changing the state of a cluster, you can grant or restrict cluster operations such as migrations as well as change the behavior of those operations.

{description}
Expand All @@ -8,19 +8,19 @@ You may want to change a cluster's state to do the following:
- Add multiple new members to the cluster without triggering repartitioning after each member joins.
- Perform maintenance on a cluster without triggering repartitioning.

== Before you Begin
== Before you begin

You should already understand the concept of cluster states. For details about cluster states, see xref:{page-latest-supported-hazelcast}@hazelcast:maintain-cluster:cluster-member-states.adoc[] in the Platform documentation.

You must be an admin user to use this feature.

== Change the State of a Cluster
== Change the state of a cluster

To change a cluster's state, go to *Administration* > *Cluster State* and select a state from the dropdown menu.

image:ROOT:ChangeClusterState.png[Changing Cluster state]

== Next Steps
== Next steps

After changing the state of a cluster, you may want to shut it down and perform maintenance on it. To shut down a cluster, see xref:shutting-down-cluster.adoc[].

Expand Down
24 changes: 12 additions & 12 deletions docs/modules/data-structures/pages/cache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@

You can see a list of all the caches in your cluster by
clicking on the **Caches** menu item on the left panel. A new
page is opened on the right, as shown below.
page appears on the right, as shown below.

image:ROOT:CacheGridView.png[Cache Grid View]

You can filter the caches shown and sort the table
by clicking on the column headers. Clicking on
the cache name opens a new page for monitoring that cache
by clicking on the column headers. Click on
the cache name to open a new page for monitoring that cache
instance on the right, as shown below.

image:ROOT:MonitoringCaches.png[Monitoring Caches]

On top of the page, there are two graphs that show various metrics of the cache.
At the top of the page are two graphs that show various metrics for the cache.
See the xref:getting-started:graphs.adoc[graph section] for more information.

Under these charts are **Cache Statistics**, **Cache Throughput**, and **Client Near Cache**
Expand Down Expand Up @@ -57,10 +57,10 @@ cache on each member.

|===

To ascend or descend the order of the listings, click on the
To list entries in ascending or descending order, click on the
column headings.

[[cache-throughput]]**Cache Throughput Statistic Table** provides information about the
The [[cache-throughput]]**Cache Throughput Statistics** table provides information about the
operations (get, put, remove) performed on each member for the selected
cache.

Expand All @@ -76,13 +76,13 @@ corner of the window, for which the table data will be shown. Available built-in
values are **Since Beginning**, **Last Minute**, **Last 10 Minutes**
and **Last 1 Hour**.

You can ascend or descend the order of the listings in each column
by clicking on column headings.
To list entries in ascending or descending order, click on the
column headings.

[[cache-client-near-cache-summary-data]]
**Client Near Cache Summary** provides summary information related to the Near Cache statistics aggregated for all the clients that have Near Cache enabled for this cache.
Aggregated statistics are shown for the following periods:
_1 minute_, _5 minutes_, _30 minutes_ and _60 minutes_.
**1 minute**, **5 minutes**, **30 minutes** and **60 minutes**.
Currently, the table shows overall Near Cache effectiveness, calculated as hits/total reads ratio.

NOTE: You need to enable the statistics for clients to see them here.
Expand All @@ -91,7 +91,7 @@ See the xref:clusters:clients.adoc[Monitoring Clients section] for details.
image:ROOT:ClientNearCacheSummaryTable.png[Maps Client Near Cache Summary]

[[cache-client-near-cache-data]]
**Client Near Cache Table** provides information about the Near Caches statistics, if available, on each client that has Near Cache enabled for this cache, as shown below.
The **Client Near Cache** table provides information about the Near Caches statistics, if available, on each client that has Near Cache enabled for this cache, as shown below.

NOTE: You need to enable the statistics for clients to see them here.
See the xref:clusters:clients.adoc[Monitoring Clients section] for details.
Expand Down Expand Up @@ -141,12 +141,12 @@ From left to right, this table lists the following:
|===


To ascend or descend the order of the listings, click on the
To list entries in ascending or descending order, click on the
column headings.

NOTE: You need to enable the statistics for caches to monitor them
in the Management Center. Use the `<statistics-enabled>` element or
`setStatisticsEnabled()` method in declarative or programmatic
configuration, respectively, to enable the statistics. Please refer
configuration, respectively, to enable the statistics. Refer
to the xref:{page-latest-supported-hazelcast}@hazelcast:jcache:setup.adoc#jcache-declarative-configuration[JCache Declarative Configuration]
section for more information.
14 changes: 8 additions & 6 deletions docs/modules/data-structures/pages/executor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,25 @@

You can see a list of all the Executors in your cluster by clicking
on the **Executors** menu item on the left panel. A new
page is opened on the right, as shown below.
page appears on the right, as shown below.

image:ROOT:ExecutorGridView.png[Executor Grid View]

You can filter the Executors shown and you can also sort the table
by clicking on the column headers. Clicking on
an Executor name opens a new page for monitoring that Executor
by clicking on the column headers. Click on
an Executor name to open a new page for monitoring that Executor
instance on the right, as shown below.

image:ROOT:MonitoringExecutors.png[Monitoring Executors]

On top of the page, there are two graphs that show various metrics of the Executor.
At the top of the page are two graphs that show various metrics for the Executor.
See the xref:getting-started:graphs.adoc[graph section] for more information.

Under these charts is the [[executor-operation-statistics]]**Executor Operation Statistics**
table. From left to right, this table lists the IP address and port of
members, the counts of pending, started and completed executors
per second, and the execution time and average start latency of
executors on each member. Click on the column heading to ascend
or descend the order of the listings.
executors on each member.

To display listings in ascending or descending order, click on the
column headings.
12 changes: 6 additions & 6 deletions docs/modules/data-structures/pages/flake-id-gen.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
= Flake ID Generators
= Flake ID generators
[[monitoring-flake-id-generators]]

You can see a list of all Flake ID Generators in your
cluster by clicking on the **Flake ID Generators** menu item on
the left panel. A new
page is opened on the right, as shown below.
page appears on the right, as shown below.

image:ROOT:FlakeIdGenGridView.png[Flake ID Generator Grid View]

Expand All @@ -21,12 +21,12 @@ by a generator, i.e., total number of IDs generated (the sum
of IDs for all batches) for all members divided by the total
count of batch requests coming from all members.

[[id-generator-details]]Clicking on a generator name opens a new page for
[[id-generator-details]]Click on a generator name to open a new page for
monitoring that specific generator instance, as shown below.

image:ROOT:MonitoringFlakeIdGens.png[Monitoring Flake ID Generators]

The table can likewise be sorted by clicking the column
Likewise, you can sort the table by clicking the column
headers.
It shows IP and port of the members that have a state for
the specific generator named in the page's title.
Expand All @@ -40,7 +40,7 @@ created for this member, i.e., total number of IDs generated
the total count of batch requests coming from this member.

NOTE: The operations per second is not the number of new IDs
generated or used but the number of ID batches.
The batch size is configurable, usually it contains hundreds
generated or used, but the number of ID batches.
The batch size is configurable, and usually contains hundreds
or thousands of IDs.
A client uses all IDs from a batch before a new batch is requested.
6 changes: 3 additions & 3 deletions docs/modules/data-structures/pages/list.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
= Lists
[[managing-lists]]

You can see a list of all the lists in your cluster
You can see all the lists in your cluster
by clicking on the **Lists** menu item on the left panel. A new
page is opened on the right, as shown below.
page appears on the right, as shown below.

image:ROOT:ListGridView.png[List Grid View]

You can sort the table by clicking on the column headers.
To sort the table, click on the column headers.

List is a distributed and concurrent implementation of `java.util.List`.
65 changes: 33 additions & 32 deletions docs/modules/data-structures/pages/map.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,43 @@

You can see a list of all the maps in your cluster
by clicking on the **Maps** menu item on the left panel. A new
page is opened on the right, as shown below.
page appears on the right, as shown below.

image:ROOT:MapGridView.png[Map Grid View]

You can filter the maps shown and you can also sort
the table by clicking on the column headers. Clicking
on a map name opens a new page for monitoring that map
the table by clicking on the column headers. Click
on a map name to open a new page for monitoring that map
instance on the right, as shown below.

image:ROOT:MonitoringMaps.png[Monitoring Maps]

The below subsections explain the portions of this window.
The sections below explain the portions of this window.

[[clear-map]]
== Removing Entries from a Map
== Remove entries from a map

You can use the *Clear Data* button to remove all entries from the map.
Use the *Clear Data* button to remove all entries from the map.

image:ROOT:ClearMapData.png[Clear Map Data View]

In the confirmation modal, enter the map name and confirm that you want to remove all entries from the map.
When prompted, enter the map name and confirm that you want to remove all entries from the map.

image:ROOT:ClearMapDataConfirmation.png[Clear Map Data Confirmation]

[[map-browser]]
== Exploring Map Entries
== Explore map entries

You can use the Map Browser tool to retrieve properties of the
Use the Map Browser tool to retrieve properties of the
entries stored in a selected map. To open the Map Browser
tool, click on the **Map Browser** button, located at the
top right of the window. Once opened, the tool appears as a
dialog, as shown below.
dialog box, as shown below.

image:ROOT:MapBrowser.png[Map Browser]

Once the key and the key's type are specified and the **Browse**
button is clicked, the key's properties along with its value are
Specify the key and the key's type, then click the **Browse**
button. The key's properties along with its value are
listed.

.Map Browser fields
Expand Down Expand Up @@ -104,32 +104,32 @@ image:ROOT:MapBrowserWithCustomTypedValue.png[Map Browser with Custom Typed Valu

NOTE: Management Center allows you to access contents of Hazelcast data structures (for instance map entries) via SQL Browser or Map Browser. It may be useful to restrict data access for Management Center if sensitive financial or personal information is stored in the cluster. Management Center cannot access the data if at least one member has the data access disabled. You can disable data access for Management Center in the member configuration file. See the xref:hazelcast:maintain-cluster:monitoring.adoc#managing-data-access[Managing Data Access] section.

== Configuring a Map
== Configure a map

You can use the Map Config tool to set the selected map's attributes, such
Use the Map Config tool to set the selected map's attributes, such
as the max size, TTL, and eviction policy. To open the Map Config
tool, click on the **Map Config** button, located at the top right of
the window. Once opened, the tool appears as a dialog, as shown below.
the window. Once opened, the tool appears as a dialog box, as shown below.

image:ROOT:MapConfig.png[Map Config Tool]

You can change any attribute and click the **Save Configuration** button to save
Change any attribute and click the **Save Configuration** button to save
your changes.

NOTE: The Map configuration is updated only on the members that Management Center is aware of at the time of the update. When a new member joins the cluster, the updated map configuration is not propagated to it.
If a member has persistence enabled, the updated map configuration is not persisted to disk and the updates are lost on the next restart.

[[map-monitoring]]
== Monitoring a Map
== Monitor a map

Besides the Map Browser and Map Config tools, the map monitoring
page shows two graphs that show various metrics of the map.
In addition to the Map Browser and Map Config tools, the map monitoring
page shows two graphs that display various map metrics.
See the xref:getting-started:graphs.adoc[graph section] for more information.

Under these charts are **Map Statistics**, **Map Throughput**,
**Member Near Cache**, and **Client Near Cache** data tables.

[[map-statistics]]**Map Statistic Table** provides statistics distributed
The [[map-statistics]]**Map Statistics** table provides statistics distributed
over the members, as shown below.

image:ROOT:MapStatisticDataTable.png[Map Statistic Data Table]
Expand Down Expand Up @@ -188,10 +188,10 @@ map but not written to/removed from a database yet.

|===

You can ascend or descend the order of the listings by clicking on
To display entries in ascending or descending order, click on
the column headings.

[[map-throughput]]**Map Throughput Table** provides information about the operations
The [[map-throughput]]**Map Throughput Statistics** table provides information about the operations
(get, put, remove) performed on each member in the map, as shown below.

image:ROOT:MapThroughputDataTable.png[Map Throughput Data Table]
Expand Down Expand Up @@ -244,15 +244,15 @@ From left to right, this table lists the following:

|===

You can select the time period in the combo box placed in the top
Select the time period in the combo box found in the top
right corner of the window, for which the table data will be
shown. Available values are **Since Beginning**, **Last Minute**,
**Last 10 Minutes** and **Last 1 Hour**.

To ascend or descend the order of the listings, click on the
To display listings in ascending or descending order, click on the
column headings.

[[member-near-cache-data]]**Member Near Cache Table** provides information about the Member Near
The [[member-near-cache-data]]**Member Near Cache** table provides information about the Member Near
Caches, if available, on each member, as shown below.

image:ROOT:MemberNearCacheDataTable.png[Member Near Cache Data Table]
Expand Down Expand Up @@ -284,7 +284,7 @@ From left to right, this table lists the following:

|===

To ascend or descend the order of the listings, click on the
To display listings in ascending or descending order, click on the
column headings.

[[map-index-stats]]
Expand Down Expand Up @@ -389,7 +389,8 @@ From left to right this table lists the following:

|===

To ascend or descend the order of the listings, click on the column headings.
To display listings in ascending or descending order, click on the
column headings.

[[map-client-near-cache-summary-data]]
**Client Near Cache Summary** provides summary information related to the Near Cache statistics aggregated for all the clients that have Near Cache enabled for this map.
Expand All @@ -398,15 +399,15 @@ _1 minute_, _5 minutes_, _30 minutes_ and _60 minutes_.
Currently, the table shows overall Near Cache effectiveness, calculated as hits/total reads ratio.

NOTE: You need to enable the statistics for clients to see them here.
See the xref:clusters:clients.adoc[Monitoring Clients section] for details.
See xref:clusters:clients.adoc[Monitoring Clients] for details.

image:ROOT:ClientNearCacheSummaryTable.png[Maps Client Near Cache Summary]

[[map-client-near-cache-data]]
**Client Near Cache Table** provides information about the Near Caches statistics, if available, on each client that has Near Cache enabled for this map, as shown below.
The [[map-client-near-cache-data]]
**Client Near Cache** table provides information about the Near Caches statistics, if available, on each client that has Near Cache enabled for this map, as shown below.

NOTE: You need to enable the statistics for clients to see them here.
See the xref:clusters:clients.adoc[Monitoring Clients section] for details.
See xref:clusters:clients.adoc[Monitoring Clients] for details.

image:ROOT:ClientNearCacheDataTable.png[Maps Client Near Cache Data Table]

Expand Down Expand Up @@ -452,5 +453,5 @@ From left to right, this table lists the following:

|===

To ascend or descend the order of the listings, click on the
To display listings in ascending or descending order, click on the
column headings.
Loading