Akka.Cluster 1.5.0-alpha1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 .NET Standard 2.0
This is a prerelease version of Akka.Cluster.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Akka.Cluster --version 1.5.0-alpha1
NuGet\Install-Package Akka.Cluster -Version 1.5.0-alpha1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Akka.Cluster" Version="1.5.0-alpha1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Akka.Cluster --version 1.5.0-alpha1
#r "nuget: Akka.Cluster, 1.5.0-alpha1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Akka.Cluster as a Cake Addin
#addin nuget:?package=Akka.Cluster&version=1.5.0-alpha1&prerelease

// Install Akka.Cluster as a Cake Tool
#tool nuget:?package=Akka.Cluster&version=1.5.0-alpha1&prerelease

Akka.NET

Akka.NET logo

Gitter <br/>

Akka.NET is a professional-grade port of the popular Java/Scala framework Akka distributed actor framework to .NET.

Akka.NET is a .NET Foundation project.

.NET Foundation Logo

Build Status

Stage Status
Build Build Status
NuGet Pack Build Status
.NET Framework Unit Tests Build Status
.NET Framework MultiNode Tests Build Status
.NET Core (Windows) Unit Tests Build Status
.NET Core (Linux) Unit Tests Build Status
.NET Core (Windows) MultiNode Tests Build Status
.NET Core (Linux) MultiNode Tests
Docs Build Status

Documentation and resources

Akka.NET Project Site

Install Akka.NET via NuGet

If you want to include Akka.NET in your project, you can install it directly from NuGet

To install Akka.NET Distributed Actor Framework, run the following command in the Package Manager Console

PM> Install-Package Akka
PM> Install-Package Akka.Remote

And if you need F# support:

PM> Install-Package Akka.FSharp

Builds

Please see Building Akka.NET.

To access nightly Akka.NET builds, please see the instructions here.

Support

If you need help getting started with Akka.NET, there's a number of great community resources online:

If you and your company are interested in getting professional Akka.NET support, you can contact Petabridge for dedicated Akka.NET support.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (35)

Showing the top 5 NuGet packages that depend on Akka.Cluster:

Package Downloads
Akka.Cluster.Tools The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Distributed publish/subscribe, client and singleton support for Akka.NET cluster

Akka.DistributedData The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Replicated data using CRDT structures

Petabridge.Cmd.Cluster The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Akka.Cluster Petabridge.Cmd palettes for cluster management and monitoring.

Emerald

Emerald framework.

wyvern.entity

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Akka.Cluster:

Repository Stars
ThembisileNGQ/Akkatecture
a cqrs and event sourcing framework for dotnet core using akka.net
Version Downloads Last updated
1.5.1 1,409 3/15/2023
1.5.0 5,297 3/2/2023
1.5.0-beta6 303 3/1/2023
1.5.0-beta5 70 3/1/2023
1.5.0-beta4 88 2/28/2023
1.5.0-beta3 132 2/27/2023
1.5.0-beta2 90 2/23/2023
1.5.0-beta1 1,550 2/20/2023
1.5.0-alpha4 363 2/1/2023
1.5.0-alpha3 420 11/15/2022
1.5.0-alpha2 195 10/17/2022
1.5.0-alpha1 235 8/22/2022
1.4.50 350 3/15/2023
1.4.49 10,322 1/27/2023
1.4.49-beta1 71 1/11/2023
1.4.48 13,308 1/5/2023
1.4.47 10,573 12/9/2022
1.4.46 18,421 11/15/2022
1.4.45 18,927 10/19/2022
1.4.44 2,211 10/17/2022
1.4.43 8,603 9/27/2022
1.4.42 2,831 9/23/2022
1.4.41 32,173 8/31/2022
1.4.40 12,374 7/22/2022
1.4.39 54,520 6/1/2022
1.4.38 39,823 5/6/2022
1.4.37 22,430 4/14/2022
1.4.36 11,181 4/5/2022
1.4.35 20,858 3/18/2022
1.4.34 11,442 3/7/2022
1.4.33 31,732 2/14/2022
1.4.32 18,603 1/18/2022
1.4.31 24,030 12/21/2021
1.4.30 814 12/20/2021
1.4.29 2,470 12/13/2021
1.4.28 58,189 11/10/2021
1.4.27 57,740 10/11/2021
1.4.26 5,060 9/28/2021
1.4.25 11,072 9/8/2021
1.4.24 13,204 8/17/2021
1.4.23 3,727 8/10/2021
1.4.22 5,675 8/5/2021
1.4.21 37,911 6/16/2021
1.4.21-beta1 725 6/4/2021
1.4.20 24,607 5/12/2021
1.4.19 52,295 4/28/2021
1.4.18 15,236 3/23/2021
1.4.17 8,722 3/10/2021
1.4.16 44,329 1/22/2021
1.4.15 2,483 1/20/2021
1.4.14 12,873 12/30/2020
1.4.13 3,786 12/16/2020
1.4.12 142,373 11/16/2020
1.4.11 18,920 11/5/2020
1.4.10 58,146 8/20/2020
1.4.9 34,281 7/21/2020
1.4.8 56,496 6/17/2020
1.4.7 10,148 5/27/2020
1.4.6 12,738 5/12/2020
1.4.5 7,258 4/29/2020
1.4.4 16,060 3/31/2020
1.4.3 10,821 3/18/2020
1.4.2 5,070 3/13/2020
1.4.1 22,122 3/11/2020
1.4.1-rc3 1,452 3/10/2020
1.4.1-rc2 936 3/10/2020
1.4.1-rc1 1,602 2/28/2020
1.4.0-beta4 2,113 1/28/2020
1.4.0-beta3 8,667 10/30/2019
1.4.0-beta2 3,654 9/23/2019
1.4.0-beta1 2,899 7/19/2019
1.3.18 16,878 3/9/2020
1.3.17 63,204 12/20/2019
1.3.16 24,555 11/14/2019
1.3.15 63,926 9/23/2019
1.3.14 52,313 7/30/2019
1.3.13 39,853 4/30/2019
1.3.12 90,783 3/14/2019
1.3.11 98,883 12/18/2018
1.3.10 76,994 11/2/2018
1.3.9 47,352 8/23/2018
1.3.8 38,058 6/5/2018
1.3.7 6,707 5/15/2018
1.3.6 6,785 4/17/2018
1.3.5 20,463 2/22/2018
1.3.4 7,346 2/1/2018
1.3.3 7,062 1/19/2018
1.3.2 31,843 10/21/2017
1.3.1 10,702 9/5/2017
1.3.0 6,076 8/11/2017
1.2.3 11,242 7/10/2017
1.2.2 2,677 6/28/2017
1.2.1 2,309 6/23/2017
1.2.0 26,666 4/12/2017
1.1.3 10,451 1/23/2017
1.1.2 14,318 9/22/2016
1.1.1 6,771 7/16/2016
1.1.0 6,512 7/7/2016
1.0.8.25-beta 2,914 4/26/2016
1.0.8.24-beta 1,165 4/26/2016
1.0.7.18-beta 1,906 4/6/2016
1.0.6.17-beta 4,597 1/18/2016
1.0.6.16-beta 861 1/18/2016
1.0.5.15-beta 1,880 12/3/2015
1.0.5.14-beta 1,030 12/3/2015
1.0.4.12-beta 3,616 8/7/2015
1.0.3.11-beta 1,198 6/12/2015
1.0.2.9-beta 1,569 6/3/2015
1.0.1-pre1504282013 1,594 4/28/2015
1.0.0-pre1504092226 1,175 4/9/2015
1.0.0-dev1504032244 987 4/3/2015
0.8.0-pre1502120115 1,185 2/12/2015
0.7.1-pre1412132130 1,303 12/13/2014
0.7.0-pre1410202041 1,086 10/20/2014
0.7.0-pre1410201924 1,216 10/20/2014

Akka.NET v1.5.0-alpha1 is a major release that contains a lot of code improvement and rewrites/refactors. **Major upgrades to Akka.Cluster.Sharding in particular**.
__Deprecation__
Some codes and packages are being deprecated in v1.5
[Deprecated/removed Akka.DI package](https://github.com/akkadotnet/akka.net/pull/6003)
Please use the new `Akka.DependencyInjection` NuGet package as a replacement. Documentation can be read [here](https://getakka.net/articles/actors/dependency-injection.html)
[Deprecated/removed Akka.MultiNodeTestRunner package](https://github.com/akkadotnet/akka.net/pull/6002)
Please use the new `Akka.MultiNode.TestAdapter` NuGet package as a replacement. Documentation can be read [here](https://getakka.net/articles/testing/multi-node-testing.html).
[Streams] [Refactor `SetHandler(Inlet, Outlet, IanAndOutGraphStageLogic)` to `SetHandlers()`](https://github.com/akkadotnet/akka.net/pull/5931)
__Changes__
__Akka__
[Add dual targetting to support .NET 6.0](https://github.com/akkadotnet/akka.net/pull/5926)
All `Akka.NET` packages are now dual targetting netstandard2.0 and net6.0 platforms, we will be integrating .NET 6.0 better performing API and SDK in the future.
[Add `IThreadPoolWorkItem` support to `ThreadPoolDispatcher`](https://github.com/akkadotnet/akka.net/pull/5943)
[Add `ValueTask` support to `PipeTo` extensions](https://github.com/akkadotnet/akka.net/pull/6025)
[Add `CancellationToken` support to `Cancelable`](https://github.com/akkadotnet/akka.net/pull/6032)
[Fix long starting loggers crashing `ActorSystem` startup](https://github.com/akkadotnet/akka.net/pull/6053)
All loggers are asynchronously started during `ActorSystem` startup. A warning will be logged if a logger does not respond within the prescribed `akka.logger-startup-timeout` period and will be awaited upon in a detached task until the `ActorSystem` is shut down. This have a side effect in that slow starting loggers might not be able to capture all log events emmited by the `EventBus` until it is ready.
__Akka.Cluster__
[Fix `ChannelTaskScheduler` to work with Akka.Cluster, ported from 1.4](https://github.com/akkadotnet/akka.net/pull/5920)
[Harden `Cluster.JoinAsync()` and `Cluster.JoinSeedNodesAsync()` methods](https://github.com/akkadotnet/akka.net/pull/6033)
[Fix `ShardedDaemonProcess` should use lease, if configured](https://github.com/akkadotnet/akka.net/pull/6058)
[Make `SplitBrainResolver` more tolerant to invalid node records](https://github.com/akkadotnet/akka.net/pull/6064)
[Enable `Heartbeat` and `HearbeatRsp` message serialization and deserialization](https://github.com/akkadotnet/akka.net/pull/6063)
By default, `Akka.Cluster` will now use the new `Heartbeat` and `HartbeatRsp` message serialization/deserialization that was introduced in version 1.4.19. If you're doing a rolling upgrade from a version older than 1.4.19, you will need to set `akka.cluster.use-legacy-heartbeat-message` to true.
__Akka.Cluster.Sharding__
[Make Cluster.Sharding recovery more tolerant against corrupted persistence data](https://github.com/akkadotnet/akka.net/pull/5978)
[Major reorganization to Akka.Cluster.Sharding](https://github.com/akkadotnet/akka.net/pull/5857)
The Akka.Cluster.Sharding changes in Akka.NET v1.5 are significant, but backwards compatible with v1.4 and upgrades should happen seamlessly.
Akka.Cluster.Sharding's `state-store-mode` has been split into two parts:
CoordinatorStore
ShardStore
Which can use different persistent mode configured via `akka.cluster.sharding.state-store-mode` & `akka.cluster.sharding.remember-entities-store`.
Possible combinations:
state-store-mode | remember-entities-store | CoordinatorStore mode | ShardStore mode
------------------ | ------------------------- | ------------------------ | ------------------
persistence (default) | - (ignored) | persistence | persistence
ddata | ddata | ddata | ddata
ddata | eventsourced (new) | ddata | persistence
There should be no breaking changes from user perspective. Only some internal messages/objects were moved.
There should be no change in the `PersistentId` behavior and default persistent configuration (`akka.cluster.sharding.state-store-mode`)
This change is designed to speed up the performance of Akka.Cluster.Sharding coordinator recovery by moving `remember-entities` recovery into separate actors - this also solves major performance problems with the `ddata` recovery mode overall.
The recommended settings for maximum ease-of-use for Akka.Cluster.Sharding going forward will be:
```
akka.cluster.sharding{
state-store-mode = ddata
remember-entities-store = eventsourced
}
```
However, for the sake of backwards compatibility the Akka.Cluster.Sharding defaults have been left as-is:
```
akka.cluster.sharding{
state-store-mode = persistence
# remember-entities-store (not set - also uses legacy Akka.Persistence)
}
```
Switching over to using `remember-entities-store = eventsourced` will cause an initial migration of data from the `ShardCoordinator`'s journal into separate event journals going forward - __this migration is irreversible__ without taking the cluster offline and deleting all Akka.Cluster.Sharding-related data from Akka.Persistence, so plan accordingly.
__Akka.Cluster.Tools__
[Add typed `ClusterSingleton` support](https://github.com/akkadotnet/akka.net/pull/6050)
[Singleton can use `Member.AppVersion` metadata to decide its host node during hand-over](https://github.com/akkadotnet/akka.net/pull/6065)
`Akka.Cluster.Singleton` can use `Member.AppVersion` metadata when it is relocating the singleton instance. When turned on, new singleton instance will be created on the oldest node in the cluster with the highest `AppVersion` number. You can opt-in to this behavior by setting `akka.cluster.singleton.consider-app-version` to true.
__Akka.Persistence.Query__
[Add `TimeBasedUuid` offset property](https://github.com/akkadotnet/akka.net/pull/5995)
__Akka.Remote__
[Fix typo in HOCON SSL settings. Backward compatible with the old setting names](https://github.com/akkadotnet/akka.net/pull/5895)
[Treat all exceptions thrown inside `EndpointReader` message dispatch as transient, Ported from 1.4](https://github.com/akkadotnet/akka.net/pull/5972)
[Fix SSL enable HOCON setting](https://github.com/akkadotnet/akka.net/pull/6038)
__Akka.Streams__
[Allow GroupBy sub-flow to re-create closed sub-streams, backported to 1.4](https://github.com/akkadotnet/akka.net/pull/5874)
[Fix ActorRef source not completing properly, backported to 1.4](https://github.com/akkadotnet/akka.net/pull/5875)
[Rewrite `ActorRefSink` as a `GraphStage`](https://github.com/akkadotnet/akka.net/pull/5920)
[Add stream cancellation cause upstream propagation, ported from 1.4](https://github.com/akkadotnet/akka.net/pull/5949)
[Fix `VirtualProcessor` subscription bug, ported from 1.4](https://github.com/akkadotnet/akka.net/pull/5950)
[Refactor `Sink.Ignore` signature from `Task` to `Task<Done>`](https://github.com/akkadotnet/akka.net/pull/5973)
[Add `SourceWithContext.FromTuples()` operator`](https://github.com/akkadotnet/akka.net/pull/5987)
[Add `GroupedWeightedWithin` operator](https://github.com/akkadotnet/akka.net/pull/6000)
[Add `IAsyncEnumerable` source](https://github.com/akkadotnet/akka.net/pull/6044)
__Akka.TestKit__
[Rewrite Akka.TestKit to work asynchronously from the ground up](https://github.com/akkadotnet/akka.net/pull/5953)