It's like Sidekiq for AWS Lambda.
Execute your background jobs in Lambda for nearly instant and infinite scalability. This is ideal for applications with uneven, unpredictable, or bursty usage patterns.
Coming Soon: Funktor Pro & Funktor Enterprise
Add this line to your application's Gemfile:
gem 'funktor'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install funktor
Funktor uses serverless to provision AWS resources and to deploy your code to Lambda. You can install serverless by doing:
npm install -g serverless
Then you can initialize a new app by doing:
funktor bootstrap my-funktor-app
cd my-funktor-app
funktor init
This will create a funktor
directory that is ready to deploy to AWS. If you've already configured
your aws tools via ~/.aws/credentials
you should be ready to deploy.
See the wiki for more info, especially the section about getting started in a stand alone project.
After initialiing your app you can deploy it by cd
ing into the funktor
directory and using
serverless deploy
.
cd funktor
serverless deploy --verbose
This will deploy to the dev
stage. To deploy to a differnt stage you can use the --stage
flag:
serverless deploy --stage production --verbose
After your app is deployed you'll see some outputs containing details about your AWS resources. The
primary ones you should look for are IncomingJobQueueUrl
, AccessKeyID
, and SecretAccessKey
.
Those three pieces of info represent the primary interface to your funktor
app from the outside world.
To push your first job to funktor
you can make note of those values and then do something like this
in a rails console
.
ENV['FUNKTOR_INCOMING_JOB_QUEUE'] = "<Your IncomingJobQueueUrl>"
ENV['AWS_ACCESS_KEY_ID'] = "<Your AccessKeyID>"
ENV['AWS_SECRET_ACCESS_KEY'] = "<Your SecretAccessKey>"
ENV['AWS_REGION'] = "<Your AWS Region>" # 'us-east-1' by default
require_relative 'funktor/workers/hello_worker'
HelloWorker.perform_async
If everything went well you should see something like this:
=> #<struct Aws::SQS::Types::SendMessageResult md5_of_message_body="...",
md5_of_message_attributes=nil, md5_of_message_system_attributes=nil,
message_id="...", sequence_number=nil>
class HelloWorker
include Funktor::Worker
def perform(name)
puts "hello #{name}"
end
end
The arguments to your perform
methos must be plain Ruby objects, and not complex objects like ActiveRecord
models. Funktor will dump the arguments to JSON when pushing the job onto the queue, so you need to make sure
that your arguments can be dumped to JSON and loaded back again without losing any information.
HelloWorker.perform_async(name)
HelloWorker.perform_in(5.minutes, name)
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/Octo-Labs/funktor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Funktor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.