faktory_worker_ruby - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #android #rust #deep-learning #windows #awesome-list #security #mcp #openai

faktory_worker_ruby

(★ 216)

Faktory worker for Ruby

파일 탐색기

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

- - ci.yml
- faktory-worker
- complex_batch.rb
- - batch.rb
  - cli.rb
  - client.rb
  - connection.rb
  - exception_handler.rb
  - fetch.rb
  - io.rb
  - job.rb
  - job_logger.rb
  - launcher.rb
  - logging.rb
  - manager.rb
  - mutate.rb
  - processor.rb
  - rails.rb
  - testing.rb
  - tracking.rb
  - util.rb
  - version.rb
- faktory.rb
- faktory_worker_ruby.rb
- batch_test.rb
- client_test.rb
- faktory_test.rb
- helper.rb
- merge_test.rb
- mutate_test.rb
- polyglot_test.rb
- processor_test.rb
- set_test.rb
- system_test.rb
- testing_fake_test.rb
- testing_inline_test.rb
- testing_test.rb
- tracking_test.rb
- unique_test.rb
- workers.rb
.gitignore
.standard.yml
Changes.md
faktory_worker_ruby.gemspec
Gemfile
LICENSE
Rakefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/contribsys/faktory_worker_ruby

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

cd faktory_worker_ruby

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

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Ruby gem 명령어를 쓰려면 Ruby가 필요합니다.

gem install faktory_worker_ruby

RubyGems에 배포된 패키지를 바로 설치합니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

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

3. Ruby

쉬움

사전 준비물

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

bundle exec faktory-worker

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

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

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# faktory\_worker\_ruby

![CI status](https://github.com/contribsys/faktory_worker_ruby/actions/workflows/ci.yml/badge.svg)

Faktory\_worker\_ruby is the official Ruby client and worker process for the
Faktory background job server.  It is similar to [Sidekiq](http://sidekiq.org).

```
                       +--------------------+
                       |                    |
                       |     Faktory        |
                       |     Server         |
        +---------->>>>|                    +>>>>--------+
        |              |                    |            |
        |              |                    |            |
        |              +--------------------+            |
+-----------------+                            +-------------------+
|                 |                            |                   |
|    Client       |                            |     Worker        |
|    pushes       |                            |     fetches       |
|     jobs        |                            |      jobs         |
|                 |                            |                   |
|                 |                            |                   |
+-----------------+                            +-------------------+
```

* Client - an API any process can use to push jobs to the Faktory server.
* Worker - a process that pulls jobs from Faktory and executes them.
* Server - the Faktory daemon which stores background jobs in
  queues to be processed by Workers.

This gem contains only the client and worker parts.  The
server part is [here](https://github.com/contribsys/faktory/)

## Requirements

* Ruby 3.2 or higher
* Faktory 1.9 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)

Optionally, Rails 7.0+ for ActiveJob.

## Installation

gem install faktory_worker_ruby

## Documentation

See the [wiki](//github.com/contribsys/faktory_worker_ruby/wiki) for more details.

## Your First Job

Your Jobs should include the Faktory::Job module and have a `perform`
method.

```ruby
class SomeJob
  include Faktory::Job

def perform(...)
  end
end
```

then just call `SomeJob.perform_async(...)` to create a job.

Arguments to the perform method must be simple types supported
by JSON, exactly like Sidekiq.

## Start the worker

Once you've created a job, you need to start a Worker process to execute
those jobs.

```ruby
bundle exec faktory-worker
```

## Why not Sidekiq?

Sidekiq is awesome; it's stable and useful. It suffers from two design limitations:

1. Sidekiq uses Redis and Redis is a plain datastore, all Sidekiq features are
   implemented in Ruby and have to travel over the network to access data.
2. Because of (1), Sidekiq is limited to Ruby.  You can't execute jobs
   with, e.g., Python and get the same Sidekiq features.

Instead Faktory is a "smart" server that implements all major features
within the server itself; the worker process can be dumb and rely on
the server for job retries, reservation, Web UI, etc.  This also means
we can create workers in any programming language.

If your organization is 100% Ruby, Sidekiq will serve you well.  If your
organization is polyglot, Faktory will be a better fit.

faktory\_worker\_ruby tries to be Sidekiq API compatible where possible (and
PRs to improve this are very welcome).

## Author

Mike Perham, [@getajobmike](https://ruby.social/@getajobmike), mike @ contribsys.com