Hangfire.Redis.StackExchange 1.10.1-beta2

This is a prerelease version of Hangfire.Redis.StackExchange.
dotnet add package Hangfire.Redis.StackExchange --version 1.10.1-beta2                
NuGet\Install-Package Hangfire.Redis.StackExchange -Version 1.10.1-beta2                
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="Hangfire.Redis.StackExchange" Version="1.10.1-beta2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Hangfire.Redis.StackExchange --version 1.10.1-beta2                
#r "nuget: Hangfire.Redis.StackExchange, 1.10.1-beta2"                
#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.
// Install Hangfire.Redis.StackExchange as a Cake Addin
#addin nuget:?package=Hangfire.Redis.StackExchange&version=1.10.1-beta2&prerelease

// Install Hangfire.Redis.StackExchange as a Cake Tool
#tool nuget:?package=Hangfire.Redis.StackExchange&version=1.10.1-beta2&prerelease                

Hangfire.Redis.StackExchange

HangFire Redis storage based on HangFire.Redis but using lovely StackExchange.Redis client.

Build status Nuget Badge

Package Name NuGet.org
Hangfire.Redis.StackExchange Nuget Badge
Hangfire.Redis.StackExchange.StrongName Nuget Badge
Highlights
  • Support for Hangfire Batches (feature of Hangfire Pro)
  • Efficient use of Redis resources thanks to ConnectionMultiplexer
  • Support for Redis Prefix, allow multiple Hangfire Instances against a single Redis DB
  • Allow customization of Succeeded and Failed lists size

Despite the name, Hangfire.Redis.StackExchange.StrongName is not signed because Hangfire.Core is not yet signed.

Tutorial: Hangfire on Redis on ASP.NET Core MVC

Getting Started

To use Hangfire against Redis in an ASP.NET Core MVC projects, first you will need to install at least these two packages: Hangfire.AspNetCore and Hangfire.Redis.StackExchange.

In Startup.cs, these are the bare minimum codes that you will need to write for enabling Hangfire on Redis:

public class Startup
{
    public static ConnectionMultiplexer Redis;

    public Startup(IHostingEnvironment env)
    {
        // Other codes / configurations are omitted for brevity.
        Redis = ConnectionMultiplexer.Connect(Configuration.GetConnectionString("Redis"));
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddHangfire(configuration =>
        {
            configuration.UseRedisStorage(Redis);
        });
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        app.UseHangfireServer();
    }
}

Attention: If you are using Microsoft.Extensions.Caching.Redis package, you will need to use Hangfire.Redis.StackExchange.StrongName instead, because the former package requires StackExchange.Redis.StrongName instead of StackExchange.Redis!

Configurations

configuration.UseRedisStorage(...)

This method accepts two parameters:

  • The first parameter accepts either your Redis connection string or a ConnectionMultiplexer object. By recommendation of the official StackExchange.Redis documentation, it is actually recommended to create one ConnectionMultiplexer for multiple reuse.

  • The second parameter accepts RedisStorageOptions object. As of version 1.7.0, these are the properties you can set into the said object:

namespace Hangfire.Redis
{
    public class RedisStorageOptions
    {
        public const string DefaultPrefix = "{hangfire}:";

        public RedisStorageOptions();

        public TimeSpan InvisibilityTimeout { get; set; }
        public TimeSpan FetchTimeout { get; set; }
        public string Prefix { get; set; }
        public int Db { get; set; }
        public int SucceededListSize { get; set; }
        public int DeletedListSize { get; set; }
    }
}

It is highly recommended to set the Prefix property, to avoid overlap with other projects that targets the same Redis store!

app.UseHangfireServer(...)

This method accepts BackgroundJobServerOptions as the first parameter:

namespace Hangfire
{
    public class BackgroundJobServerOptions
    {
        public BackgroundJobServerOptions();

        public string ServerName { get; set; }
        public int WorkerCount { get; set; }
        public string[] Queues { get; set; }
        public TimeSpan ShutdownTimeout { get; set; }
        public TimeSpan SchedulePollingInterval { get; set; }
        public TimeSpan HeartbeatInterval { get; set; }
        public TimeSpan ServerTimeout { get; set; }
        public TimeSpan ServerCheckInterval { get; set; }
        public IJobFilterProvider FilterProvider { get; set; }
        public JobActivator Activator { get; set; }
    }
}

Of these options, several interval options may be manually set (to longer intervals) to reduce CPU load:

  • SchedulePollingInterval is by default set to 15 seconds.

  • HeartbeatInterval is by default set to 30 seconds.

  • ServerTimeout and ServerCheckInterval is by default set to 5 minutes.

Dashboard

Written below is a short snippet on how to implement Hangfire dashboard in ASP.NET Core MVC applications, with limited access to cookie-authenticated users of Administrator role. Read more in official documentation.

public class AdministratorHangfireDashboardAuthorizationFilter : IDashboardAuthorizationFilter
{
    public bool Authorize(DashboardContext context)
    {
        var user = context.GetHttpContext().User;
        return user.Identity.IsAuthenticated && user.IsInRole("Administrator");
    }
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    app.UseCookieAuthentication(...);

    // This middleware must be placed AFTER the authentication middlewares!
    app.UseHangfireDashboard(options: new DashboardOptions
    {
        Authorization = new[] { new AdministratorHangfireDashboardAuthorizationFilter() }
    });
}

Jobs via ASP.NET Core Dependency Injection Services

For cleaner and more managable application code, it is possible to define your jobs in a class that is registered via dependency injection.

public class MyHangfireJobs
{
    public async Task SendGetRequest()
    {
        var client = new HttpClient();
        await client.GetAsync("https://www.accelist.com");
    }
}
public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<MyHangfireJobs>();
}

Using this technique, the registered jobs service will be able to obtain other services as dependency via constructor parameters, such as Entity Framework Core DbContext; which enables the development of powerful jobs with relative ease.

Then later you can execute the jobs using generic expression:

BackgroundJob.Enqueue<MyHangfireJobs>(jobs => jobs.SendGetRequest());

BackgroundJob.Schedule<MyHangfireJobs>(jobs => jobs.SendGetRequest(), DateTimeOffset.UtcNow.AddDays(1));

RecurringJob.AddOrUpdate<MyHangfireJobs>("RecurringSendGetRequest", jobs => jobs.SendGetRequest(), Cron.Hourly());
Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (43)

Showing the top 5 NuGet packages that depend on Hangfire.Redis.StackExchange:

Package Downloads
PiratesCore

湖南医标通信息科技有限公司

EaCloud.Hangfire

EaCloud Hangfire 后台任务组件,封装基于 Hangfire 后台任务的服务端实现。

Bit.Server.Hangfire

Bit.Server.Hangfire

Bit.Hangfire

Bit.Hangfire

Miru.Redis

Package Description

GitHub repositories (8)

Showing the top 5 popular GitHub repositories that depend on Hangfire.Redis.StackExchange:

Repository Stars
collinbarrett/FilterLists
:shield: The independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.
CoreUnion/CoreShop
基于 Asp.Net Core 8.0、Uni-App开发,支持可视化布局的小程序商城系统,前后端分离,支持分布式部署,跨平台运行,拥有分销、代理、团购、拼团、秒杀、直播、优惠券、自定义表单等众多营销功能,拥有完整SKU、下单、售后、物流流程。支持一套代码编译发布微信小程序版、H5版、Android版、iOS版、支付宝小程序版、字节跳动小程序版、QQ小程序版等共10个平台。
trueai-org/module-shop
一个基于 .NET 8.0 构建的简单、跨平台、模块化的商城系统
q315523275/FamilyBucket
集合.net core、ocelot、consul、netty、rpc、eventbus、configserver、tracing、sqlsugar、vue-admin、基础管理平台等构建的微服务一条龙应用
volodymyrsmirnov/MalwareMultiScan
Self-hosted VirusTotal / MetaDefender wannabe with API, demo UI and Scanners running in Docker.
Version Downloads Last updated
1.10.1-beta2 6,605 6/18/2024
1.10.1-beta 62 6/18/2024
1.9.4-beta.1 3,148 1/16/2024
1.9.4-beta 19,379 7/21/2023
1.9.3 462,918 11/16/2023
1.9.3-beta 8,908 5/10/2023
1.9.2 47,051 10/26/2023
1.9.1-beta 5,801 10/7/2022
1.9.0 406,171 6/5/2023
1.9.0-beta 1,992 7/18/2022
1.8.7 248,723 3/8/2023
1.8.6 621,741 9/30/2022
1.8.5 1,076,680 10/17/2021
1.8.4 1,765,367 5/28/2020
1.8.3 152,972 5/6/2020
1.8.2 37,479 4/20/2020
1.8.1 204,942 1/9/2020
1.8.0 1,018,926 11/5/2018
1.7.2 176,874 1/4/2018
1.7.0 39,779 5/9/2017
1.6.7.24 32,903 2/16/2017
1.6.7.7 20,418 12/9/2016
1.6.7.5 2,529 11/30/2016
1.6.7.4 2,487 11/30/2016
1.6.7.3 3,162 11/18/2016
1.6.7.1 2,634 11/17/2016
1.6.6.42 2,502 11/17/2016
1.6.6.41 2,520 11/17/2016
1.6.6.39 2,537 11/17/2016
1.6.6.37 2,611 11/11/2016
1.6.6.36 2,945 11/8/2016
1.6.6.31 2,793 11/1/2016
1.6.6 2,508 11/17/2016
1.6.5.24 3,132 10/20/2016
1.5.4.126 3,904 10/5/2016
1.5.4.116 5,080 4/19/2016
1.5.3 2,774 3/16/2016
1.5.3-rc 2,445 1/4/2016
1.4.8 5,196 1/6/2016
1.4.7 3,518 9/1/2015
1.4.6 3,616 8/11/2015
1.4.5 2,619 8/5/2015
1.4.2 2,665 5/27/2015
1.4.1.3 3,759 4/22/2015
1.4.1.2 2,656 4/22/2015
1.1.4 4,600 4/6/2015
1.1.2-beta 2,126 4/4/2015
1.1.0-beta 2,093 3/13/2015
1.0.6-alpha 2,294 2/27/2015
1.0.5-alpha 2,676 2/27/2015
1.0.4-alpha 2,219 2/27/2015
1.0.3-alpha 2,599 2/26/2015
1.0.2-beta 2,160 4/4/2015
1.0.2-alpha 2,553 2/25/2015
1.0.1-alpha 2,296 2/23/2015
1.0.0-alpha 2,493 2/23/2015

1.10.1-Beta2
- Fix #153 Appeared after 1.10.0 release. Only updates to this version for testing purposes and PLEASE report any issues. Stick to 1.9.3 for production.
1.10.0
- Fix #135 -CHANGED BEHAVIOR- Library now requeue jobs from dead server (read comments in the issue) thanks to @Lexy2
- Implement #150 (Replace async Redis calls with sync ones) thanks to @Lexy2
- Fix #148 (Can't schedule a job without specifying the queue ) thanks to @Lexy2
- Fix #142 (Scheduled jobs are returned incorrectly by the monitoring API) thanks to @Lexy2
1.9.5
- Address #139 support for netstandard2.0
- Fix #145 Added Job Queue parameter to the job information
- Update to Hangfire 1.8.12 and StackExchange.Redis 2.7.33
Big thanks to @Lexy2 for all the work on this release
1.9.4
- Update to Hangfire 1.8.7
- Add Support for all features defined for the storage in Hangfire 1.8.7
- Update StackExchange.Redis to 2.7.10
1.9.3
- Fix the missing key prefixing ({hangfire}:) for GetSetCount and GetSetContains (thanks to BobSilent)
1.9.2
- Failed jobs page lists new items first (thanks to toddlucas)
1.9.1
- Downgrade to netStandard 2.0 for broader compatibility
1.9
- Switched AsyncLocal storage of redis lock to ThreadLocal
- BREAKING CHANGE: Drop support for net461
- Added compatibility to Hangfire.Core 1.8
- BREAKING CHANGE: Namespace changes to uniform with folders (It wrongly appeared in previous ver)
1.8.5
- Speed up Recurring jobs Fetching (thanks to developingjim)
1.8.4
- Fix #90, #91 concurrent access on dictinoary (thanks to luukholleman)
- Fix #94 occasional error in monitoringApi (thanks to tsu1980)
1.8.3
- Removed dependency to NewtonSoft.JSON (thanks to neyromant)
1.8.2
- Updated Hangfire to 1.7.11 (thanks to abarducci)
- Updated StackExchange.Redis to 2.1.30 (thanks to abarducci)
1.8.1
- Updated Hangfire to 1.7.8
- Fixed #82 (thanks to @bcuff)
1.8.0
- Updated StackExchange.Redis to 2.0 (thanks to @andrebires)
1.7.2
- Added support for Lifo Queues (thanks to AndreSteenbergen)
- Added option to not use transaction (thanks to AndreSteenbergen)
- Enabled sliding expiration for distributed locks (thanks to pieceofsummer)
- Add epired jobs watch to cleanup succeeded/deleted lists (thanks to pieceofsummer)
- Make succeeded and deleted lists size configurable (thanks to pieceofsummer)
- Fix job state order (thanks to pieceofsummer)
- Exclude Fetched property from job parameters (thanks to pieceofsummer)
1.7.1
- Add expired jobs watcher to cleanup succeeded/deleted lists thanks to pieceofsummer
1.7.0
- Redis Cluster support (#42 thanks to gzpbx)
- Update to VS2017 (#48 thanks to ryanelian)