mini_scheduler - GitLite

KO | EN

gitlite — search

#python #react #android #deep-learning #linux #nodejs #windows #awesome #awesome-list #pytorch #ios #mcp #openai #open-source

mini_scheduler

(★ 172)

Adds recurring jobs for Sidekiq

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- dependabot.yml
- sidekiq-6.5.gemfile
- sidekiq-7.0.gemfile
- sidekiq-7.1.gemfile
- sidekiq-7.2.gemfile
- sidekiq-7.3.gemfile
- sidekiq-8.0.gemfile
- sidekiq-8.1.gemfile
- - distributed_mutex.rb
  - engine.rb
  - manager.rb
  - schedule.rb
  - schedule_info.rb
  - version.rb
  - web.rb
- mini_scheduler.rb
- - manager_spec.rb
  - schedule_info_spec.rb
  - slow_spec.rb
  - web_spec.rb
- spec_helper.rb
.gitignore
.rspec
.rubocop.yml
.streerc
CHANGELOG.md
Gemfile
Guardfile
mini_scheduler.gemspec
Rakefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/discourse/mini_scheduler

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd mini_scheduler

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

$ bundle

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://github.com/discourse/mini_scheduler/workflows/CI/badge.svg)](https://github.com/discourse/mini_scheduler/actions)
[![Gem Version](https://badge.fury.io/rb/mini_scheduler.svg)](https://rubygems.org/gems/mini_scheduler)

# MiniScheduler

MiniScheduler adds recurring jobs to [Sidekiq](https://sidekiq.org/).

## Installation

Add this line to your application's Gemfile:

```rb
gem 'mini_scheduler'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install mini_scheduler

In a Rails application, create files needed in your application to configure mini_scheduler:

$ bin/rails g mini_scheduler:install
    $ bin/rails db:migrate

An initializer is created named `config/initializers/mini_scheduler.rb` which lists all the configuration options.

## Configuring MiniScheduler

By default each instance of MiniScheduler will run with a single worker. To amend this behavior:

```rb
if Sidekiq.server? && defined?(Rails)
  Rails.application.config.after_initialize do
    MiniScheduler.start(workers: 5)
  end
end
```

This is useful for cases where you have extremely long running tasks that you would prefer did not starve.

## Usage

Create jobs with a recurring schedule like this:

```rb
class MyHourlyJob
  include Sidekiq::Worker
  extend MiniScheduler::Schedule

every 1.hour

def execute(args)
    # some tasks
  end
end
```

Options for schedules:

- **queue** followed by a queue name, like "queue :email", default queue is "default"
- **every** followed by a duration in seconds, like "every 1.hour".
- **daily at:** followed by a duration since midnight, like "daily at: 12.hours", to run only once per day at a specific time.

To view the scheduled jobs, their history, and the schedule, go to sidekiq's web UI and look for the "Scheduler" tab at the top.

To enable this view in Sidekiq, add `require "mini_scheduler/web"` to `routes.rb`:

```rb
require "sidekiq/web"
require "mini_scheduler/web"

Rails.application.routes.draw do
 ...
end
```

## How to reach us

If you have questions about using mini_scheduler or found a problem, you can find us at https://meta.discourse.org.