Akka.Cluster 1.5.15

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Akka.Cluster --version 1.5.15

NuGet\Install-Package Akka.Cluster -Version 1.5.15

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.15" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Akka.Cluster --version 1.5.15

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Akka.Cluster, 1.5.15"

#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.15

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Akka.NET

Akka.NET logo

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.

Website: https://getakka.net/
Twitter 🐦: AkkaDotNet
Discussions 📣: Akka.NET GitHub Discussions
Chat 💬: Akka.NET on Discord
StackOverflow ✔️: Akka.NET on StackOverflow

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:

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.
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.
Event-Driven Programming - actors make it easy to build event-driven applications, as actors' message-processing routines naturally express these types of designs.
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.
Location Transparency - Akka.Remote makes it simple for actors in remote processes to transparently communicate with each other.
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.
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
NuGet Pack
.NET Framework Unit Tests
.NET 7 Unit Tests (Windows)
.NET 7 Unit Tests (Linux)
.NET 7 MultiNode Tests (Windows)
.NET 7 MultiNode Tests (Linux)
Docs

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:

Subscribe to the Akka.NET project feed on Twitter: https://twitter.com/AkkaDotNet (@AkkaDotNet)
Join the Akka.NET Discord: https://discord.gg/GSCfPwhbWP
Ask Akka.NET questions on Stack Overflow: http://stackoverflow.com/questions/tagged/akka.net

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.

.NETStandard 2.0
- Akka.Coordination (>= 1.5.15)
- Akka.Remote (>= 1.5.15)
net6.0
- Akka.Coordination (>= 1.5.15)
- Akka.Remote (>= 1.5.15)

NuGet packages (35)

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

Package	Downloads
Akka.Cluster.Tools Distributed publish/subscribe, client and singleton support for Akka.NET cluster	2.3M
Akka.DistributedData Replicated data using CRDT structures	1.8M
Petabridge.Cmd.Cluster Akka.Cluster Petabridge.Cmd palettes for cluster management and monitoring.	809.3K
Akka.HealthCheck.Cluster Akka.NET and Akka.Cluster healthchecks for environments like K8s, AWS, Azure, Pivotal Cloud Foundry, and more.	247.7K
Akka.Management Akka cluster management module for Akka.NET	173.2K

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	524

Version	Downloads	Last updated
1.5.31	4,411	11/11/2024
1.5.30	16,158	10/3/2024
1.5.29	1,998	10/1/2024
1.5.28	26,820	9/4/2024
1.5.28-beta1	342	8/23/2024
1.5.27.1	42,632	7/26/2024
1.5.27	420	7/25/2024
1.5.27-beta2	2,907	7/3/2024
1.5.27-beta1	347	7/3/2024
1.5.26	57,074	6/27/2024
1.5.25	44,106	6/14/2024
1.5.24	8,572	6/7/2024
1.5.23	1,272	6/6/2024
1.5.22	2,270	6/3/2024
1.5.21	4,576	5/28/2024
1.5.20	24,811	4/29/2024
1.5.19	21,153	4/15/2024
1.5.18	39,210	3/12/2024
1.5.17.1	11,482	3/2/2024
1.5.17	961	2/29/2024
1.5.16	25,876	1/29/2024
1.5.15	31,954	1/10/2024
1.5.14	38,095	11/3/2023
1.5.13	83,093	9/18/2023
1.5.13-beta1	861	8/25/2023
1.5.12	51,918	8/2/2023
1.5.11	3,817	7/27/2023
1.5.10	8,681	7/25/2023
1.5.9	14,751	7/17/2023
1.5.8	61,458	6/15/2023
1.5.7	58,877	5/17/2023
1.5.6	11,816	5/8/2023
1.5.5	37,379	5/4/2023
1.5.4	15,391	4/25/2023
1.5.3	3,517	4/20/2023
1.5.2	65,620	4/6/2023
1.5.1	10,852	3/15/2023
1.5.0	52,402	3/2/2023
1.5.0-beta6	1,523	3/1/2023
1.5.0-beta5	1,018	3/1/2023
1.5.0-beta4	1,078	2/28/2023
1.5.0-beta3	1,137	2/27/2023
1.5.0-beta2	1,046	2/23/2023
1.5.0-beta1	2,681	2/20/2023
1.5.0-alpha4	1,408	2/1/2023
1.5.0-alpha3	1,558	11/15/2022
1.5.0-alpha2	1,122	10/17/2022
1.5.0-alpha1	1,182	8/22/2022
1.4.51	19,203	6/28/2023
1.4.50	12,754	3/15/2023
1.4.49	26,974	1/27/2023
1.4.49-beta1	1,020	1/11/2023
1.4.48	34,372	1/5/2023
1.4.47	19,128	12/9/2022
1.4.46	36,729	11/15/2022
1.4.45	29,543	10/19/2022
1.4.44	4,329	10/17/2022
1.4.43	15,400	9/27/2022
1.4.42	5,066	9/23/2022
1.4.41	146,327	8/31/2022
1.4.40	18,811	7/22/2022
1.4.39	104,119	6/1/2022
1.4.38	42,565	5/6/2022
1.4.37	29,458	4/14/2022
1.4.36	19,119	4/5/2022
1.4.35	26,917	3/18/2022
1.4.34	14,782	3/7/2022
1.4.33	42,323	2/14/2022
1.4.32	22,790	1/18/2022
1.4.31	36,234	12/21/2021
1.4.30	2,678	12/20/2021
1.4.29	4,596	12/13/2021
1.4.28	78,507	11/10/2021
1.4.27	69,929	10/11/2021
1.4.26	7,870	9/28/2021
1.4.25	12,975	9/8/2021
1.4.24	16,562	8/17/2021
1.4.23	5,660	8/10/2021
1.4.22	7,594	8/5/2021
1.4.21	53,650	6/16/2021
1.4.21-beta1	1,649	6/4/2021
1.4.20	29,224	5/12/2021
1.4.19	65,560	4/28/2021
1.4.18	18,925	3/23/2021
1.4.17	10,938	3/10/2021
1.4.16	46,760	1/22/2021
1.4.15	5,056	1/20/2021
1.4.14	18,014	12/30/2020
1.4.13	5,757	12/16/2020
1.4.12	227,937	11/16/2020
1.4.11	22,352	11/5/2020
1.4.10	66,450	8/20/2020
1.4.9	37,672	7/21/2020
1.4.8	64,330	6/17/2020
1.4.7	12,594	5/27/2020
1.4.6	15,622	5/12/2020
1.4.5	9,185	4/29/2020
1.4.4	19,922	3/31/2020
1.4.3	13,390	3/18/2020
1.4.2	7,231	3/13/2020
1.4.1	29,344	3/11/2020
1.4.1-rc3	2,443	3/10/2020
1.4.1-rc2	1,826	3/10/2020
1.4.1-rc1	2,631	2/28/2020
1.4.0-beta4	3,032	1/28/2020
1.4.0-beta3	9,612	10/30/2019
1.4.0-beta2	4,519	9/23/2019
1.4.0-beta1	3,950	7/19/2019
1.3.19	273	5/2/2024
1.3.18	19,405	3/9/2020
1.3.17	68,220	12/20/2019
1.3.16	26,609	11/14/2019
1.3.15	71,013	9/23/2019
1.3.14	57,732	7/30/2019
1.3.13	48,928	4/30/2019
1.3.12	101,024	3/14/2019
1.3.11	122,472	12/18/2018
1.3.10	101,459	11/2/2018
1.3.9	50,251	8/23/2018
1.3.8	40,671	6/5/2018
1.3.7	8,225	5/15/2018
1.3.6	8,225	4/17/2018
1.3.5	24,041	2/22/2018
1.3.4	8,626	2/1/2018
1.3.3	8,827	1/19/2018
1.3.2	35,346	10/21/2017
1.3.1	12,847	9/5/2017
1.3.0	8,057	8/11/2017
1.2.3	13,357	7/10/2017
1.2.2	3,992	6/28/2017
1.2.1	4,034	6/23/2017
1.2.0	29,045	4/12/2017
1.1.3	12,660	1/23/2017
1.1.2	17,078	9/22/2016
1.1.1	8,568	7/16/2016
1.1.0	8,619	7/7/2016
1.0.8.25-beta	3,817	4/26/2016
1.0.8.24-beta	1,932	4/26/2016
1.0.7.18-beta	2,756	4/6/2016
1.0.6.17-beta	4,962	1/18/2016
1.0.6.16-beta	967	1/18/2016
1.0.5.15-beta	2,019	12/3/2015
1.0.5.14-beta	1,138	12/3/2015
1.0.4.12-beta	3,819	8/7/2015
1.0.3.11-beta	1,305	6/12/2015
1.0.2.9-beta	1,700	6/3/2015
1.0.1-pre1504282013	1,710	4/28/2015
1.0.0-pre1504092226	1,310	4/9/2015
1.0.0-dev1504032244	1,098	4/3/2015
0.8.0-pre1502120115	1,320	2/12/2015
0.7.1-pre1412132130	1,423	12/13/2014
0.7.0-pre1410202041	1,204	10/20/2014
0.7.0-pre1410201924	1,383	10/20/2014

Akka.NET v1.5.15 is a significant release for Akka.NET with some major feature additions and changes.
[Introducing `Akka.Analyzers` - Roslyn Analysis for Akka.NET](https://getakka.net/articles/debugging/akka-analyzers.html)
[Akka.Cluster.Sharding: perf optimize message extraction, automate `StartEntity` and `ShardEnvelope` handling](https://github.com/akkadotnet/akka.net/pull/6863)
[Akka.Cluster.Tools: Make `ClusterClient` messages be serialized using `ClusterClientMessageSerializer`](https://github.com/akkadotnet/akka.net/pull/7032)
[Akka.Persistence: Fix `LocalSnapshotStore` Metadata Fetch to ensure persistenceid match.](https://github.com/akkadotnet/akka.net/pull/7040)
[Akka.Delivery: Fix `ProducerControllerImpl<T>` state bug](https://github.com/akkadotnet/akka.net/pull/7034)
[Change MS.EXT and System package versioning to range](https://github.com/akkadotnet/akka.net/pull/7029) - we now support all Microsoft.Extensions packages from `(6.0,]`.
[Akka.Serialization: `INoSerializationVerificationNeeded` does not handle `IWrappedMessage` correctly](https://github.com/akkadotnet/akka.net/pull/7010)
Akka.Analyzers**
The core Akka NuGet package now references [Akka.Analyzers](https://github.com/akkadotnet/akka.analyzers), a new set of Roslyn Code Analysis and Code Fix Providers that we distribute via NuGet. You can [see the full set of supported Akka.Analyzers rules here](https://getakka.net/articles/debugging/akka-analyzers.html).
Akka.Cluster.Sharding Changes**
In [#6863](https://github.com/akkadotnet/akka.net/pull/6863) we made some major changes to the Akka.Cluster.Sharding API aimed at helping improve Cluster.Sharding's performance _and_ ease of use. However, these changes _may require some effort on the part of the end user_ in order to take full advantage:
[`ExtractEntityId`](https://getakka.net/api/Akka.Cluster.Sharding.ExtractEntityId.html) and [`ExtractShardId`](https://getakka.net/api/Akka.Cluster.Sharding.ExtractShardId.html) have been deprecated as they _fundamentally can't be extended and can't benefit from the performance improvements introduced into Akka.NET v1.5.15_. It is **imperative** that you migrate to using the [`HashCodeMessageExtractor`](https://getakka.net/api/Akka.Cluster.Sharding.HashCodeMessageExtractor.html) instead.
You no longer need to handle [`ShardRegion.StartEntity`](https://getakka.net/api/Akka.Cluster.Sharding.ShardRegion.StartEntity.html) or [`ShardingEnvelope`](https://getakka.net/api/Akka.Cluster.Sharding.ShardingEnvelope.html) inside your `IMessageExtractor` implementations, and in fact [`AK2001`](https://getakka.net/articles/debugging/rules/AK2001.html) (part of Akka.Analyzers) will automatically detect this and remove those handlers for you. Akka.NET automatically handles these two message types internally now.
ClusterClient Serialization Changes**
In [#7032](https://github.com/akkadotnet/akka.net/pull/7032) we solved a long-standing serialization problem with the [`ClusterClient`](https://getakka.net/api/Akka.Cluster.Tools.Client.ClusterClient.html) where `Send`, `SendToAll`, and `Publish` were not handled by the correct internal serializer. This has been fixed by default in Akka.NET v1.5.15, but this can potentially cause wire compatibility problems during upgrades - therefore we have introduced a configuration setting to toggle this:
```hocon
# re-enable legacy serialization
akka.cluster.client.use-legacy-serialization = on
```
That setting is currently set to `on` by default, so v1.5.15 will still behave like previous versions of Akka.NET. However, if you have been affected by serialization issues with the `ClusterClient` (such as [#6803](https://github.com/akkadotnet/akka.net/issues/6803)) you should toggle this setting to `off`.
See "[Akka.NET v1.5.15 Upgrade Advisories](https://getakka.net/community/whats-new/akkadotnet-v1.5-upgrade-advisories.html)" for full details on some of the things you might need to do while upgrading to this version of Akka.NET.
You can [see the full set of changes for Akka.NET v1.5.15 here](https://github.com/akkadotnet/akka.net/milestones/1.5.15).
| COMMITS | LOC+ | LOC- | AUTHOR |
| --- | --- | --- | --- |
| 16 | 2228 | 1490 | Aaron Stannard |
| 9 | 9 | 9 | dependabot[bot] |
| 2 | 610 | 173 | Gregorius Soedharmo |
| 2 | 337 | 0 | Drew |
| 2 | 124 | 118 | Lehonti Ramos |
| 1 | 2 | 2 | Sergey Popov |
| 1 | 108 | 25 | Yaroslav Paslavskiy |
| 1 | 1 | 1 | Bert Lamb |