You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/01/27 00:26:15 UTC

[GitHub] [ignite] dmagda commented on a change in pull request #8703: Ignite 13385 3

dmagda commented on a change in pull request #8703:
URL: https://github.com/apache/ignite/pull/8703#discussion_r564139884



##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be configured both for all regions (by default) or for each region separately.
+====
+
+Presently, Ignite warm-up strategy implies loading data into the region, starting with indexes, until it runs out of free space.
+
+To warm up all data regions, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To warm up a specific data region, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To stop warming up all data regions, pass the configuration parameter `NoOpWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:

Review comment:
       It sounds like (the "stop" implies) that it's possible to actually stop any warm-up procedure that's already in progress. Is this the case? If not, then you need to say (I guess, check with the dev) "To disable the memory warm-up ... pass the configuration parameter..." Also, it sounds like that's a default behavior? We don't warm memory up unless you ask.

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be configured both for all regions (by default) or for each region separately.

Review comment:
       Not sure we need this note here. Instead, down below you can say that "Presently, the Ignite warm-up strategy implies loading data into all or specific data regions of Ignite..."

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be configured both for all regions (by default) or for each region separately.
+====
+
+Presently, Ignite warm-up strategy implies loading data into the region, starting with indexes, until it runs out of free space.
+
+To warm up all data regions, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)

Review comment:
       The API call needs to start with an object of the class. The class is the `DataStorageConfiguration` in your case.
   
   So, it needs to be (check that it's compilable or with the dev):
   
   DataStorageConfiguration cfg = new DataStorageConfiguration();
   
   cfg.setDefaultWarmUpConfiguration(DataStorageConfiguration.LoadAllWarmUpStrategy)
   
   Fix for all the code samples below. All of them should be injectable and compilable from the source code. Also, in addition to Java there needs to be XML configuration tab and .NET if the latter is supported. Example: https://ignite.apache.org/docs/latest/memory-configuration/data-regions

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.

Review comment:
       You can take this away after taking into account the draft I shared above.

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.

Review comment:
       Let's open this section with the following paragraph that explains the need for the warm-up strategy. Draft:
   
   _Ignite doesn’t require you to warm memory up from disk on restarts. As soon as a cluster is inter-connected, your application can query and compute on it. At the same time, the memory warm-up feature is designed for low-latency applications that prefer data being loaded in memory before it can be queried._

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be configured both for all regions (by default) or for each region separately.
+====
+
+Presently, Ignite warm-up strategy implies loading data into the region, starting with indexes, until it runs out of free space.
+
+To warm up all data regions, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To warm up a specific data region, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To stop warming up all data regions, pass the configuration parameter `NoOpWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(noOpWarmUpStrategy)
+----
+
+To stop warming up a specific data region, pass the configuration parameter `NoOpWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration` as follows:

Review comment:
       Same as above. Are we stopping an already running warm-up process or just disable the warm-up in the configuration? Applies to the text below.

##########
File path: docs/_docs/memory-configuration/data-regions.adoc
##########
@@ -82,3 +82,72 @@ include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
 tab:C++[unsupported]
 --
 
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be configured both for all regions (by default) or for each region separately.
+====
+
+Presently, Ignite warm-up strategy implies loading data into the region, starting with indexes, until it runs out of free space.
+
+To warm up all data regions, pass the configuration parameter `LoadAllWarmUpStrategy` to the `DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)

Review comment:
       Is this API implemented for .NET and C++ thick clients? Do we need to add code samples for those languages?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org