Akka.Hosting
0.5.2-beta1
Prefix Reserved
See the version list below for details.
dotnet add package Akka.Hosting --version 0.5.2-beta1
NuGet\Install-Package Akka.Hosting -Version 0.5.2-beta1
<PackageReference Include="Akka.Hosting" Version="0.5.2-beta1" />
paket add Akka.Hosting --version 0.5.2-beta1
#r "nuget: Akka.Hosting, 0.5.2-beta1"
// Install Akka.Hosting as a Cake Addin #addin nuget:?package=Akka.Hosting&version=0.5.2-beta1&prerelease // Install Akka.Hosting as a Cake Tool #tool nuget:?package=Akka.Hosting&version=0.5.2-beta1&prerelease
Akka.Hosting
BETA: this project is currently in beta status as part of the Akka.NET v1.5 development effort, but the packages published in this repository will be backwards compatible for Akka.NET v1.4 users.
HOCON-less configuration, application lifecycle management, ActorSystem
startup, and actor instantiation for Akka.NET.
Consists of the following packages:
Akka.Hosting
- core, needed for everythingAkka.Remote.Hosting
- enables Akka.Remote configurationAkka.Cluster.Hosting
- used for Akka.Cluster, Akka.Cluster.Sharding, and Akka.Cluster.ToolsAkka.Persistence.SqlServer.Hosting
- used for Akka.Persistence.SqlServer support.Akka.Persistence.PostgreSql.Hosting
- used for Akka.Persistence.PostgreSql support.Akka.Persistence.Azure.Hosting
- used for Akka.Persistence.Azure support. Documentation can be read here- The Akka.Management Project Repository - useful tools for managing Akka.NET clusters running inside containerized or cloud based environment.
Akka.Hosting
is embedded in each of its packages:Akka.Management
- core module of the management utilities which provides a central HTTP endpoint for Akka management extensions.Akka.Management.Cluster.Bootstrap
- used to bootstrap a cluster formation inside dynamic deployment environments, relies onAkka.Discovery
to function.Akka.Discovery.AwsApi
- provides dynamic node discovery service for AWS EC2 environment.Akka.Discovery.Azure
- provides a dynamic node discovery service for Azure PaaS ecosystem.Akka.Discovery.KubernetesApi
- provides a dynamic node discovery service for Kubernetes clusters.Akka.Coordination.KubernetesApi
- provides a lease-based distributed lock mechanism for Akka Split Brain Resolver, Akka.Cluster.Sharding, and Akka.Cluster.Singleton
See the "Introduction to Akka.Hosting - HOCONless, "Pit of Success" Akka.NET Runtime and Configuration" video for a walkthrough of the library and how it can save you a tremendous amount of time and trouble.
Summary
We want to make Akka.NET something that can be instantiated more typically per the patterns often used with the Microsoft.Extensions.Hosting APIs that are common throughout .NET.
using Akka.Hosting;
using Akka.Actor;
using Akka.Actor.Dsl;
using Akka.Cluster.Hosting;
using Akka.Remote.Hosting;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddAkka("MyActorSystem", configurationBuilder =>
{
configurationBuilder
.WithRemoting("localhost", 8110)
.WithClustering(new ClusterOptions(){ Roles = new[]{ "myRole" },
SeedNodes = new[]{ Address.Parse("akka.tcp://MyActorSystem@localhost:8110")}})
.WithActors((system, registry) =>
{
var echo = system.ActorOf(act =>
{
act.ReceiveAny((o, context) =>
{
context.Sender.Tell($"{context.Self} rcv {o}");
});
}, "echo");
registry.TryRegister<Echo>(echo); // register for DI
});
});
var app = builder.Build();
app.MapGet("/", async (context) =>
{
var echo = context.RequestServices.GetRequiredService<ActorRegistry>().Get<Echo>();
var body = await echo.Ask<string>(context.TraceIdentifier, context.RequestAborted).ConfigureAwait(false);
await context.Response.WriteAsync(body);
});
app.Run();
No HOCON. Automatically runs all Akka.NET application lifecycle best practices behind the scene. Automatically binds the ActorSystem
and the ActorRegistry
, another new 1.5 feature, to the IServiceCollection
so they can be safely consumed via both actors and non-Akka.NET parts of users' .NET applications.
This should be open to extension in other child plugins, such as Akka.Persistence.SqlServer
:
builder.Services.AddAkka("MyActorSystem", configurationBuilder =>
{
configurationBuilder
.WithRemoting("localhost", 8110)
.WithClustering(new ClusterOptions()
{
Roles = new[] { "myRole" },
SeedNodes = new[] { Address.Parse("akka.tcp://MyActorSystem@localhost:8110") }
})
.WithSqlServerPersistence(builder.Configuration.GetConnectionString("sqlServerLocal"))
.WithShardRegion<UserActionsEntity>("userActions", s => UserActionsEntity.Props(s),
new UserMessageExtractor(),
new ShardOptions(){ StateStoreMode = StateStoreMode.DData, Role = "myRole"})
.WithActors((system, registry) =>
{
var userActionsShard = registry.Get<UserActionsEntity>();
var indexer = system.ActorOf(Props.Create(() => new Indexer(userActionsShard)), "index");
registry.TryRegister<Index>(indexer); // register for DI
});
})
ActorRegistry
As part of Akka.Hosting, we need to provide a means of making it easy to pass around top-level IActorRef
s via dependency injection both within the ActorSystem
and outside of it.
The ActorRegistry
will fulfill this role through a set of generic, typed methods that make storage and retrieval of long-lived IActorRef
s easy and coherent:
var registry = ActorRegistry.For(myActorSystem); // fetch from ActorSystem
registry.TryRegister<Index>(indexer); // register for DI
registry.Get<Index>(); // use in DI
Microsoft.Extensions.Logging Integration
Logger Configuration Support
You can now use the new AkkaConfigurationBuilder
extension method called ConfigureLoggers(Action<LoggerConfigBuilder>)
to configure how Akka.NET logger behave.
Example:
builder.Services.AddAkka("MyActorSystem", configurationBuilder =>
{
configurationBuilder
.ConfigureLoggers(setup =>
{
// Example: This sets the minimum log level
setup.LogLevel = LogLevel.DebugLevel;
// Example: Clear all loggers
setup.ClearLoggers();
// Example: Add the default logger
// NOTE: You can also use setup.AddLogger<DefaultLogger>();
setup.AddDefaultLogger();
// Example: Add the ILoggerFactory logger
// NOTE:
// - You can also use setup.AddLogger<LoggerFactoryLogger>();
// - To use a specific ILoggerFactory instance, you can use setup.AddLoggerFactory(myILoggerFactory);
setup.AddLoggerFactory();
// Example: Adding a serilog logger
setup.AddLogger<SerilogLogger>();
})
.WithActors((system, registry) =>
{
var echo = system.ActorOf(act =>
{
act.ReceiveAny((o, context) =>
{
Logging.GetLogger(context.System, "echo").Info($"Actor received {o}");
context.Sender.Tell($"{context.Self} rcv {o}");
});
}, "echo");
registry.TryRegister<Echo>(echo); // register for DI
});
});
A complete code sample can be viewed here.
Exposed properties are:
LogLevel
: Configure the Akka.NET minimum log level filter, defaults toInfoLevel
LogConfigOnStart
: When set to true, Akka.NET will log the complete HOCON settings it is using at start up, this can then be used for debugging purposes.
Currently supported logger methods:
ClearLoggers()
: Clear all registered logger types.AddLogger<TLogger>()
: Add a logger type by providing its class type.AddDefaultLogger()
: Add the default Akka.NET console logger.AddLoggerFactory()
: Add the newILoggerFactory
logger.
Microsoft.Extensions.Logging.ILoggerFactory Logging Support
You can now use ILoggerFactory
from Microsoft.Extensions.Logging as one of the sinks for Akka.NET logger. This logger will use the ILoggerFactory
service set up inside the dependency injection ServiceProvider
as its sink.
Microsoft.Extensions.Logging Log Event Filtering
There will be two log event filters acting on the final log input, the Akka.NET akka.loglevel
setting and the Microsoft.Extensions.Logging
settings, make sure that both are set correctly or some log messages will be missing.
To set up the Microsoft.Extensions.Logging
log filtering, you will need to edit the appsettings.json
file. Note that we also set the Akka
namespace to be filtered at debug level in the example below.
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information",
"Akka": "Debug"
}
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. |
-
.NETStandard 2.0
- Akka.DependencyInjection (>= 1.4.46)
- Microsoft.Extensions.Hosting (>= 3.0.0)
NuGet packages (24)
Showing the top 5 NuGet packages that depend on Akka.Hosting:
Package | Downloads |
---|---|
Petabridge.Cmd.Host
Host engine for the Petabridge.Cmd CLI for managing Akka.NET apps and clusters. Used to load available commands into the cluster itself. |
|
Akka.Persistence.Hosting
Akka.Persistence Microsoft.Extensions.Hosting support. |
|
Akka.Remote.Hosting
Akka.Remote Microsoft.Extensions.Hosting support. |
|
Akka.Management
Akka cluster management module for Akka.NET |
|
Akka.HealthCheck.Hosting
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Akka.Hosting:
Repository | Stars |
---|---|
petabridge/akkadotnet-code-samples
Akka.NET professional reference code samples
|
Version | Downloads | Last updated |
---|---|---|
1.5.32 | 6,060 | 12/5/2024 |
1.5.31.1 | 10,473 | 11/15/2024 |
1.5.31 | 12,313 | 11/11/2024 |
1.5.30.1 | 12,841 | 10/18/2024 |
1.5.30 | 18,098 | 10/3/2024 |
1.5.29 | 7,140 | 10/1/2024 |
1.5.28 | 29,338 | 9/4/2024 |
1.5.27 | 51,205 | 7/29/2024 |
1.5.25 | 98,687 | 6/17/2024 |
1.5.24 | 12,380 | 6/10/2024 |
1.5.22 | 5,876 | 6/4/2024 |
1.5.20 | 27,233 | 4/30/2024 |
1.5.19 | 31,957 | 4/17/2024 |
1.5.18 | 47,183 | 3/14/2024 |
1.5.17.1 | 13,525 | 3/4/2024 |
1.5.16 | 11,771 | 2/23/2024 |
1.5.15 | 88,540 | 1/10/2024 |
1.5.14 | 4,935 | 1/9/2024 |
1.5.13 | 79,039 | 9/27/2023 |
1.5.12.1 | 53,116 | 8/31/2023 |
1.5.12 | 24,813 | 8/3/2023 |
1.5.8.1 | 82,958 | 7/12/2023 |
1.5.8 | 50,623 | 6/21/2023 |
1.5.7 | 52,057 | 5/23/2023 |
1.5.6.1 | 3,964 | 5/17/2023 |
1.5.6 | 7,270 | 5/10/2023 |
1.5.5 | 26,590 | 5/4/2023 |
1.5.4.1 | 5,992 | 5/1/2023 |
1.5.4 | 5,353 | 4/25/2023 |
1.5.3 | 1,487 | 4/25/2023 |
1.5.2 | 21,036 | 4/6/2023 |
1.5.1.1 | 2,034 | 4/4/2023 |
1.5.1 | 23,585 | 3/16/2023 |
1.5.0 | 31,413 | 3/2/2023 |
1.5.0-beta6 | 826 | 3/1/2023 |
1.5.0-beta4 | 458 | 3/1/2023 |
1.5.0-beta3 | 744 | 2/28/2023 |
1.5.0-alpha4 | 765 | 2/17/2023 |
1.0.3 | 13,928 | 2/8/2023 |
1.0.2 | 3,797 | 1/31/2023 |
1.0.1 | 32,331 | 1/6/2023 |
1.0.0 | 5,257 | 12/28/2022 |
0.5.2-beta1 | 3,515 | 11/28/2022 |
0.5.1 | 25,702 | 10/20/2022 |
0.5.0 | 25,854 | 10/4/2022 |
0.4.3 | 24,527 | 9/10/2022 |
0.4.2 | 20,329 | 8/12/2022 |
0.4.1 | 8,393 | 7/21/2022 |
0.4.0 | 4,152 | 7/18/2022 |
0.3.4 | 5,630 | 6/23/2022 |
0.3.3 | 3,130 | 6/16/2022 |
0.3.2 | 2,611 | 6/13/2022 |
0.3.1 | 55,415 | 6/9/2022 |
0.3.0 | 87,752 | 5/24/2022 |
0.2.2 | 9,286 | 4/10/2022 |
0.2.1 | 2,775 | 4/9/2022 |
0.2.0 | 2,620 | 4/9/2022 |
0.1.5 | 2,745 | 4/6/2022 |
0.1.4 | 2,653 | 4/2/2022 |
0.1.3 | 2,303 | 4/1/2022 |
0.1.2 | 2,252 | 3/31/2022 |
0.1.1 | 2,510 | 3/18/2022 |
0.1.0 | 7,148 | 3/10/2022 |
• [Update Akka.NET from 1.4.45 to 1.4.46](https://github.com/akkadotnet/akka.net/releases/tag/1.4.46)
• [Remove default HoconAddMode value from AddHocon and AddHoconFile](https://github.com/akkadotnet/Akka.Hosting/pull/135)
• [First release of Akka.Hosting.TestKit NuGet package](https://github.com/akkadotnet/Akka.Hosting/pull/143)
Full changelog at https://github.com/akkadotnet/Akka.Hosting/blob/refs/tags/0.5.2-beta1/RELEASE_NOTES.md