This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch 1.7.x
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/1.7.x by this push:
new ee47198990 [1.7.x] docs: fix wrong config keys, class names, artifact
name and defaults (#3586)
ee47198990 is described below
commit ee47198990a5d58eddaa8e1d0e18d9b28af62fb2
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Oct 9 05:31:37 2026 +0100
[1.7.x] docs: fix wrong config keys, class names, artifact name and
defaults (#3586)
* docs: fix wrong config keys and class names in config examples
Motivation:
Several config examples and setting names in the docs use keys or
class names that do not exist, so copying them has no effect or fails.
Modification:
- persistence-plugins.md: auto-start-journals and
auto-start-snapshot-stores take plugin config paths
(pekko.persistence.journal.leveldb,
pekko.persistence.snapshot-store.local), not class-style names
- remoting.md: pekko.remote.classic.retry-gate-closed-for
- multi-jvm-testing.md: -Dpekko.remote.artery.canonical.port instead
of the non-existent pekko.remote.port
- typed/cluster.md: pekko.cluster.failure-detector.implementation-class
- remoting-artery.md: pekko.remote.artery.advanced.aeron.aeron-dir
- cluster-client.md: pekko.actor.provider; fully qualified
org.apache.pekko.cluster.client.ClusterClientReceptionist extension
- cluster-metrics.md: fully qualified
org.apache.pekko.cluster.metrics.ClusterMetricsExtension extension
Result:
Config copied from these examples works.
Tests:
- Not run - docs only; each key and class name checked against the
1.7.x reference.conf files and sources
References:
Refs #3583 (subset of the config key and class name fixes)
* docs: fix blocking-io-dispatcher key, singleton artifact and stated
defaults
Motivation:
More docs give wrong config keys, a wrong artifact name or wrong
default values.
Modification:
- mapWithResource.md, fromOutputStream.md: the blocking dispatcher key
is pekko.stream.materializer.blocking-io-dispatcher (no org.apache.
prefix); these operators are a Flow and a Sink, not a Source
- typed/guide/modules.md: typed Cluster Singleton ships in
pekko-cluster-typed; there is no pekko-cluster-singleton artifact
- typed/cluster-concepts.md: monitored by up to 9 nodes by default
(monitored-by-nr-of-members = 9)
- typed/persistence.md: stash-capacity defaults to 4096 (10000 is an
example) and commands are only dropped with the default
stash-overflow-strategy = "drop"
Result:
Copied keys, artifact names and stated defaults match 1.7.x.
Tests:
- Not run - docs only; checked against the 1.7.x reference.conf files
and build
References:
Refs #3583
---
docs/src/main/paradox/cluster-client.md | 4 ++--
docs/src/main/paradox/cluster-metrics.md | 2 +-
docs/src/main/paradox/multi-jvm-testing.md | 8 ++++----
docs/src/main/paradox/persistence-plugins.md | 4 ++--
docs/src/main/paradox/remoting-artery.md | 2 +-
docs/src/main/paradox/remoting.md | 2 +-
.../paradox/stream/operators/Source-or-Flow/mapWithResource.md | 4 ++--
.../paradox/stream/operators/StreamConverters/fromOutputStream.md | 4 ++--
docs/src/main/paradox/typed/cluster-concepts.md | 2 +-
docs/src/main/paradox/typed/cluster.md | 2 +-
docs/src/main/paradox/typed/guide/modules.md | 2 +-
docs/src/main/paradox/typed/persistence.md | 4 +++-
12 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/docs/src/main/paradox/cluster-client.md
b/docs/src/main/paradox/cluster-client.md
index 0a28f86b76..9f0c0eff03 100644
--- a/docs/src/main/paradox/cluster-client.md
+++ b/docs/src/main/paradox/cluster-client.md
@@ -50,7 +50,7 @@ within the same cluster. Similar functionality as the
@apidoc[ClusterClient] is
provided more efficiently by @ref:[Distributed Publish Subscribe in
Cluster](distributed-pub-sub.md) for actors that
belong to the same cluster.
-The connecting system must have its `org.apache.pekko.actor.provider` set to
`remote` or `cluster` when using
+The connecting system must have its `pekko.actor.provider` set to `remote` or
`cluster` when using
the cluster client.
The receptionist is supposed to be started on all nodes, or all nodes with a
specified role,
@@ -163,7 +163,7 @@ It is recommended to load the extension when the actor
system is started by defi
`pekko.extensions` configuration property:
```
-pekko.extensions = ["pekko.cluster.client.ClusterClientReceptionist"]
+pekko.extensions =
["org.apache.pekko.cluster.client.ClusterClientReceptionist"]
```
## Events
diff --git a/docs/src/main/paradox/cluster-metrics.md
b/docs/src/main/paradox/cluster-metrics.md
index 44ad06b75a..c81700e7f1 100644
--- a/docs/src/main/paradox/cluster-metrics.md
+++ b/docs/src/main/paradox/cluster-metrics.md
@@ -17,7 +17,7 @@ and add the following configuration stanza to your
`application.conf`
:
```
-pekko.extensions = [ "pekko.cluster.metrics.ClusterMetricsExtension" ]
+pekko.extensions = [
"org.apache.pekko.cluster.metrics.ClusterMetricsExtension" ]
```
@@project-info{ projectId="cluster-metrics" }
diff --git a/docs/src/main/paradox/multi-jvm-testing.md
b/docs/src/main/paradox/multi-jvm-testing.md
index db7a55fe0e..fb6f72bb5c 100644
--- a/docs/src/main/paradox/multi-jvm-testing.md
+++ b/docs/src/main/paradox/multi-jvm-testing.md
@@ -149,26 +149,26 @@ You can define specific JVM options for each of the
spawned JVMs. You do that by
a file named after the node in the test with suffix `.opts` and put them in
the same
directory as the test.
-For example, to feed the JVM options `-Dpekko.remote.port=9991` and `-Xmx256m`
to the `SampleMultiJvmNode1`
+For example, to feed the JVM options
`-Dpekko.remote.artery.canonical.port=9991` and `-Xmx256m` to the
`SampleMultiJvmNode1`
let's create three `*.opts` files and add the options to them. Separate
multiple options with
space.
`SampleMultiJvmNode1.opts`:
```
--Dpekko.remote.port=9991 -Xmx256m
+-Dpekko.remote.artery.canonical.port=9991 -Xmx256m
```
`SampleMultiJvmNode2.opts`:
```
--Dpekko.remote.port=9992 -Xmx256m
+-Dpekko.remote.artery.canonical.port=9992 -Xmx256m
```
`SampleMultiJvmNode3.opts`:
```
--Dpekko.remote.port=9993 -Xmx256m
+-Dpekko.remote.artery.canonical.port=9993 -Xmx256m
```
## ScalaTest
diff --git a/docs/src/main/paradox/persistence-plugins.md
b/docs/src/main/paradox/persistence-plugins.md
index e3f7162944..f03bcc6555 100644
--- a/docs/src/main/paradox/persistence-plugins.md
+++ b/docs/src/main/paradox/persistence-plugins.md
@@ -45,12 +45,12 @@ pekko {
journal {
plugin = "pekko.persistence.journal.leveldb"
- auto-start-journals = ["org.apache.pekko.persistence.journal.leveldb"]
+ auto-start-journals = ["pekko.persistence.journal.leveldb"]
}
snapshot-store {
plugin = "pekko.persistence.snapshot-store.local"
- auto-start-snapshot-stores =
["org.apache.pekko.persistence.snapshot-store.local"]
+ auto-start-snapshot-stores = ["pekko.persistence.snapshot-store.local"]
}
}
diff --git a/docs/src/main/paradox/remoting-artery.md
b/docs/src/main/paradox/remoting-artery.md
index 83417fd70a..6d3786345e 100644
--- a/docs/src/main/paradox/remoting-artery.md
+++ b/docs/src/main/paradox/remoting-artery.md
@@ -806,7 +806,7 @@ aeron.threading.mode=SHARED_NETWORK
#aeron.sender.idle.strategy=org.agrona.concurrent.BusySpinIdleStrategy
#aeron.receiver.idle.strategy=org.agrona.concurrent.BusySpinIdleStrategy
-# use same director in pekko.remote.artery.advanced.aeron-dir config
+# use same directory in pekko.remote.artery.advanced.aeron.aeron-dir config
# of the Pekko application
aeron.dir=/dev/shm/aeron
```
diff --git a/docs/src/main/paradox/remoting.md
b/docs/src/main/paradox/remoting.md
index 44eea89249..33e23876f6 100644
--- a/docs/src/main/paradox/remoting.md
+++ b/docs/src/main/paradox/remoting.md
@@ -302,7 +302,7 @@ is attempted to be sent to the remote system or an inbound
connection is accepte
When a communication failure happens and the connection is lost between the
two systems the link becomes `Gated`.
In this state the system will not attempt to connect to the remote host and
all outbound messages will be dropped. The time
-while the link is in the `Gated` state is controlled by the setting
`pekko.remote.retry-gate-closed-for`:
+while the link is in the `Gated` state is controlled by the setting
`pekko.remote.classic.retry-gate-closed-for`:
after this time elapses the link state transitions to `Idle` again. `Gate` is
one-sided in the
sense that whenever a successful *inbound* connection is accepted from a
remote system during `Gate` it automatically
transitions to `Active` and communication resumes immediately.
diff --git
a/docs/src/main/paradox/stream/operators/Source-or-Flow/mapWithResource.md
b/docs/src/main/paradox/stream/operators/Source-or-Flow/mapWithResource.md
index d18bb0b593..ec5ecdf03d 100644
--- a/docs/src/main/paradox/stream/operators/Source-or-Flow/mapWithResource.md
+++ b/docs/src/main/paradox/stream/operators/Source-or-Flow/mapWithResource.md
@@ -32,8 +32,8 @@ Early completion can be done with combination of the
@apidoc[Flow.takeWhile](Flo
See also @ref:[unfoldResource](../Source/unfoldResource.md),
@ref:[unfoldResourceAsync](../Source/unfoldResourceAsync.md).
-You can configure the default dispatcher for this Source by changing the
`org.apache.pekko.stream.materializer.blocking-io-dispatcher`
-or set it for a given Source by using ActorAttributes.
+You can configure the default dispatcher for this Flow by changing the
`pekko.stream.materializer.blocking-io-dispatcher`
+or set it for a given Flow by using ActorAttributes.
## Examples
diff --git
a/docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md
b/docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md
index 21aec2ec9b..04462ea2cf 100644
---
a/docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md
+++
b/docs/src/main/paradox/stream/operators/StreamConverters/fromOutputStream.md
@@ -15,8 +15,8 @@ Creates a Sink which writes incoming
@apidoc[util.ByteString]s to a `java.io.Out
Materializes a @java[`CompletionStage`]@scala[`Future`] of `IOResult` that
will be completed with the size of the file (in bytes) on completion,
and a possible exception if IO operation was not completed successfully.
-You can configure the default dispatcher for this Source by changing the
`org.apache.pekko.stream.materializer.blocking-io-dispatcher` or
-set it for a given Source by using `org.apache.pekko.stream.ActorAttributes`.
+You can configure the default dispatcher for this Sink by changing the
`pekko.stream.materializer.blocking-io-dispatcher` or
+set it for a given Sink by using `org.apache.pekko.stream.ActorAttributes`.
If `autoFlush` is true the OutputStream will be flushed whenever a byte array
is written, defaults to false.
The `OutputStream` will be closed when the stream flowing into this `Sink` is
completed. The `Sink`
diff --git a/docs/src/main/paradox/typed/cluster-concepts.md
b/docs/src/main/paradox/typed/cluster-concepts.md
index d198df2ed0..32a06236cc 100644
--- a/docs/src/main/paradox/typed/cluster-concepts.md
+++ b/docs/src/main/paradox/typed/cluster-concepts.md
@@ -72,7 +72,7 @@ To be able to survive sudden abnormalities, such as garbage
collection pauses an
transient network failures the failure detector is easily
@ref:[configurable](cluster.md#using-the-failure-detector)
for tuning to your environments and needs.
-In a cluster each node is monitored by a few (default maximum 5) other nodes.
+In a cluster each node is monitored by a few (default maximum 9) other nodes.
The nodes to monitor are selected from neighbors in a hashed ordered node ring.
This is to increase the likelihood to monitor across racks and data centers,
but the order
is the same on all nodes, which ensures full coverage.
diff --git a/docs/src/main/paradox/typed/cluster.md
b/docs/src/main/paradox/typed/cluster.md
index d3bee04df2..71d1bb7aa0 100644
--- a/docs/src/main/paradox/typed/cluster.md
+++ b/docs/src/main/paradox/typed/cluster.md
@@ -340,7 +340,7 @@ Cluster uses the
@apidoc[remote.PhiAccrualFailureDetector](PhiAccrualFailureDete
implementing the @apidoc[remote.FailureDetector](FailureDetector) and
configuring it:
```
-pekko.cluster.implementation-class = "com.example.CustomFailureDetector"
+pekko.cluster.failure-detector.implementation-class =
"com.example.CustomFailureDetector"
```
In the @ref:[Cluster Configuration](#configuration) you may want to adjust
these
diff --git a/docs/src/main/paradox/typed/guide/modules.md
b/docs/src/main/paradox/typed/guide/modules.md
index c4ff93c8ed..5f71d8ddfb 100644
--- a/docs/src/main/paradox/typed/guide/modules.md
+++ b/docs/src/main/paradox/typed/guide/modules.md
@@ -129,7 +129,7 @@ Challenges that Sharding solves include the following:
symbol1=PekkoVersion
value1="$pekko.version$"
group=org.apache.pekko
- artifact=pekko-cluster-singleton_$scala.binary.version$
+ artifact=pekko-cluster-typed_$scala.binary.version$
version=PekkoVersion
}
diff --git a/docs/src/main/paradox/typed/persistence.md
b/docs/src/main/paradox/typed/persistence.md
index 3e4c2aea65..af621342ee 100644
--- a/docs/src/main/paradox/typed/persistence.md
+++ b/docs/src/main/paradox/typed/persistence.md
@@ -626,7 +626,9 @@ Java
: @@snip
[StashingExample.java](/persistence-typed/src/test/java/jdocs/org/apache/pekko/persistence/typed/StashingExample.java)
{ #stashing }
You should be careful to not send more messages to a persistent actor than it
can keep up with, otherwise the stash
-buffer will fill up and when reaching its maximum capacity the commands will
be dropped. The capacity can be configured with:
+buffer will fill up and when reaching its maximum capacity the commands will
be dropped (with the default
+`pekko.persistence.typed.stash-overflow-strategy = "drop"`; set it to `"fail"`
to fail the actor instead).
+The capacity (default 4096) can be configured with, for example:
```
pekko.persistence.typed.stash-capacity = 10000
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
