README.md in sidekiq-status-3.0.0 vs README.md in sidekiq-status-3.0.1
- old
+ new
@@ -1,9 +1,8 @@
# Sidekiq::Status
[](https://badge.fury.io/rb/sidekiq-status)
[](https://github.com/kenaniah/sidekiq-status/actions/)
-[](https://inch-ci.org/github/kenaniah/sidekiq-status)
Sidekiq-status is an extension to [Sidekiq](https://github.com/mperham/sidekiq) that tracks information about your Sidekiq and provides a UI to that purpose. It was inspired by [resque-status](https://github.com/quirkey/resque-status).
Requires Ruby 2.6+ and Sidekiq 6.0+ or newer.
@@ -19,10 +18,14 @@
```bash
gem install sidekiq-status
```
+### Migrating to Version 3.x from 2.x
+
+Version 3.0.0 adds support for Sidekiq 7.x, but drops support for Sidekiq 5.x. **You should be able to upgrade cleanly from version 2.x to 3.x provided you are running Sidekiq 6.x or newer.**
+
#### Migrating to Version 2.x from 1.x
Version 2.0.0 was published in order to add support for Ruby 3.0 and Sidekiq 6.x and to remove support for versions of both that are now end-of-life. **You should be able to upgrade cleanly from version 1.x to 2.x provided you are running Sidekiq 5.x or newer.**
Sidekiq-status version 1.1.4 provides support all the way back to Sidekiq 3.x and was maintained at https://github.com/utgarda/sidekiq-status/.
@@ -44,19 +47,19 @@
require 'sidekiq'
require 'sidekiq-status'
Sidekiq.configure_client do |config|
# accepts :expiration (optional)
- Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
+ Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
end
Sidekiq.configure_server do |config|
# accepts :expiration (optional)
- Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes
+ Sidekiq::Status.configure_server_middleware config, expiration: 30.minutes.to_i
# accepts :expiration (optional)
- Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes
+ Sidekiq::Status.configure_client_middleware config, expiration: 30.minutes.to_i
end
```
Include the `Sidekiq::Status::Worker` module in your jobs if you want the additional functionality of tracking progress and storing / retrieving job data.
@@ -173,9 +176,11 @@
Sidekiq::Status::get job_id, :vino #=> 'veritas'
Sidekiq::Status::at job_id #=> 5
Sidekiq::Status::total job_id #=> 100
Sidekiq::Status::message job_id #=> "Almost done"
Sidekiq::Status::pct_complete job_id #=> 5
+Sidekiq::Status::working_at job_id #=> 2718
+Sidekiq::Status::update_time job_id #=> 2819
```
### Unscheduling
```ruby