Akka.Cluster.Tools 1.5.27

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Akka.Cluster.Tools --version 1.5.27                

                    
                

            
NuGet\Install-Package Akka.Cluster.Tools -Version 1.5.27
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.Tools" Version="1.5.27" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Akka.Cluster.Tools --version 1.5.27                

                    
                

            
#r "nuget: Akka.Cluster.Tools, 1.5.27"
#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.Tools as a Cake Addin
#addin nuget:?package=Akka.Cluster.Tools&version=1.5.27

// Install Akka.Cluster.Tools as a Cake Tool
#tool nuget:?package=Akka.Cluster.Tools&version=1.5.27

Akka.NET

Akka.NET logo

Discord NuGet Nuget

Akka.NET is a .NET port of the popular Akka project from the Scala / Java community. We are an idiomatic .NET implementation of the actor model built on top of the .NET Common Language Runtime.

Akka.NET is a .NET Foundation project.

.NET Foundation Logo

How is Akka.NET Used?

Akka.NET can be used in-process or inside large, distributed real-time systems; we support a wide variety of use cases.

Akka.NET can be used to solve the following types of problems:

  1. Concurrency - Akka.NET actors only process messages one-at-a-time and they do so in first in, first out (FIFO) order; this means that any application state internal to an actor is automatically thread-safe without having to use locks or any other shared-memory synchronization mechanisms.
  2. Stream Processing - Akka.NET actors and Akka.Streams make it easy to build streaming applications, used for processing incoming streams of data or incoming streams of live events such as UI or network events inside native applications.
  3. Event-Driven Programming - actors make it easy to build event-driven applications, as actors' message-processing routines naturally express these types of designs.
  4. Event Sourcing and CQRS - Akka.Persistence, used by actors to make their state re-entrant and recoverable across restarts or migrations between nodes, natively supports event sourcing. Akka.Persistence.Query can be used to compute CQRS-style projections and materialized views from Akka.Persistence data.
  5. Location Transparency - Akka.Remote makes it simple for actors in remote processes to transparently communicate with each other.
  6. Highly Available, Fault-Tolerant Distributed Systems - Akka.Cluster, Akka.Cluster.Sharding, and other tools built on top of Akka.Cluster make it possible to build highly available and fault-tolerant distributed systems by leveraging peer-to-peer programming models with topology-aware message routing and distribution.
  7. Low Latency, High Throughput - Akka.NET aims to be low latency and high throughput, processing 10s millions of messages per second in-memory and hundreds of thousands of messages per second over remote connections.

Where Can I Learn Akka.NET?

You can start by taking the Akka.NET Bootcamp, but there are many other great learning resources for Akka.NET Online.

Build Status

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

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.Hosting

Akka.Hosting includes the base Akka NuGet package and also provides an easy interface to integrate Akka.NET with the most-used parts of the Microsoft.Extensions ecosystem: Configuration, Logging, Hosting, and DependencyInjection. We encourage developers to adopt it.

And if you need F# support:

PM> Install-Package Akka.FSharp

Akka.NET Project Templates

To create your own Akka.NET projects using our templates (Akka.Templates), install them via the dotnet CLI:

dotnet new install "Akka.Templates::*"

This will make our templates available via dotnet new on the CLI and as new project templates inside any .NET IDE such as Visual Studio or JetBrains Rider. You can view the full list of templates included in our package here: https://github.com/akkadotnet/akkadotnet-templates#available-templates

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (12)

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

Package Downloads
Akka.Cluster.Sharding

Sharded actors with managed lifecycle for Akka.NET cluster. Used to distribute state in a fault-tolerant, consistent fashion over an Akka.NET cluster.
AkkaDotModule.Webnori

Package Description
SharpGaming.Akka.PubSub

Bespoke implementation of distributed pubsub for Akka.Net
EventSaucing

An event source stack based on NEventStore and Akka
FAkka.Shared

Package Description

GitHub repositories (2)

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

Repository Stars
ThembisileNGQ/Akkatecture
a cqrs and event sourcing framework for dotnet core using akka.net
Aaronontheweb/InMemoryCQRSReplication
Akka.NET Reference Architecture - CQRS + Sharding + In-Memory Replication
Version Downloads Last updated
1.5.27.1 71 7/26/2024
1.5.27 41 7/25/2024
1.5.27-beta2 1,133 7/3/2024
1.5.27-beta1 171 7/3/2024
1.5.26 5,055 6/27/2024
1.5.25 10,108 6/14/2024
1.5.24 4,070 6/7/2024
1.5.23 594 6/6/2024
1.5.22 1,328 6/3/2024
1.5.21 2,680 5/28/2024
1.5.20 12,832 4/29/2024
1.5.19 10,071 4/15/2024
1.5.18 28,445 3/12/2024
1.5.17.1 5,447 3/2/2024
1.5.17 544 2/29/2024
1.5.16 16,162 1/29/2024
1.5.15 23,203 1/10/2024
1.5.14 27,885 11/3/2023
1.5.13 58,975 9/18/2023
1.5.13-beta1 655 8/25/2023
1.5.12 25,250 8/2/2023
1.5.11 3,246 7/27/2023
1.5.10 7,394 7/25/2023
1.5.9 9,465 7/17/2023
1.5.8 35,329 6/15/2023
1.5.7 26,003 5/17/2023
1.5.6 9,512 5/8/2023
1.5.5 32,359 5/4/2023
1.5.4 9,172 4/25/2023
1.5.3 2,716 4/20/2023
1.5.2 20,645 4/6/2023
1.5.1 9,365 3/15/2023
1.5.0 10,822 3/2/2023
1.5.0-beta6 1,163 3/1/2023
1.5.0-beta5 767 3/1/2023
1.5.0-beta4 851 2/28/2023
1.5.0-beta3 891 2/27/2023
1.5.0-beta2 835 2/23/2023
1.5.0-beta1 799 2/20/2023
1.5.0-alpha4 1,123 2/1/2023
1.5.0-alpha3 1,192 11/15/2022
1.5.0-alpha2 911 10/17/2022
1.5.0-alpha1 885 8/22/2022
1.4.51 5,613 6/28/2023
1.4.50 10,861 3/15/2023
1.4.49 21,964 1/27/2023
1.4.49-beta1 816 1/11/2023
1.4.48 28,074 1/5/2023
1.4.47 15,168 12/9/2022
1.4.46 28,759 11/15/2022
1.4.45 23,289 10/19/2022
1.4.44 2,765 10/17/2022
1.4.43 12,635 9/27/2022
1.4.42 2,445 9/23/2022
1.4.41 129,855 8/31/2022
1.4.40 15,998 7/22/2022
1.4.39 87,639 6/1/2022
1.4.38 39,906 5/6/2022
1.4.37 11,566 4/14/2022
1.4.36 16,114 4/5/2022
1.4.35 21,764 3/18/2022
1.4.34 10,013 3/7/2022
1.4.33 25,165 2/14/2022
1.4.32 14,293 1/18/2022
1.4.31 28,632 12/21/2021
1.4.30 1,614 12/20/2021
1.4.29 2,421 12/13/2021
1.4.28 59,747 11/10/2021
1.4.27 44,526 10/11/2021
1.4.26 5,054 9/28/2021
1.4.25 9,711 9/8/2021
1.4.24 9,967 8/17/2021
1.4.23 3,733 8/10/2021
1.4.22 5,939 8/5/2021
1.4.21 21,182 6/16/2021
1.4.21-beta1 1,165 6/4/2021
1.4.20 20,071 5/12/2021
1.4.19 18,000 4/28/2021
1.4.18 12,595 3/23/2021
1.4.17 6,891 3/10/2021
1.4.16 39,764 1/22/2021
1.4.15 3,463 1/20/2021
1.4.14 12,639 12/30/2020
1.4.13 3,448 12/16/2020
1.4.12 39,819 11/16/2020
1.4.11 13,691 11/5/2020
1.4.10 37,612 8/20/2020
1.4.9 33,160 7/21/2020
1.4.8 50,707 6/17/2020
1.4.7 9,157 5/27/2020
1.4.6 12,280 5/12/2020
1.4.5 6,901 4/29/2020
1.4.4 11,150 3/31/2020
1.4.3 11,181 3/18/2020
1.4.2 5,339 3/13/2020
1.4.1 8,261 3/11/2020
1.4.1-rc3 1,417 3/10/2020
1.4.1-rc2 1,137 3/10/2020
1.4.1-rc1 1,578 2/28/2020
1.4.0-beta4 2,850 1/28/2020
1.4.0-beta3 7,123 10/30/2019
1.4.0-beta2 3,782 9/23/2019
1.4.0-beta1 2,551 7/19/2019
1.3.19 92 5/2/2024
1.3.18 18,067 3/9/2020
1.3.17 44,915 12/20/2019
1.3.16 8,257 11/14/2019
1.3.15 45,526 9/23/2019
1.3.14 25,894 7/30/2019
1.3.13 30,970 4/30/2019
1.3.12 19,298 3/14/2019
1.3.11 23,914 12/18/2018
1.3.10 89,329 11/2/2018
1.3.9 31,327 8/23/2018
1.3.8 27,977 6/5/2018
1.3.7 3,764 5/15/2018
1.3.6 6,319 4/17/2018
1.3.5 14,761 2/22/2018
1.3.4 5,318 2/1/2018
1.3.3 3,341 1/19/2018
1.3.2 24,251 10/21/2017
1.3.1 5,662 9/5/2017
1.3.0 5,152 8/11/2017
1.2.3 5,808 7/10/2017
1.2.2 2,786 6/28/2017
1.2.1 3,182 6/23/2017
1.2.0 22,168 4/12/2017
1.1.3.32-beta 4,886 1/23/2017
1.1.3.31-beta 1,832 1/23/2017
1.1.2.30-beta 5,771 9/22/2016
1.1.2.29-beta 2,007 9/22/2016
1.1.1.28-beta 2,143 7/16/2016
1.1.1.27-beta 1,710 7/16/2016
1.1.0.26-beta 1,823 7/7/2016
1.0.8.25-beta 2,160 4/26/2016
1.0.8.24-beta 1,787 4/26/2016
1.0.7.18-beta 1,971 4/6/2016
1.0.6 3,253 1/18/2016

Akka.NET v1.5.27 is a significant release that includes new features, mission-critical bug fixes, and some performance improvements.
Major Akka.Cluster.Sharding and Akka.Cluster.Tools.Singleton Bug Fixes**
In _all prior versions_ of Akka.NET, there are two high impact distributed systems bugs:
1. [Akka.Cluster.Tools.Singleton: singleton moves earlier than expected - as soon as new node joins](https://github.com/akkadotnet/akka.net/issues/7196)
2. [Akka.Cluster.Sharding: duplicate shards / entities](https://github.com/akkadotnet/akka.net/issues/6973)
As we discovered during the course of our pains-taking bug investigation, these were, in fact, the same issue:
1. The `ClusterSingletonManager` is supposed to _always_ belong on the oldest node of a given role type, but an original design error from the time Akka.Cluster.Tools was first introduced to Akka.NET meant that nodes were always sorted in _descending_ order of `UpNumber`. This is backwards: nodes should always be sorted in _ascending_ order of `UpNumber` - this means that the oldest possible node is always at the front of the "who is oldest?" list held by the `ClusterSingletonManager`. This explains why the singleton could appear to move early during deployments and restarts.
2. The `ClusterSingletonManager` was suspectible to a race condition where if nodes were shutdown and restarted with the same address in under 20 seconds, the default "down removal margin" used by the `ClusterSingletonManager` to tolerate dirty exits, it would be possible after _multiple_ successive, fast, restarts for multiple instances of the singleton to be alive at the same time (for a short period.)
Both of these varieties of problem, duplicate singletons, is what lead to duplicate shards.
As a result we've made the following fixes:
[Akka.Cluster.Tools: deprecate ClustersSingletonManagerSettings.ConsiderAppVersion](https://github.com/akkadotnet/akka.net/pull/7302) - `AppVersion` is no longer considered for singleton placement as it could easily result in split brains.
[Akka.Cluster.Tools: fix mutability and oldest state bugs with `ClusterSingletonManager`](https://github.com/akkadotnet/akka.net/pull/7298) - resolves the issue with rapid rolling restarts creating duplicates. We've tested this fix in our test lab across thousands of coordinator restarts and haven't been able to reproduce the issue since (we could easily do it before.)
[Akka.Cluster.Tools.Singleton / Akka.Cluster.Sharding: fix duplicate shards caused by incorrect `ClusterSingletonManager` `HandOver`](https://github.com/akkadotnet/akka.net/pull/7297) - we fixed the member age problem here, which could cause a second singleton to start at inappropriate times.
Akka.Discovery and `ClusterClient` Discovery Support**
In Akka.NET v1.5.27 we've added support for using Akka.Cluster.Tools.ClusterClient alongside with [Akka.Discovery plugins](https://getakka.net/articles/discovery/index.html) to automatically discover the initial contacts you need for `ClusterClientReceptionist` instances in your environment.
You can read the documentation for how this works here: https://getakka.net/articles/clustering/cluster-client.html#contact-auto-discovery-using-akkadiscovery
Related PRs and issues:
[Akka.Discovery: Add multi-config support to config-based discovery](https://github.com/akkadotnet/akka.net/issues/7271)
[Cluster.Tools: Fix missing VerboseLogging in ClusterClientSettings.Copy method](https://github.com/akkadotnet/akka.net/issues/7272)
[Cluster.Tools: Improve ClusterClientDiscovery to avoid thundering herd problem](https://github.com/akkadotnet/akka.net/issues/7270)
[Cluster.Tools: Change ClusterClientDiscovery to use the new Akka.Management "/cluster-client/receptionist" endpoint](https://github.com/akkadotnet/akka.net/issues/7274)
Other Bug Fixes and Improvements**
[Akka.Cluster: improve gossip serialization performance](https://github.com/akkadotnet/akka.net/pull/7281)
[Akka.Streams: Fix `ActorMaterializerImpl` `null` `LogSource`](https://github.com/akkadotnet/akka.net/pull/7300)
[Akka.Streams: `AlsoTo` may not be failing graph when its sink throws exception](https://github.com/akkadotnet/akka.net/issues/7269)
[Akka.DistributedData: if `lmdb.dir` is null or empty, log a warning and set to default](https://github.com/akkadotnet/akka.net/pull/7292)
To [see the full set of changes in Akka.NET v1.5.27, click here](https://github.com/akkadotnet/akka.net/milestone/109).
| COMMITS | LOC+ | LOC- | AUTHOR |
| --- | --- | --- | --- |
| 15 | 835 | 1001 | Aaron Stannard |
| 12 | 1123 | 207 | Gregorius Soedharmo |