Search code examples
rubysinatraunicorn

Stream console output through HTTP (with Ruby)


I am trying to run some commands remotely and SSH'ing in to the machine is not an option. What I am trying to do is setup a Sinatra app that runs some specific commands and streams the output through HTTP.

The sample action looks like this:

get "/log" do
  `tail -f some.log`
end

1 As far as I've read, I need to use Unicorn (or Mongrel) because Thin does not support streaming data 2 I think I need to pipe the commands output through some kind of IO ruby object

I almost know how to do (1) but have no idea how to achieve (2).


Solution

  • If you're on a synchronous server (i.e. Mongrel, Unicorn, not Thin), you can just return an IO object:

    require 'sinatra'
    
    get '/log' do
      content_type :txt
      IO.popen('tail -f some.log')
    end
    

    If that doesn't work (if you're on Thin, for instance), you can use the new streaming API:

    require 'sinatra'
    
    get '/log' do
      content_type :txt
      IO.popen('tail -f some.log') do |io|
        stream do |out|
          io.each { |s| out << s }
        end
      end
    end
    

    You can also use the bcat gem, which will colorize your output, if it contains ANSI color codes:

    require 'sinatra'
    require 'bcat'
    
    get '/log' do
      command = %[tail -f some.log]
      bcat = Bcat.new(command, :command => true)
      bcat.to_app.call(env)
    end
    

    Note: For infinitely running process you'll have to take care of killing the process yourself if someone closes the connection. With the first solution some servers might take care of that for you.