From 440848c741b4f46b116d10cd99d6a2b91af8b43e Mon Sep 17 00:00:00 2001 From: Jamie Longmuir Date: Thu, 25 Aug 2016 10:47:58 -0400 Subject: [PATCH] =?UTF-8?q?Add=20warning=20to=20Akka=20DD=20docs=20about?= =?UTF-8?q?=20freq=20add/deletes=20of=20top-level=20entit=E2=80=A6=20(#212?= =?UTF-8?q?69)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add warning to Akka DD docs about freq add/deletes of top-level entities - fixes #21249 --- akka-docs/rst/java/distributed-data.rst | 8 ++++++++ akka-docs/rst/scala/distributed-data.rst | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/akka-docs/rst/java/distributed-data.rst b/akka-docs/rst/java/distributed-data.rst index a038405a88..eaad6863d2 100644 --- a/akka-docs/rst/java/distributed-data.rst +++ b/akka-docs/rst/java/distributed-data.rst @@ -240,6 +240,14 @@ Subscribers will receive ``Replicator.DataDeleted``. .. includecode:: code/docs/ddata/DistributedDataDocTest.java#delete +.. warning:: + + As deleted keys continue to be included in the stored data on each node as well as in gossip + messages, a continuous series of updates and deletes of top-level entities will result in + growing memory usage until an ActorSystem runs out of memory. To use Akka Distributed Data + where frequent adds and removes are required, you should use a fixed number of top-level data + types that support both updates and removals, for example ``ORMap`` or ``ORSet``. + Data Types ========== diff --git a/akka-docs/rst/scala/distributed-data.rst b/akka-docs/rst/scala/distributed-data.rst index 9eea9c8a4c..4e0ba1dd9d 100644 --- a/akka-docs/rst/scala/distributed-data.rst +++ b/akka-docs/rst/scala/distributed-data.rst @@ -240,6 +240,14 @@ Subscribers will receive ``Replicator.DataDeleted``. .. includecode:: code/docs/ddata/DistributedDataDocSpec.scala#delete +.. warning:: + + As deleted keys continue to be included in the stored data on each node as well as in gossip + messages, a continuous series of updates and deletes of top-level entities will result in + growing memory usage until an ActorSystem runs out of memory. To use Akka Distributed Data + where frequent adds and removes are required, you should use a fixed number of top-level data + types that support both updates and removals, for example ``ORMap`` or ``ORSet``. + Data Types ==========