https://github.com/cookpad/barbeque_client
barbeque client for Ruby
https://github.com/cookpad/barbeque_client
Last synced: 5 months ago
JSON representation
barbeque client for Ruby
- Host: GitHub
- URL: https://github.com/cookpad/barbeque_client
- Owner: cookpad
- License: mit
- Created: 2016-08-30T08:52:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T10:34:52.000Z (over 1 year ago)
- Last Synced: 2024-12-07T22:08:23.179Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 106 KB
- Stars: 4
- Watchers: 11
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# BarbequeClient [](https://github.com/cookpad/barbeque_client/actions/workflows/ci.yml)
Barbeque client for Ruby.
## Installation
Add this line to your application's Gemfile:
```rb
gem 'barbeque_client'
```
And create "config/initializers/barbeque.rb" and edit it like:
```rb
BarbequeClient.configure do |config|
config.application = 'cookpad'
config.default_queue = 'default'
config.endpoint = 'https://barbeque.example.com'
config.headers = { 'Host' => 'barbeque' } # optional
end
```
## Usage
### Enqueuing a job
```rb
execution = BarbequeClient.enqueue(
job: 'NotifyAuthor', # @param [String] job - Job name to enqueue.
message: { user_id: 7553989 }, # @param [Object] message - An object which is serializable as JSON.
queue: 'default', # @param optional [String] queue - A queue name to enqueue a job.
delay_seconds: 0, # @param optional [Integer] delay_seconds - Message timer of SQS.
)
execution.message_id #=> "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
execution.status #=> "pending"
```
### Polling the job's status
```rb
message_id = "a3c653c1-335e-4d4d-a6f9-eb91c0253d02"
BarbequeClient.status(message_id: message_id) #=> "success"
```
### With Rails
Barbeque client has adapter for ActiveJob.
```rb
# config/environments/some_environment.rb
Rails.application.config.active_job.queue_adapter = :barbeque
```
And everything will be ok. Don't forget to setup `config.application` and `config.endpoint` in somewhere.
One more thing, `config.default_queue` option is meaningless with Rails.
`default_queue` is the fallback option for enqueueing without specified queue name.
However, ActiveJob always set default queue as 'default' internally,
there is no place to work on. So please use [`queue_as`](http://api.rubyonrails.org/classes/ActiveJob/QueueName/ClassMethods.html#method-i-queue_as) when you want to use different queue name.
### Distributed tracing
Configure `tracing` option. Pick one of supported tracers.
See more detail in https://github.com/cookpad/garage_client#tracing.
```
BarbequeClient.configure do |config|
# ...
config.tracing = { tracer: 'aws-xray', service: 'barbeque' }
end
```