Hangfire.Mongo 1.10.7

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

// Install Hangfire.Mongo as a Cake Tool
#tool nuget:?package=Hangfire.Mongo&version=1.10.7

Hangfire.Mongo

Build Nuget downloads GitHub license

MongoDB support for Hangfire library. By using this library you can store all jobs information in MongoDB.

Installation

To install Hangfire MongoDB Storage, run the following command in the Nuget Package Manager Console:

PM> Install-Package Hangfire.Mongo

Usage ASP.NET Core

public void ConfigureServices(IServiceCollection services)
{
    var mongoUrlBuilder = new MongoUrlBuilder("mongodb://localhost/jobs");
    var mongoClient = new MongoClient(mongoUrlBuilder.ToMongoUrl());

    // Add Hangfire services. Hangfire.AspNetCore nuget required
    services.AddHangfire(configuration => configuration
        .SetDataCompatibilityLevel(CompatibilityLevel.Version_180)
        .UseSimpleAssemblyNameTypeSerializer()
        .UseRecommendedSerializerSettings()
        .UseMongoStorage(mongoClient, mongoUrlBuilder.DatabaseName, new MongoStorageOptions
        {
            MigrationOptions = new MongoMigrationOptions
            {
                MigrationStrategy = new MigrateMongoMigrationStrategy(),
                BackupStrategy = new CollectionMongoBackupStrategy()
            },
            Prefix = "hangfire.mongo",
            CheckConnection = true
        })
    );
    // Add the processing server as IHostedService
    services.AddHangfireServer(serverOptions =>
    {
        serverOptions.ServerName = "Hangfire.Mongo server 1";
    });

    // Add framework services.
}

Usage ASP.NET

var options = new MongoStorageOptions
{
    MigrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new DropMongoMigrationStrategy(),
        BackupStrategy = new NoneMongoBackupStrategy()
    }
};
GlobalConfiguration.Configuration.UseMongoStorage("mongodb://localhost/jobs", options);
app.UseHangfireServer();
app.UseHangfireDashboard();

Usage Console

var options = new MongoStorageOptions
{
    MigrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new DropMongoMigrationStrategy(),
        BackupStrategy = new NoneMongoBackupStrategy()
    }
};
var mongoStorage = new MongoStorage(
                MongoClientSettings.FromConnectionString("mongodb://localhost"),
                "jobs", // database name
                options);
            
using(new BackgroundJobServer(mongoStorage))
{
  ...
}

Custom collections prefix

To use custom prefix for collections names specify it on Hangfire setup:

public void Configuration(IAppBuilder app)
{
    GlobalConfiguration.Configuration.UseMongoStorage("mongodb://localhost/ApplicationDatabase",
        new MongoStorageOptions { Prefix = "custom" } );

    app.UseHangfireServer();
    app.UseHangfireDashboard();
}

Configuration Overrides

  • CheckQueuedJobsStrategy (default: Watch)
    • Watch uses change streams to watch for enqueued jobs. Will still poll using 'QueuePollInterval'.
    • Poll will poll periodically using 'QueuePollInterval', recommended for large installments.
    • TailNotificationsCollection uses a capped, tailable collection to notify nodes of enqueued jobs. Will still poll using 'QueuePollInterval'. Works with single node MongoDB instances.

Naming Convention

Hangfire.Mongo will ignore any naming conventions configured by your application. E.g. if your application use camel casing like this:

  var camelCaseConventionPack = new ConventionPack { new CamelCaseElementNameConvention() };
  ConventionRegistry.Register("CamelCase", camelCaseConventionPack, type => true);

it will be ignored by Hangfire.Mongo and Pascal Case will be used instead. Of cause only for Hangfire specific collections.

Migration

We sometimes introduce breaking changes in the schema. For this reason we have introduced migration. Three migration strategies exists.

  • Throw

    This is the default migration strategy. It will throw an InvalidOperationException never letting you get up and running if there is a schema version mismatch. So it forces you to decide what migration strategy is best for you and at the same time keeps your data safe.

  • Drop

    This will simply just drop your existing Hangfire.Mongo database and update the schema version. No fuzz and ready to start from scratch. It is the perfect strategy if you e.g. enque all your jobs at startup.

  • Migrate

    This will migrate your database from one schema version to the next until the required schema version is reached. Chances are that not all data can be migrated, why some loss of data might occur. Please use with caution and thougoughly test before deploying to production. We are not responsible for data loss.

    NOTE: Only forward migration is supported. If you need to revert to a previous schema version, you need to manually drop or restore the previous database.

public void Configuration(IAppBuilder app)
{
    var migrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new MigrateMongoMigrationStrategy(),
        BackupStrategy = new CollectionMongoBackupStrategy()
    };
    var storageOptions = new MongoStorageOptions
    {
        // ...
        MigrationOptions = migrationOptions
    };
    GlobalConfiguration.Configuration.UseMongoStorage("<connection string with database name>", storageOptions);

    app.UseHangfireServer();
    app.UseHangfireDashboard();
}

NOTE: By default the parameter InvisibilityTimeout of the MongoStorageOptions is configured with the value null, making the job to stay in status 'processing' in case of an error in the application. To solve this issue, set the value to 30 minutes like in the SqlServerStorageOptions.

public void Configuration(IAppBuilder app)
{
    var migrationOptions = new MongoMigrationOptions
    {
        MigrationStrategy = new MigrateMongoMigrationStrategy(),
        BackupStrategy = new CollectionMongoBackupStrategy()
    };
    var storageOptions = new MongoStorageOptions
    {
        // ...
        MigrationOptions = migrationOptions,
        InvisibilityTimeout = TimeSpan.FromMinutes(30)
    };
    GlobalConfiguration.Configuration.UseMongoStorage("<connection string with database name>", storageOptions);

    app.UseHangfireServer();
    app.UseHangfireDashboard();
}

Migration Backup

By default no backup is made before attempting to migrate. You can backup Hangfire collections by "cloning" each collection to the same database. Alternatively you can just write your own, by inheriting MongoBackupStrategy and use that implementation.

NOTE: This software is made by humans in our sparetime - we do our best but will not be held responsible for any data loss.

Contributors

License

Hangfire.Mongo is released under the MIT License.

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 (20)

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

Package Downloads
DiegoRangel.DotNet.Framework.CQRS.Infra.CrossCutting.Hangfire

A common library for implementing CQRS based CrossCutting Hangfire layer.

EaCloud.Hangfire

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

Jcex.Infra.Hangfire

该库提供了一种方便的 Hangfire 定时任务管理方式,使用 MongoDB 来存储任务信息,并内置 Web 界面来监控和操作任务。全面可视化的界面提供了对任务状态和进度的监控。

MicroCloud.Hangfire

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

nguyendk.DotnetExtensions.NET

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Hangfire.Mongo:

Repository Stars
gnsilence/HangfireHttpJob
hangfire的拓展程序,在原作者基础上增加了一些功能,调用api的方式来执行定时任务
Version Downloads Last updated
1.10.7 1,429 6/17/2024
1.10.6 45,565 4/24/2024
1.10.5 18,627 4/9/2024
1.10.4 61,867 2/26/2024
1.10.3 24,889 2/11/2024
1.10.2 1,748 2/8/2024
1.10.1 1,180 2/7/2024
1.10.0 543 2/7/2024
1.9.16 46,927 1/4/2024
1.9.15 48,324 11/28/2023
1.9.14 22,869 11/12/2023
1.9.13 630 11/10/2023
1.9.12 28,806 10/28/2023
1.9.11 27,129 10/14/2023
1.9.10 41,207 9/21/2023
1.9.9 24,863 9/11/2023
1.9.8 42,471 8/14/2023
1.9.7 98,830 7/18/2023
1.9.6 42,339 6/18/2023
1.9.5 114,647 5/18/2023
1.9.4 3,375 5/15/2023
1.9.3 126,895 3/31/2023
1.9.2 161,767 2/2/2023
1.9.1 201,889 12/19/2022
1.9.0 27,943 12/10/2022
1.7.3 402,390 8/24/2022
1.7.2 127,350 6/13/2022
1.7.1 39,402 6/8/2022
1.7.0 237,188 3/19/2022
0.7.28 186,739 1/2/2022
0.7.27 128,932 11/3/2021
0.7.25 82,743 9/20/2021
0.7.24 105,975 8/8/2021
0.7.22 254,552 5/2/2021
0.7.20 94,732 3/25/2021
0.7.19 76,050 2/10/2021
0.7.17 149,722 11/20/2020
0.7.12 149,087 8/12/2020
0.7.11 194,871 6/7/2020
0.6.7 190,320 3/19/2020
0.6.6 418,584 12/11/2019
0.6.5 85,767 10/21/2019
0.6.4 17,508 9/26/2019
0.6.3 27,906 8/14/2019
0.6.2 18,554 7/28/2019
0.6.1 38,611 6/16/2019
0.6.0 42,677 4/23/2019
0.5.15 147,104 1/3/2019
0.5.14 1,945 1/1/2019
0.5.13 13,251 12/13/2018
0.5.12 46,553 10/28/2018
0.5.11 85,073 9/5/2018
0.5.10 39,892 5/27/2018
0.5.9 54,849 2/20/2018
0.5.8 2,207 2/20/2018
0.5.7 86,336 11/20/2017
0.5.6 1,794 11/20/2017
0.5.5 12,644 10/14/2017
0.5.4 10,555 9/22/2017
0.5.3 3,011 9/21/2017
0.5.2 30,123 9/1/2017
0.5.1 2,371 8/30/2017
0.5.0 3,775 8/17/2017
0.4.1 14,424 6/22/2017
0.4.0 5,232 6/19/2017
0.3.2 59,288 12/10/2016
0.3.1 2,136 11/30/2016
0.3.0 2,112 11/29/2016
0.2.8 8,375 9/26/2016
0.2.6 217,251 5/29/2016
0.2.5 5,063 3/5/2016
0.2.4 2,483 2/15/2016
0.2.3 2,803 12/6/2015
0.2.2 5,800 7/12/2015
0.2.1 3,092 12/13/2014
0.2.0 2,368 12/7/2014

1.10.7
           - Update to Hangfire 1.8.14
           - Update to MongoDB 2.26.0