Skip to content

Fix Orleans custom grain storage docs: replace removed AddSingletonNamedService with AddKeyedSingleton #52135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix Orleans custom grain storage docs: replace removed AddSingletonNamedService with AddKeyedSingleton #52135

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1e111f
Initial plan
Copilot Mar 10, 2026
5fafb9f
Fix custom grain storage docs: replace AddSingletonNamedService with …
Copilot Mar 10, 2026
6652a95
Apply suggestions from code review
meaghanlewis Mar 10, 2026
f27aef4
Fix broken xref: use ServiceCollectionServiceExtensions.AddKeyedSingl…
Copilot Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions docs/orleans/tutorials-and-samples/custom-grain-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Custom grain storage sample project
description: Explore a custom grain storage sample project written with .NET Orleans.
ms.date: 03/30/2025
ms.date: 03/10/2026
ms.topic: tutorial
zone_pivot_groups: orleans-version
ai-usage: ai-assisted
---

# Custom grain storage
Expand Down Expand Up @@ -133,17 +134,11 @@ Next, create a factory that allows scoping the options to the provider name whil

:::code source="snippets/custom-grain-storage/FileGrainStorageFactory.cs":::

Lastly, to register the grain storage, create an extension on <xref:Orleans.Hosting.ISiloBuilder>. This extension internally registers the grain storage as a named service using <xref:Orleans.Runtime.KeyedServiceExtensions.AddSingletonNamedService%2A>, an extension provided by `Orleans.Core`.
Lastly, to register the grain storage, create an extension on <xref:Orleans.Hosting.ISiloBuilder>. This extension registers the grain storage as a keyed singleton using <xref:Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddKeyedSingleton%2A?displayProperty=nameWithType>, the standard .NET 8+ keyed DI API.

:::code source="snippets/custom-grain-storage/FileSiloBuilderExtensions.cs":::

The `FileGrainStorage` implements two interfaces, <xref:Orleans.Storage.IGrainStorage> and `ILifecycleParticipant<ISiloLifecycle>`. Therefore, register two named services, one for each interface:

```csharp
return services.AddSingletonNamedService(providerName, FileGrainStorageFactory.Create)
.AddSingletonNamedService(providerName,
(p, n) => (ILifecycleParticipant<ISiloLifecycle>)p.GetRequiredServiceByName<IGrainStorage>(n));
```
The `FileGrainStorage` implements two interfaces, <xref:Orleans.Storage.IGrainStorage> and `ILifecycleParticipant<ISiloLifecycle>`. Therefore, register two keyed singleton services, one for each interface.

This enables adding the file storage using the extension on <xref:Orleans.Hosting.ISiloBuilder>:

Expand Down