Skip to content

Latest commit

 

History

History
162 lines (111 loc) · 6.21 KB

stackexchange-redis-distributed-caching-component.md

File metadata and controls

162 lines (111 loc) · 6.21 KB
Raw
title description ms.topic ms.date
.NET Aspire StackExchange Redis distributed caching component
This article describes the .NET Aspire StackExchange Redis distributed caching component features and capabilities
how-to
12/12/2023

.NET Aspire StackExchange Redis distributed caching component

In this article, you learn how to use the .NET Aspire StackExchange Redis distributed caching component. The Aspire.StackExchange.Redis.DistributedCaching library is used to register an [IDistributedCache]https://stackexchange.github.io/StackExchange.Redis/Basics) provider for connecting to Redis server. It enables corresponding health checks, logging and telemetry.

Get started

To get started with the .NET Aspire StackExchange Redis distributed caching component, install the Aspire.StackExchange.Redis.DistributedCaching NuGet package.

.NET CLI

dotnet add package Aspire.StackExchange.Redis.DistributedCaching --prerelease

PackageReference

<PackageReference Include="Aspire.StackExchange.Redis.DistributedCaching"
                  Version="[SelectVersion]" />

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Example usage

In the Program.cs file of your project, call the xref:Microsoft.Extensions.Hosting.AspireRedisDistributedCacheExtensions.AddRedisDistributedCache%2A extension to register the required services for distributed caching and add a xref:Microsoft.Extensions.Caching.Distributed.IDistributedCache for use via the dependency injection container.

builder.AddRedisDistributedCache("cache");

You can then retrieve the IDistributedCache instance using dependency injection. For example, to retrieve the cache from a service:

public class ExampleService(IDistributedCache cache)
{
    // Use cache...
}

Configuration

The .NET Aspire StackExchange Redis distributed caching component provides multiple options to configure the Redis connection based on the requirements and conventions of your project.

Use a connection string

When using a connection string from the ConnectionStrings configuration section, you can provide the name of the connection string when calling builder.AddRedisDistributedCache:

builder.AddRedisDistributedCache("RedisConnection");

And then the connection string will be retrieved from the ConnectionStrings configuration section:

{
  "ConnectionStrings": {
    "RedisConnection": "localhost:6379"
  }
}

For more information on how to format this connection string, see the StackExchange Redis configuration docs.

Use configuration providers

The .NET Aspire StackExchange Redis distributed caching component supports xref:Microsoft.Extensions.Configuration?displayProperty=fullName. It loads the xref:Aspire.StackExchange.Redis.StackExchangeRedisSettings from configuration by using the Aspire:StackExchange:Redis key. Example appsettings.json that configures some of the options:

{
  "Aspire": {
    "StackExchange": {
      "Redis": {
        "ConfigurationOptions": {
          "ConnectTimeout": 3000,
          "ConnectRetry": 2
        },
        "HealthChecks": false,
        "Tracing": true
      }
    }
  }
}

Use inline delegates

You can also pass the Action<StackExchangeRedisSettings> delegate to set up some or all the options inline, for example to configure Tracing:

builder.AddRedisDistributedCache(
    "cache",
    settings => settings.Tracing = false);

You can also set up the ConfigurationOptions using the Action<ConfigurationOptions> configureOptions delegate parameter of the AddRedisDistributedCache method. For example to set the connection timeout:

builder.AddRedisDistributedCache(
    "cache",
    configureOptions: options => options.ConnectTimeout = 3000);

Orchestration

In your orchestrator project, register the .NET Aspire Stack Exchange Redis component and consume the service using the following methods, such as xref:Aspire.Hosting.RedisBuilderExtensions.AddRedis%2A:

// Service registration
var redis = builder.AddRedis("redis");

// Service consumption
builder.AddProject<Projects.ExampleProject>()
       .WithReference(redis)

The xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A method configures a connection in the ExampleProject project named redis. In the Program.cs file of ExampleProject, the Redis connection can be consumed using:

builder.AddRedisDistributedCache("cache");

[!INCLUDE component-health-checks]

The .NET Aspire StackExchange Redis distributed caching component handles the following:

  • Adds the StackExchange.Redis health check, tries to open the connection and throws when it fails.
  • Integrates with the /health HTTP endpoint, which specifies all registered health checks must pass for app to be considered ready to accept traffic

[!INCLUDE component-observability-and-telemetry]

Logging

The .NET Aspire StackExchange Redis Distributed Caching component uses the following Log categories:

  • Aspire.StackExchange.Redis
  • Microsoft.Extensions.Caching.StackExchangeRedis

Tracing

The .NET Aspire StackExchange Redis Distributed Caching component will emit the following Tracing activities using OpenTelemetry:

  • "OpenTelemetry.Instrumentation.StackExchangeRedis"

Metrics

The .NET Aspire StackExchange Redis Distributed Caching component currently doesn't support metrics by default due to limitations with the StackExchange.Redis library.

See also