Crank Up Your Apps With TorqueBox

Crank Up Your Apps With

Jim Crossley
MagicRuby
Creative Commons BY-SA 3.0
Feb 2011

1

Jim who?

• “recovering java architect”
• java since ’96, ruby since ’06
• emacs and guitars since forever
• Red Hat Senior Engineer
• proud member of

2

Agenda
• High-level BS and Development
Process
• Web, Messaging, Scheduling,
Services, Clustering

5

TorqueBox
the power of JBoss with the expressiveness of Ruby

6

TorqueBox: what?

• A “real” app server for Ruby
• Founded in 2008
• Bob’s “labor of love”
• 100% open-source, LGPL license
• Reflects a strong commitment to
Ruby from Red Hat

7

TorqueBox: why?

• “Native” support for Rack apps
• Built-in background processing
• Built-in scheduling
• Built-in clustering
• Easily scalable
• Optionally enterprisey
8

JRuby
a good idea done well

9

JRuby: why?

• Very fast runtime
• Real threads
• Java libraries
• Java tools
• Healthy community

10

JRuby: why not?

• Slower start up
• Native gems
• FFI
• C extension support
• Some Ruby libs not thread-safe

11

JBoss AS
but before we get to that...

12

Enterprise Java
misconceptions

13

Acronymious?
WAR JAXBEAR JSTL SLSB
JSF JNLPJTA JPA JNI JCK
JAX-RPC JDOM JAXP JAX-WS
JSE JEE JMM JTS JWS
NIO JDO AWT JMX
JLS JAR JRE JCP
JSR JNDI
JSP SAF EJB JME POJO
JMSJDBC JDK JVM
JAX-RS JPQL
NPE
15

Enterprise Java is all that
and more! but...

18

I promise...

• No XML
• No Java *
• No war files *
• Only Ruby, YAML and...
* Unless you really want to

19

JBoss AS
the enterprisey good parts

20

JBoss AS6

• Tomcat for web
• Infinispan for caching
• HornetQ for messaging
• Quartz for scheduling
• mod_cluster for clustering

21

AS = Application Server

• Not just “web server + interpreter”
• More like initd than httpd
• Can host multiple, disparate apps
simultaneously
• Provides basic services to all the
apps it hosts

22

Hot Deployment
$JBOSS_HOME/server/default/deploy/

• anything added to deploy/
will get deployed
• anything removed from
deploy/ will get
undeployed
• anything updated in
deploy/ will get redeployed
• TorqueBox deployers
make JBoss grok YAML
and ruby archives

23

Hot Deployment

• deployment
anything added to deploy/
will get deployed
descriptors
deploy/ will get
undeployed
• TorqueBox deployers
and ruby archives

24

Hot Deployment

• anything added to deploy/
will get deployed
deploy/ will get
undeployed
zip files
• (archives)
TorqueBox deployers
and ruby archives

25

Development Process
how do they work?

26

easy install

$ wget http://torquebox.org/torquebox-dev.zip
$ unzip torquebox-dev.zip

$ export TORQUEBOX_HOME=$PWD/torquebox-1*
$ export JBOSS_HOME=$TORQUEBOX_HOME/jboss
$ export JRUBY_HOME=$TORQUEBOX_HOME/jruby

$ export PATH=$JRUBY_HOME/bin:$PATH

27

easy install




28

easy install




29

easy install

$ unzip torquebox-dev.zip Make sure the jruby
found in your path is in
$JRUBY_HOME/bin.


30

easy install

$ jruby -S gem install bundler
$ jruby -S gem install rails
$ jruby -S gem install sinatra

31

rake tasks
Rakefile

require "org.torquebox.rake-support"

32

rake tasks

rake torquebox:run
Run TorqueBox server

rake torquebox:deploy[context_path]
Deploy the app in the current directory

rake torquebox:undeploy
Undeploy the app in the current directory

33

rake tasks

Start torquebox:run in its own
shell and leave it running. Instead
of script/server or shotgun
or thin or whatever else,
use torquebox:deploy.

34

deployment descriptors

torquebox:deploy creates
a deployment descriptor in the
JBoss deploy/ directory

35

deploy/myapp-{rails,rack}.yml

application:
root: /path/to/myapp
env: development
web:
context: myapp
host: www.yourhost.com
static: public
rackup: config.ru
environment:
MAIL_HOST: mail.yourhost.com
REPLY_TO: you@yourhost.com

36


application:
env: development
web:
context: myapp The fully-qualified
host: www.yourhost.com path to the app.
static: public This will be the value
rackup: config.ru
environment: of either
RAILS_ROOT or
REPLY_TO: you@yourhost.com RACK_ROOT

37


application:
env: development
web:
context: myapp
host: www.yourhost.comThe runtime mode of
static: public the app. This will be
rackup: config.ru
environment:
either RAILS_ENV
MAIL_HOST: mail.yourhost.comor RACK_ENV

38

The app’s context path
(or “sub URI”):
http://localhost:8080/myapp
application: Can be set via rake:
root: rake torquebox:deploy[myapp]
/path/to/myapp
env: development The default is root:
web: http://localhost:8080/
context: myapp
static: public
rackup: config.ru
environment:

39


application:
root: /path/to/myapp A list of virtual
env: development hostnames to which
web: to bind the app.
context: myapp
static: public
rackup: config.ru
environment:

40


application:
env: development
web:
The location of the
context: myapp app’s static
host: www.yourhost.com content, either
static: public absolute or relative
rackup: config.ru to the app’s root.
environment:

41


application:
env: development
web:
The name of the
context: myapp rackup script used to
host: www.yourhost.com boot your app
static: public
rackup: config.ru
environment:

42


application:
env: development Any environment
web: variables required
context: myapp by the app.
static: public
rackup: config.ru
environment:

43


• config/torquebox.yml
• internal descriptors have the
same structure as the
external ones in deploy/
• may be used to provide your
own reasonable defaults

44

Web
make rack, not war

45

jruby-rack

• All rack-based frameworks
supported: rails, sinatra, etc
• No packaging required: apps deploy
from where they sit on disk
• No redeploy necessary to see
changes when using rack reloading
or rails development mode

46

database connectivity
Gemfile

gem "activerecord-jdbc-adapter"

gem "jdbc-postgres"
# gem "jdbc-sqlite3"
# gem "jdbc-mysql"

47

rails template

• Adds TorqueBox rake tasks
• Adds the JDBC sqlite3 gems
• Adds TorqueBox session_store
• Adds Backgroundable module

48

my first rails app

$ jruby -S rails new myapp -m
$TORQUEBOX_HOME/share/rails/template.rb

$ cd myapp
$ jruby -S bundle install

$ jruby -S rake torquebox:deploy

49

Messaging
asynchronicity

50

lots of options
RabbitMQ Resque cron BackgroundDRb
workling CronEdit
BackgroundJob
Kestral rufus-scheduler JobFu
Ap4r
Amazon SQS async_observer
Taskr Sparrow Background-Fu
beanstalkd DelayedJob RailsCron
Open4
Conveyor
WorkerQueue daemons rake
ActiveMQ
starling Spawn ActiveMessaging

51

TorqueBox::Messaging

• JMS (Java Message Service)
is an API for messaging
• implementation
HornetQ is the JBoss JMS

52


• Task
• Backgroundable
• MessageProcessor
• Queue
• Topic

53

• No extra tables in your database
• No external system to manage
• Little to no config required at all
• No redeploy necessary in dev mode
• Efficient loading of rails environment
• Automatic load balancing and retries
• Works on Windows, if you care
54

Tasks
app/tasks/email_task.rb

class EmailTask < TorqueBox::Messaging::Task
def welcome(payload)
person = payload[:person]
person ||= Person.find_by_id(payload[:id])
if person
# send the email
person.welcomed = true
person.save!
end
end
end

55

Tasks

if person
# send the email
person.save!
end
end
end

56

Tasks

if person
# send the email
person.save!
end
end
end

57

Tasks

if person
# send the email
person.save!
end
end
end

58

Tasks

if person
# send the email
person.save!
end
end
end

59

Tasks
app/controllers/people_controller.rb

class PeopleController < ApplicationController
def create
@person = Person.new(params[:person])
respond_to do |format|
if @person.save
EmailTask.async(:welcome, :id => person.id)
# respond appropriately
end
end
end
end

60

Tasks
app/controllers/people_controller.rb

class PeopleController < ApplicationController
def create
@person = Person.new(params[:person])
respond_to do |format|
if @person.save
EmailTask.async(:welcome, :id => person.id)
# respond appropriately
end
end
end
end

61

Tasks

Call them from your
controllers, models, and
observers, or even other
tasks. Even in non-Rails
apps!

62

Backgroundable

Inspired by DelayedJob’s
handle_asynchronously,
it’s trivial to create implicit
background Tasks.

63

Backgroundable
lib/something.rb

include TorqueBox::Messaging

class Something
include Backgroundable
always_background :foo
def foo;; end
def bar;; end
end
...
@something.foo
@something.background.bar

64

Backgroundable
lib/something.rb


class Something
def foo;; end
def bar;; end
end
...
@something.foo

65

Backgroundable
lib/something.rb


class Something
def foo;; end
def bar;; end
end
...
@something.foo

66

Backgroundable
lib/something.rb


class Something
def foo;; end
def bar;; end
end
...
@something.foo

67

Backgroundable
app/models/slow_poke.rb

class SlowPoke < ActiveRecord::Base
def takes_forever;; end
def might_take_awhile;; end
end

SlowPoke.always_background :takes_forever

@slowpoke.takes_forever
@slowpoke.background.might_take_awhile

68

Queues
Tasks are built on top of
Queues. Of course, you may
build your own “MOM” apps
by defining your own Queues,
Topics, and their message
Processors yourself.

69

Queues
config/queues.yml

/queues/questions:

/queues/answers:
durable: false

70

Processors

You can create a processor
class to receive messages
from a Topic or Queue

71

Processors
config/messaging.yml

/topics/print: PrintHandler
/queues/popular:
- PopularHandler
- AdultObserver:
filter: "age >= 18"
concurrency: 5
/queues/students:
PrintHandler:
config:
color: true

72

Processors

/queues/popular:
- PopularHandler
- AdultObserver:
filter: "age >= 18"
concurrency: 5
/queues/students:
PrintHandler:
config:
color: true

73

Processors

/queues/popular:
- PopularHandler
- AdultObserver:
filter: "age >= 18"
concurrency: 5
/queues/students:
PrintHandler:
config:
color: true

74

Processors

/queues/popular:
- PopularHandler
- AdultObserver:
filter: "age >= 18"
concurrency: 5
/queues/students:
PrintHandler:
config:
color: true

75

Processors
app/models/print_handler.rb


class PrintHandler < MessageProcessor
def on_message(body)
puts "Processing #{body} of #{message}"
end
def configure(opts)
@color = opts['color']
end
end

76

Queues (again)

But how do you send a
message?

77

Queues
example

include TorqueBox
req = Messaging::Queue.new '/queues/questions'
res = Messaging::Queue.new '/queues/answers'

Thread.new do
req.publish "What time is it?"
puts res.receive( :timeout => 1000 )
end

puts req.receive
res.publish Time.now

78

Queues
example

include TorqueBox

Thread.new do
end

puts req.receive

79

Queues
example

include TorqueBox

Thread.new do
end

puts req.receive

80

Queues
example

include TorqueBox

Thread.new do
end

puts req.receive

81

Queues
“on the fly”

include TorqueBox

queue = Messaging::Queue.new '/queues/foo'
queue.create
...
queue.destroy

82

Topics

• behavior is different, but interface is
the same.
• all subscribers of a topic see each
message, but only one subscriber
will see any message from a queue
• use topics.yml to define topics
• use TorqueBox::Messaging::Topic

83

Scheduling
get regular later

84

Jobs
app/jobs/newsletter_sender.rb

class NewsletterSender

def run()
subscriptions = Subscription.find(:all)
subscriptions.each do |e|
send_newsletter( e )
end
end

end

85

Jobs
config/jobs.yml

monthly_newsletter:
description: first of month
job: NewsletterSender
cron: ‘0 0 0 1 * ?’

sandbox:
job: Sandbox
cron: ‘*/5 * * * * ?’

86

Jobs
“Fire every half hour from 10am until 1pm
on the third Friday of each month”

0 */30 10-13 ? * FRI#3

Seconds Minutes Hours DOM Month DOW Year

1-7
1-12 1970-
1-31 SUN-
0-59 0-59 0-23 JAN- 2099
?LW SAT
DEC empty
?L#

87

Jobs
• More portable. What is the first day
of the week on BSD again? What’s
cron on Windows?
• Self contained within the app. No
external systems to manage and
keep in sync.
• Full rails environment loaded and
available.

88

Services
run along, lil’ daemon

89

Services

Long-running, non-web
“daemons” that share the
runtime environment and
deployment lifecycle of
your app.

90

Services
• Represented as a class with
optional initialize(Hash),
start() and stop() methods,
which should each return quickly.
• Typically will start a long-running
loop in a thread and respond to
external events.
• Configured via services.yml

91

Services
config/services.yml

IrcBot:
server: freenode.net
channel: #torquebox
publish: /topics/irc

MyMudServer:

SomeOtherService:

92

Services
app/{models,etc}/my_service.rb

class MyService
def initialize opts={}
name = opts[:publish]
@queue = Messaging::Queue.new(name)
end
def start
Thread.new { run }
end
def stop
@done = true
end
end

93

Services

class MyService
end
def start
Thread.new { run }
end
def stop
@done = true
end
end

94

Services

class MyService
end
def start
Thread.new { run }
end
def stop
@done = true
end
end

95

Services

class MyService
end
def start
Thread.new { run }
end
def stop
@done = true
end
end

96

Services

class MyService
def run
until @done
@queue.publish(Time.now)
sleep(1)
end
end
end

97

Services

class MyService
def run
until @done
@queue.publish(Time.now)
sleep(1)
end
end
end

98

Services
app/services/evented_service.rb

class EventedService
@opts = opts
end
def start
Thread.new { EventMachine.run {...} }
end
def stop
EventMachine.stop
end
end

99

Clustering
less failure faster

100

out-of-the-box
• JBoss provides
• session replication
• load-balanced messaging
• mod_cluster provides
• session affinity
• intelligent load-balanced web
• failover
101

JBOSS_CONF
TorqueBox ships with two
JBoss server configurations:
default (not clustered) and all
(clustered). To enable
clustering...

$ export JBOSS_CONF=all

102

deploy and run

$ export JBOSS_CONF=all
$ jruby -S rake torquebox:deploy
$ jruby -S rake torquebox:run

103

mod_cluster
A reverse proxy implemented
as an Apache module with
JBoss awareness. Constantly
gathers load statistics and
deployment availability for
intelligent request distribution.

104

mod_cluster

• Dynamic configuration
• Server-side load factor calculation
• Fine-grained web app lifecycle
• AJP (Apache JServ Protocol) is
optional. HTTP[S] is also supported.

106

Future
coming soon

107

Future
• Performance benchmarking and
optimization
• Infinispan for ActiveSupport::Cache
and NoSQL persistence
• JBoss SSO, HASingleton, logging
• CDI injection of Java components into
Ruby
• More JavaEE bridged to Ruby where
it makes sense, e.g. BPM, Drools,
Transactions, etc.

108

Resources

• http://torquebox.org
• #torquebox on freenode
• https://github.com/torquebox
• http://twitter.com/torquebox
• http://projectodd.org

109

Thanks!
questions?

110

Crank Up Your Apps With TorqueBox

More Related Content

What's hot

Similar to Crank Up Your Apps With TorqueBox

Crank Up Your Apps With TorqueBox

Editor's Notes