How does the following SqlServerStorageOptions work?

Tags: #<Tag:0x00007f186096fdf0>

I have been experiencing delay about 10 seconds after enqueing the jobs. I noticed that I can set the QueuePollInterval to 0 and SlidingInvisibilityTimeout to make the job processing faster.

Can anyone actually explain how they work? Is the sliding option like a auto poll interval selector? Will it make frequent calls to the database?

GlobalConfiguration.Configuration
    .UseSqlServerStorage("db_connection", new SqlServerStorageOptions
    {
        CommandBatchMaxTimeout = TimeSpan.FromMinutes(5),
        SlidingInvisibilityTimeout = TimeSpan.FromMinutes(5),
        QueuePollInterval = TimeSpan.Zero,
        UseRecommendedIsolationLevel = true,
        UsePageLocksOnDequeue = true,
        DisableGlobalLocks = true
    });
3 Likes

I am also very curious to learn the answer of this question. Specifically, how does QueuePollInterval works when it is set to TimeSpan.Zero?

SlidingInvisibilityTimeout is used to indicate how long a BackgroundJob execution is allowed to run for without status change (success/failure) before Hangfire decides the BackgroundJob execution was not successful and needs to be made visible to the HangfireServer for processing again. The idea being that if a HangfireServer starts processing a BackgroundJob and then gets killed without being able to report back that the BackgroundJob failed then there would need to be a retry of that BackgroundJob.

You probably shouldn’t change SlidingInvisibilityTimeout unless you have a really compelling reason. For example, if you set it to 5 minutes and then have a BackgroundJob that runs for 6 minutes, Hangfire is going to end up queuing up multiple instances of that BackgroundJob because it hasn’t completed fast enough.

QueuePollInterval is how long the server is going to wait in between checking the database for new BackgroundJobs to process. Setting this value will result in Jobs being picked up off the queue faster, but also more load on your SQL Server.

If you need faster dequeue time, utilizing MSMQ alongside SQL Server Storage can get near to real-time without the overhead of more polling: https://docs.hangfire.io/en/latest/configuration/using-sql-server-with-msmq.html

1 Like

I’ve recently learned (from Hangfire Support) how these work:

  • SlidingInvisibilityTimeout changes Hangfire’s strategy of how to determine whether a background job that a worker dequeued is still alive and being processed. Rather than keeping a DB connection and transaction active while the job is running (thus locking the job for other workers), the worker that processed the job will periodically update a timestamp in the DB. Only when the timestamp hasn’t been updated for some time (the value set as the “sliding invisibility timeout”), the job becomes abandoned. (This is a bit different than what Jonah writes above - even when the job runs for longer than the timeout, it will not be abandoned as long as the the worker can still update the timestamp, signaling that it’s still working on the job.)
  • When the QueuePollInterval is set to zero, Hangfire will switch to a sort of “long polling”, where a single long-running query is executed that will periodically check and wait on the server side (via WAITFOR DELAY) until a new job arrives. This reduces the DB load caused by client side polling.
  • Setting a CommandBatchMaxTimeout will enable a strategy where Hangfire sends multiple queries in a single batch, reducing DB roundtrips (and increasing concurrency).
  • DisableGlobalLocks will turn off some global SQL Server application locks, which are no longer deemed necessary with schema version 7. (With schema version 6, deadlocks can arise when turning off the global locks.)