MethodCache.AspNetCore 1.0.0-rc.15

This is a prerelease version of MethodCache.AspNetCore.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package MethodCache.AspNetCore --version 1.0.0-rc.15
                    
NuGet\Install-Package MethodCache.AspNetCore -Version 1.0.0-rc.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="MethodCache.AspNetCore" Version="1.0.0-rc.15" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MethodCache.AspNetCore" Version="1.0.0-rc.15" />
                    
Directory.Packages.props
<PackageReference Include="MethodCache.AspNetCore" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MethodCache.AspNetCore --version 1.0.0-rc.15
                    
#r "nuget: MethodCache.AspNetCore, 1.0.0-rc.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.
#:package MethodCache.AspNetCore@1.0.0-rc.15
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MethodCache.AspNetCore&version=1.0.0-rc.15&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=MethodCache.AspNetCore&version=1.0.0-rc.15&prerelease
                    
Install as a Cake Tool

MethodCache.AspNetCore

Admin endpoints and a health check for MethodCache's in-memory cache.

Install it at the same version as MethodCache.

Setup

builder.Services.AddScoped<IUserService, UserService>();
builder.Services.AddMethodCache();
builder.Services.AddHealthChecks().AddMethodCache();
builder.Services.AddAuthorization(o => o.AddPolicy("CacheAdmins", p => p.RequireRole("Admin")));

var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();

app.MapMethodCacheAdmin("CacheAdmins");
app.MapHealthChecks("/health");

The authorization policy is required, because the endpoints expose cache keys and can empty the cache; a signed-in user without the policy gets 403.

Endpoints

All paths are relative to the prefix, /methodcache by default. MapMethodCacheAdmin("CacheAdmins", "/ops/cache") maps them under /ops/cache instead.

Method Path What it does
GET stats This instance's hits, misses, evictions, method and HTTP entries, HTTP bytes and memory weight
GET methods Every cached method: its methodId, effective policy and where each setting comes from
GET entries?storedKeyPrefix=&tag=&methodId=&limit= Live entries in the memory of the instance that answers, each with its storedKey and methodId, ordered by storedKey (default limit 100, max 1000). methodId must be an id that methods lists. Values are not returned
GET entry?storedKey= One entry, by the storedKey that entries lists, in the memory of the instance that answers, or 404
DELETE entry?storedKey= Removes one entry, also from Redis, SQL Server or PostgreSQL and the other instances when configured. 404 only without a distributed cache, when the key isn't in memory
POST invalidate Removes entries by tag. Body: { "tags": ["users"] }
POST invalidate-method Removes every entry of one cached method, also from the distributed cache and the other instances. Body: { "methodId": "[MyApp]MyApp.IUserService.GetUserAsync" }, an id that methods lists
POST clear Removes every entry. Body: {}

The POST endpoints take a JSON body, also clear, whose body is {}:

curl -X POST https://localhost:5001/methodcache/clear -H "Content-Type: application/json" -d "{}"

That is on purpose: a browser sends a JSON request to another site only after a CORS preflight, so a page on another site can't make a signed-in admin's browser empty the cache. A request without a JSON body is answered with 415 or 400.

Answers other than 200, 204 and 404:

  • 400, and nothing changes: a query parameter the endpoint doesn't take, a missing or empty storedKey or methodId, a methodId that no cached method has, a limit out of range, an empty tag list, or a body with a property the endpoint doesn't take (invalidate takes only tags, invalidate-method only methodId, clear none). A POST without a body is 400 too.
  • 415: a POST whose body isn't application/json.
  • 503: the removal is done in this instance's memory but the distributed cache hasn't confirmed it yet. The cache retries on its own; don't repeat the call.
  • 401 and 403: the caller isn't signed in, or doesn't satisfy the policy.

Audit

Pass audit to record who changes the cache. It runs for DELETE entry, invalidate, invalidate-method and clear, after authorization and validation and before the change:

var audit = app.Services.GetRequiredService<ILoggerFactory>().CreateLogger("CacheAdminAudit");
app.MapMethodCacheAdmin("CacheAdmins", audit: (action, cancellationToken) =>
{
    audit.LogInformation("{User} ran {Action} on {Targets} at {Time}",
        action.User.Identity?.Name, action.Kind, action.Targets, action.Time);
    return ValueTask.CompletedTask;
});

MethodCacheAdminAction has:

Property Value
Kind RemoveEntry, InvalidateTags, InvalidateMethod or Clear
Targets The stored key, the tags or the method id; empty for Clear
User The signed-in user, HttpContext.User
Time When the request arrived, from the app's TimeProvider
HttpContext The request, for anything else you record, such as the client's address or the trace id

When the function throws, the request fails and nothing changes, so no change goes unrecorded. Reads and rejected requests (400, 401, 403, 415) aren't passed to it. A change answered with 503 is recorded, since it has removed the entries from this instance's memory. Write the record somewhere the admins can't edit, such as your log pipeline or an append-only table.

The same operations are available in code through ICacheAdministrator in the MethodCache namespace (see Monitoring).

Health check

AddMethodCache() on the health checks builder reports:

Key Value
managerCapability built_in, noop or custom (your own ICacheManager)
statisticsAvailable Whether the statistics below are reported
methodStatisticsAvailable Whether method statistics are reported: only for the built-in manager
httpCapability not_configured, local or distributed: whether AddHttpCaching is registered, and where it stores responses
localMethodEntries, totalWeight, evictions Built-in manager only. Weight uses the configured weigher's units, or one per method entry
localHttpEntries, localHttpBytes, observedDistributedEntries When statistics are available
queued, publicationQueued Invalidations waiting for the distributed cache, and for the backplane
backplaneStatus not_configured, connecting, connected, disconnected or unknown
distributedCacheAvailable Whether the distributed cache answers; only when one is configured
error.type Only when the check itself failed: the exception type

The check reports the registration's failureStatus (default Degraded) when the distributed cache doesn't answer, invalidations are waiting to be retried, or the backplane is connecting or disconnected. The distributed cache and the backplane are reported separately. The check waits at most OperationTimeout, and reports exception types, never exception messages.

Limits

  • Works with the default in-memory cache manager. With your own ICacheManager, the endpoints need the ICacheAdministrator that AddHttpCaching registers, and it covers HTTP responses only: methods is empty, clear removes HTTP responses only, and invalidate-method answers 400.
  • Policies are read-only here. Change them at runtime with IRuntimeCacheConfigurator.
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-rc.20 58 11/12/2026
1.0.0-rc.19 60 11/10/2026
1.0.0-rc.18 61 11/10/2026
1.0.0-rc.17 52 11/10/2026
1.0.0-rc.16 55 11/8/2026
1.0.0-rc.15 58 11/8/2026
1.0.0-rc.14 53 11/8/2026
1.0.0-rc.13 66 11/7/2026
1.0.0-rc.12 53 11/7/2026
1.0.0-rc.11 58 11/7/2026
1.0.0-rc.10 61 11/6/2026
1.0.0-rc.9 58 11/5/2026
1.0.0-rc.8 64 11/5/2026
1.0.0-rc.7 63 11/5/2026
1.0.0-rc.6 60 11/5/2026
1.0.0-rc.5 67 11/4/2026
1.0.0-rc.4 59 11/4/2026
1.0.0-rc.3 55 11/4/2026
1.0.0-rc.2 74 10/20/2026
1.0.0-rc.1 69 10/19/2026