orleans

Cloud Native application framework for .NET

MIT License

Stars
10K
Committers
360
View Code on GitHub Visit Website View on X
Ecosystems: WPF, .NET, Blazor, C#, WinForms

Bot releases are visible (Hide)

orleans - v8.2.0 Latest Release

Published by ReubenBond 3 months ago

New features

Activation repartitioning

!Activation Repartitioning in action

Above: a demonstration showing Activation Repartitioning in action. The red lines represent cross-silo communication. As the red lines are eliminated by the partitioning algorithm, throughput improves to over 2x the initial throughput.

Ledjon Behluli and @ReubenBond implemented activation repartitioning in #8877. When enabled, activation repartitioning collocates grains based on observed communication patterns to improve performance while keeping load balanced across your cluster. In initial benchmarks, we observe throughput improvements in the range of 30% to 110%. The following paragraphs provide more background and implementation details for those who are interested. The feature is currently experimental and to enable it you need to opt-in on every silo in your cluster using the ISiloBuilder.AddActivationRepartitioner() extension method, suppressing the experimental feature warning:

#pragma warning disable ORLEANSEXP001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
siloBuilder.AddActivationRepartitioner();
#pragma warning restore ORLEANSEXP001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.

The fastest and cheapest grains calls are ones which don't cross process boundaries. These grain calls do not need to be serialized and do not need to incur network transmission costs. For that reason, collocating related grains within the same host can significantly improve the performance of your application. On the other hand, if all grains were placed in a single host, that host may become overloaded and crash, and you would not be able to scale your application across multiple hosts. How can we maximize collocation of related grains while keeping load across your hosts balanced? Before describing our solution, we need to provide some background.

Grain placement in Orleans is flexible: Orleans executes a user-defined function when deciding where in a cluster to place each grain, providing your function with a list of the compatible silos in your cluster, that is, the silos which support the grain type and interface version which triggered placement. Grains calls are location-transparent, so callers do not need to know where a grain is located, allowing grains to be placed anywhere across your cluster of hosts. Each grain's current location is stored in a distributed directory and lookups to the directory are cached for performance.

Resource-optimized placement was implemented by @ledjon-behluli in #8815. Resource-optimized placement uses runtime statistics such as total and available memory, CPU usage, and grain count, collected from all hosts in the cluster, smooths them, and combines them to calculate a load score. It selects the least-loaded silo from a subset of hosts to balance load evenly across the cluster[^4]. If the load score of the local silo is within some configured range of the best candidate's load score, the local silo is chosen preferentially. This improves grain locality by leveraging the knowledge that the local silo initiated a call to the grain and therefore has some relation to that grain.
Ledjon wrote more about Resource-optimized placement in this blog post.

Originally, there was no straightforward way to move an active grain from one host to another without needing to fully deactivate the grain, unregister it from the grain directory, contend with concurrent callers on where to place the new activation, and reload its state from the database when the new activation is created. Live grain migration was introduced in #8452, allowing grains to transparently migrate from one silo to another on-demand without needing to reload state from the database, and without affecting pending requests. Live grain migration introduced two new lifecycle stages: dehydration and rehydration. The grain's in-memory state (application state, enqueued messages, metadata) is dehydrated into a migration packet which is sent to the destination silo where it's rehydrated. Live grain migration provided the mechanism for grains to migrate across hosts, but did not provide any out-of-the-box policies to automate migration. Users trigger grain migration by calling this.MigrateOnIdle() from within a grain, optionally providing a placement hint which the grain's configured placement director can use to select a destination host for the grain activation.

Finally, we have the pieces in place for activation repartitioning: grain activations are load-balanced across the cluster, and they are able to migrate from host to host quickly. While live grain migration gives developers a mechanism to migrate grain activations from one host to another, it does not provide any automated policy to do so. Remember, we want grains to be balanced across the cluster and collocated with related grains to reduce networking and serialization cost. This is a difficult challenge since:

  • An application can have millions of in-memory grains spread across tens or hundreds of silos.
  • Each grain can message any other grain.
  • The set of grains which each grain communicates with can change from minute to minute. For example, in an online game, player grains may join one match and communicate with each other for some time and then join a different match with an entirely different set of players afterwards.
  • Computing the minimum edge-cut for an arbitrary graph is NP-hard.
  • No single host has full knowledge of which grains are hosted on which other host and which grains they communicate with: the graph is distributed across the cluster and changes dynamically.
  • Storing the entire communication graph in memory could be prohibitively expensive.

Folks at Microsoft Research studied this problem and proposed a solution in a paper titled Optimizing Distributed Actor Systems for Dynamic Interactive Services. The paper, dubbed ActOp, proposes a decentralized approximate solution which achieves good results in their benchmarks. Their implementation was never merged into Orleans and we were unable to find the original implementation on Microsoft's internal network. So, after first implementing resource-optimized placement, community contributor @ledjon-behluli set out to implement activation repartitioning from scratch based on the ActOp paper. The following paragraphs describe the algorithm and the enhancements we made along the way.

The activation repartitioning algorithm involves pair-wise exchange of grains between two hosts at a time. Silos compute a candidate set of grains to send to a peer, then the peer does similarly, and uses a greedy algorithm to determine a final exchange set which minimizes cost while keeping silos balanced.

To compute the candidate sets, silos track which grains communicate with which other grains and how frequently. The whole graph would be unwieldy, so we only maintain the top-K communication edges using a variant of the Space-Saving[^1] algorithm. Messages are sampled via a multi-producer, single consumer ring buffer which drops messages if the partition is full. They are then processed by a single thread, which yields frequently to give other threads CPU time. When the distribution has low skew and the K parameter is fairly small, Space-Saving can require a lot of costly shuffling at the bottom of its max-heap (we use the heap variant to reduce memory). To address this, we use Filtered Space-Saving[^2] instead of Space-Saving. Filtered Space-Saving involves putting a 'sketch' data structure at the bottom of the max heap for the lower end of the distribution, which can greatly reduce churn at the bottom and improve performance by up to ~2x in our tests.

If the top-K communication edges are all internal (eg, because the algorithm has already optimized partitioning somewhat), silos won't find many good transfer candidates. We need to track internal edges to work out which grains should/shouldn't be transferred (cost vs benefit). To address this, we introduced a bloom filter to track grains where the cost of movement is greater than the benefit, removing them from the top-K data structure. From our experiments, this works very well with even a 10x smaller K. This performance improvement will come with a reduced ability to handle dynamic graphs, so in the future we may need to implement a decay strategy to address this as the bloom filter becomes saturated. To improve lookup performance, @ledjon-behluli implemented a blocked bloom filter[^3], which is used instead of a classic bloom filter.

[^1]: Efficient Computation of Frequent and Top-k Elements in Data Streams by Metwally, Agrawal, and Abbadi
[^2]: Finding top-k elements in data streams by Nuno Homem & Joao Paulo Carvalho
[^3]: Cache-, Hash- and Space-Efficient Bloom Filters by Felix Putze, Peter Sanders and Johannes Single
[^4]: The Power of Two Choices in Randomized Load Balancing by Michael David Mitzenmacher

Enhancements to grain timers

Orleans v8.2.0 introduces a new API, RegisterGrainTimer, for managing grain timers. For compatibility, the existing RegisterTimer API is still available, but it is marked [Obsolete] and developers should migrate to the new grain timer API, RegisterGrainTimer.

Grain timers have been a common source of confusion for new and experienced developers because grain timer callbacks can execute concurrently with other grain calls, rather than being executed one-by-one like grain calls are. That is, timer callbacks are interleaving. With v8.2.0, this issue can be avoided by using the new RegisterGrainTimer API. The new API has the following advantages:

  • Grain timers can be updated using the Change(TimeSpan, TimeSpan) method on the returned IGrainTimer instance.
  • Callbacks do not interleave by default. Interleaving can be enabled by setting Interleave to true on GrainTimerCreationOptions.
  • Callbacks can keep the grain active, preventing it from being collected if the timer period is relatively short. This can be enabled by setting KeepAlive to true on GrainTimerCreationOptions.
  • Callbacks can receive a CancellationToken which is canceled when the timer is disposed or the grain starts to deactivate.
  • Callbacks can dispose the grain timer which fired them.
  • Callbacks are now subject to grain call filters.
  • Callbacks are visible in distributed tracing, when distributed tracing is enabled.
  • POCO grains (grain classes which do not inherit from Grain) can register grain timers using the RegisterGrainTimer extension method.

The core API is as-follows:

public static IGrainTimer RegisterGrainTimer<TState>(this IGrainBase grain, Func<TState, CancellationToken, Task> callback, TState state, GrainTimerCreationOptions options);

There are various overloads for convenience:

public static IGrainTimer RegisterGrainTimer<TState>(this IGrainBase grain, Func<TState, CancellationToken, Task> callback, TState state, GrainTimerCreationOptions options);
public static IGrainTimer RegisterGrainTimer(this IGrainBase grain, Func<CancellationToken, Task> callback, GrainTimerCreationOptions options);
public static IGrainTimer RegisterGrainTimer(this IGrainBase grain, Func<Task> callback, GrainTimerCreationOptions options);
public static IGrainTimer RegisterGrainTimer<TState>(this IGrainBase grain, Func<TState, Task> callback, TState state, GrainTimerCreationOptions options);
public static IGrainTimer RegisterGrainTimer(this IGrainBase grain, Func<Task> callback, TimeSpan dueTime, TimeSpan period);
public static IGrainTimer RegisterGrainTimer(this IGrainBase grain, Func<CancellationToken, Task> callback, TimeSpan dueTime, TimeSpan period);
public static IGrainTimer RegisterGrainTimer<TState>(this IGrainBase grain, Func<TState, Task> callback, TState state, TimeSpan dueTime, TimeSpan period);
public static IGrainTimer RegisterGrainTimer<TState>(this IGrainBase grain, Func<TState, CancellationToken, Task> callback, TState state, TimeSpan dueTime, TimeSpan period);

The RegisterGrainTimer API returns instances of IGrainTimer instead of IDisposable:

/// <summary>
/// Represents a timer belonging to a grain.
/// </summary>
public interface IGrainTimer : IDisposable
{
    /// <summary>Changes the start time and the interval between method invocations for a timer, using <see cref="TimeSpan"/> values to measure time intervals.</summary>
    /// <param name="dueTime">
    /// A <see cref="TimeSpan"/> representing the amount of time to delay before invoking the callback method specified when the <see cref="IGrainTimer"/> was constructed.
    /// Specify <see cref="Timeout.InfiniteTimeSpan"/> to prevent the timer from restarting.
    /// Specify <see cref="TimeSpan.Zero"/> to restart the timer immediately.
    /// </param>
    /// <param name="period">
    /// The time interval between invocations of the callback method specified when the timer was constructed.
    /// Specify <see cref="Timeout.InfiniteTimeSpan"/> to disable periodic signaling.
    /// </param>
    /// <exception cref="ArgumentOutOfRangeException">The <paramref name="dueTime"/> or <paramref name="period"/> parameter, in milliseconds, is less than -1 or greater than 4294967294.</exception>
    void Change(TimeSpan dueTime, TimeSpan period);
}

MessagePack serialization support

@n-sidorov implemented support for serializing messages using MessagePack.

To use MessagePack for message serialization, you will need to install Microsoft.Orleans.Serialization.MessagePack by inserting the following into your project files:

<ItemGroup>
  <PackageReference Include="Microsoft.Orleans.Serialization.MessagePack" Version="8.2.0" />
</ItemGroup>

Enable MessagePack serialization by calling ISerializerBuilder.AddMessagePackSerializer() on your clients and silos:

builder.AddSerializer(serializer => serializer.AddMessagePackSerializer());

Upon doing so, Orleans will be able to serialize types with the [MessagePackObject] attribute, for example:

[MessagePackObject]
public sealed record MyMessagePackClass
{
    [Key(0)]
    public int IntProperty { get; init; }

    [Key(1)]
    public string StringProperty { get; init; }

    [Key(2)]
    public MyMessagePackSubClass SubClass { get; init; }
}

Cassandra clustering provider

@rkargMsft implemented support for using Cassandra as a backing store for clustering in https://github.com/dotnet/orleans/pull/8925.

To use Cassandra for clustering, you will need to install Microsoft.Orleans.Clustering.Cassandra by inserting the following into your project files:

<ItemGroup>
  <PackageReference Include="Microsoft.Orleans.Clustering.Cassandra" Version="8.2.0" />
</ItemGroup>

On your clients and silos, you can enable Cassandra clustering by calling:

builder.UseCassandraClustering(connectionString);

ADO.NET Streaming Provider (alpha)

@JorgeCandeias implemented an ADO.NET streams provider in https://github.com/dotnet/orleans/pull/8974.

ADO.NET streaming is currently an alpha version. You can add it to your project files like so:

<ItemGroup>
  <PackageReference Include="Microsoft.Orleans.Streaming.AdoNet" Version="8.2.0-alpha.1" />
</ItemGroup>

Configure ADO.NET streaming like so:

builder.AddAdoNetStreams("provider name", options =>
{
    options.Invariant = "ADO.NET invariant name";
    options.ConnectionString = "Connection string";
});

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.1.0...v8.2.0

orleans - v8.2.0-preview1

Published by ReubenBond 5 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.1.0...v8.2.0-preview1

orleans - v3.7.2

Published by ReubenBond 5 months ago

What's Changed

Full Changelog: https://github.com/dotnet/orleans/compare/v3.7.1...v3.7.2

orleans - v8.1.0

Published by ReubenBond 6 months ago

New features

Integration with Aspire

This release includes initial integration with .NET Aspire, allowing you to configure an Orleans cluster in your Aspire app host, specifying the resources the cluster uses. For example, you can specify that an Azure Table will be used for cluster membership, an Azure Redis resource will be used for the grain directory, and an Azure Blob Storage resource will be used to store grain state. The integration currently supports Redis and Azure Table & Blob storage resources. Support for other resources will be added later.

In the app host project, an Orleans cluster can be declared using the AddOrleans method, and then configured with clustering, grain storage, grain directory, and other providers using methods on the returned builder:

var storage = builder.AddAzureStorage("storage");
var clusteringTable = storage.AddTables("clustering");
var defaultStorage = storage.AddBlobs("grainstate");
var cartStorage = builder.AddRedis("redis-cart");

var orleans = builder.AddOrleans("my-app")
                     .WithClustering(clusteringTable)
                     .WithGrainStorage("Default", grainStorage)
                     .WithGrainStorage("cart", cartStorage);

// Add a server project (also called "silo")
builder.AddProject<Projects.OrleansServer>("silo")
       .WithReference(orleans);

// Add a project with a reference to the Orleans client
builder.AddProject<Projects.FrontEnd>("frontend")
       .WithReference(orleans);

In the client and server projects, add Orleans to the host builder as usual.

// For an Orleans server:
builder.UseOrleans();

// Or, for an Orleans client:
builder.UseOrleansClient();

Orleans will read configuration created by your Aspire app host project and configure the providers specified therein. To allow Orleans to access the configured resources, add them as keyed services using the corresponding Aspire component:

builder.AddKeyedAzureTableService("clustering");
builder.AddKeyedAzureBlobService("grainstate");
builder.AddKeyedRedis("redis-cart");

Resource-optimized placement

Resource-optimized placement, enabled via the [ResourceOptimizedPlacement] attribute on a grain class, balances grains across hosts based on available memory and CPU usage. For more details, see the PR: https://github.com/dotnet/orleans/pull/8815.

What's Changed

Since 8.1.0-preview3

Additional changes since 8.0.0

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.0.0...v8.1.0

orleans - v8.1.0-preview3

Published by ReubenBond 7 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.1.0-preview2...v8.1.0-preview3

orleans - v7.2.6

Published by ReubenBond 7 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.5...v7.2.6

orleans - v8.1.0-preview2

Published by ReubenBond 8 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.1.0-preview1...v8.1.0-preview2

orleans - v7.2.5

Published by ReubenBond 8 months ago

What's Changed

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.4...v7.2.5

orleans - v8.1.0-preview1

Published by ReubenBond 8 months ago

New features

Integration with Aspire

This release includes initial integration with Aspire Preview 3 and later, allowing you to configure an Orleans cluster in your Aspire app host, specifying the resources the cluster uses. For example, you can specify that an Azure Table will be used for cluster membership, an Azure Redis resource will be used for the grain directory, and an Azure Blob Storage resource will be used to store grain state. The integration currently support Redis and Azure Table & Blob storage resources. Support for other resources will be added later.

In the app host project, an Orleans cluster can be declared using the AddOrleans method, and then configured with clustering, grain storage, grain directory, and other providers using methods on the returned builder:

var storage = builder.AddAzureStorage("storage");
var clusteringTable = storage.AddTables("clustering");
var defaultStorage = storage.AddBlobs("grainstate");
var cartStorage = builder.AddRedis("redis-cart");

var orleans = builder.AddOrleans("my-app")
                     .WithClustering(clusteringTable)
                     .WithGrainStorage("Default", grainStorage)
                     .WithGrainStorage("cart", cartStorage);

// Add a server project (also called "silo")
builder.AddProject<Projects.OrleansServer>("silo")
       .WithReference(orleans);

// Add a project with a reference to the Orleans client
builder.AddProject<Projects.FrontEnd>("frontend")
       .WithReference(orleans);

In the client and server projects, add Orleans to the host builder as usual.

// For an Orleans server:
builder.UseOrleans();

// Or, for an Orleans client:
builder.UseOrleansClient();

Orleans will read configuration created by your Aspire app host project and configure the providers specified therein. To allow Orleans to access the configured resources, add them as keyed services using the corresponding Aspire component:

builder.AddKeyedAzureTableService("clustering");
builder.AddKeyedAzureBlobService("grainstate");
builder.AddKeyedRedis("redis-cart");

Resource-optimized placement

Resource-optimized placement, enabled via the [ResourceOptimizedPlacement] attribute on a grain class, balances grains across hosts based on available memory and CPU usage. For more details, see the PR: https://github.com/dotnet/orleans/pull/8815.

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.0.0...v8.1.0-preview1

orleans - v8.0.0

Published by ReubenBond 10 months ago

What's Changed Since v7.0.0

What's Changed Since v8.0.0-rc2

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.0.0...v8.0.0

orleans - v8.0.0-rc2

Published by ReubenBond 10 months ago

Changes from v8.0.0-rc1

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v8.0.0-rc1...v8.0.0-rc2

orleans - 8.0.0-rc1

Published by ReubenBond 11 months ago

Changes from 7.0.0

Changes from 7.2.4

Other changes have been backported to 7.x

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.0.0...v8.0.0-rc1

orleans - v7.2.4

Published by ReubenBond 11 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.3...v7.2.4

orleans - v7.2.3

Published by ReubenBond 12 months ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.2...v7.2.3

orleans - v7.2.2

Published by ReubenBond about 1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.1...v7.2.2

orleans - v7.2.1

Published by ReubenBond over 1 year ago

What's Changed

Full Changelog: https://github.com/dotnet/orleans/compare/v7.2.0...v7.2.1

orleans - v7.2.0

Published by ReubenBond over 1 year ago

Release Highlights

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.1.2...v7.2.0

orleans - v3.7.1

Published by ReubenBond over 1 year ago

This release fixes a reliability bug in Orleans.Transactions

What's Changed

Full Changelog: https://github.com/dotnet/orleans/compare/v3.7.0...v3.7.1

orleans - v7.1.2

Published by ReubenBond over 1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.1.1...v7.1.2

orleans - v7.1.1

Published by ReubenBond over 1 year ago

What's Changed

New Contributors

Full Changelog: https://github.com/dotnet/orleans/compare/v7.1.0...v7.1.1

Package Rankings
Top 3.87% on Proxy.golang.org
Badges
Extracted from project README
NuGet Follow on Twitter Discord Discord
Related Projects
runtime

.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.

24 Sep 2019 14,788
extensions

This repository contains a suite of libraries that provide facilities commonly needed when creati...

17 Feb 2015 2,592
infer

Infer.NET is a framework for running Bayesian inference in graphical models

14 Sep 2018 1,556
efcore

EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, u...

23 Jan 2014 13,548
csharp-notebooks

Get started learning C# with C# notebooks powered by .NET Interactive and VS Code.

27 Jul 2021 1,011
dotNext

Next generation API for .NET

14 Dec 2018 1,618
code-analysis

Run .NET code quality analysis and code style analysis shipping with the .NET SDK

05 Feb 2021 63
dotnet-console-games

Game examples implemented as .NET console applications primarily for providing education and insp...

14 Jan 2020 760
dotnet

.NET Community Toolkit is a collection of helpers and APIs that work for all .NET developers and ...

20 Oct 2021 2,988
winforms

Windows Forms is a .NET UI framework for building Windows desktop applications.

19 Oct 2018 4,198
aspnetcore

ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications ...

11 Mar 2014 35,340
aspire

An opinionated, cloud ready stack for building observable, production ready, distributed applicat...

25 Sep 2023 3,626
deployment-tools

This repo contains the code to build the .NET deployment tools and installers for all supported p...

17 Jun 2020 137
ai-samples

14 Feb 2024 270
runtimelab

This repo is for experimentation and exploring new ideas that may or may not make it into the mai...

01 May 2020 1,327