tail-cf-plugin 0.0.8.pre

data/README.md

@@ -0,0 +1,49 @@
+# Tail-Cf-Plugin [![Build Status](https://travis-ci.org/cloudfoundry/tail-cf-plugin.png?branch=master)](https://travis-ci.org/cloudfoundry/tail-cf-plugin)
+
+Plugin to cf command to add streaming application logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tail-cf-plugin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tail-cf-plugin
+
+## Usage
+
+After installing you can run cf tail and see your application's logs stream to the console.
+
+## Contributing
+
+The Cloud Foundry team uses GitHub and accepts contributions via [pull request](https://help.github.com/articles/using-pull-requests)
+
+Follow these steps to make a contribution to any of our open source repositories:
+
+1. Complete our CLA Agreement for [individuals](http://www.cloudfoundry.org/individualcontribution.pdf) or [corporations](http://www.cloudfoundry.org/corpcontribution.pdf)
+1. Set your name and email
+
+    git config --global user.name "Firstname Lastname"
+    git config --global user.email "your_email@youremail.com"
+
+1. Fork the repo
+1. Make your changes on a topic branch, commit, and push to github and open a pull request.
+
+Once your commits are approved by Travis CI and reviewed by the core team, they will be merged.
+
+#### Checkout
+
+    git clone git@github.com:cloudfoundry/tail-cf-plugin.git
+    cd tail-cf-plugin/
+    bundle
+
+#### Running tests
+
+    rake
+

data/lib/tail-cf-plugin/loggregrator_client.rb

@@ -0,0 +1,35 @@
+module TailCfPlugin
+  class LoggregatorClient
+    def initialize(output)
+      @output = output
+    end
+
+    def listen(loggregator_host, space_id, app_id, user_token)
+      websocket_address = "ws://#{loggregator_host}/tail/spaces/#{space_id}"
+      websocket_address += "/apps/#{app_id}" if app_id
+
+      websocket_address += "?authorization=#{URI.encode(user_token)}"
+
+      EM.run {
+        ws = Faye::WebSocket::Client.new(websocket_address, nil, :headers => {"Origin" => "http://localhost"})
+
+        ws.on :message do |event|
+          received_message = LogMessage.decode(event.data.pack("C*"))
+          output.puts([received_message.app_id, received_message.source_id, received_message.message_type_name, received_message.message].join(" "))
+        end
+
+        ws.on :error do |event|
+          output.puts("Server error")
+        end
+
+        ws.on :close do |event|
+          output.puts("Server dropped connection")
+        end
+      }
+    end
+
+    private
+
+    attr_reader :output
+  end
+end

data/lib/tail-cf-plugin/plugin.rb

@@ -0,0 +1,29 @@
+require 'cf'
+require 'faye/websocket'
+require 'eventmachine'
+
+module TailCfPlugin
+  require 'tail-cf-plugin/loggregrator_client'
+  require 'log_message/log_message.pb'
+
+  class Plugin < CF::CLI
+    include LoginRequirements
+
+    desc "Tail a CF application's logs"
+    group :apps
+    input :loggregator_host, :argument => :required, :desc => "The ip:port of the loggregator"
+    input :app, :desc => "App to tail logs from", :argument => :optional, :from_given => by_name(:app)
+    input :space, :desc => "App to tail logs from", :argument => :optional, :from_given => by_name(:space)
+
+    def tail
+
+      raise "Missing an app or space" unless input[:app] || input[:space]
+
+      space_guid = (input[:space] && input[:space].guid) || input[:app].space_guid
+      app_guid = input[:app] && input[:app].guid
+
+      loggregrator_client = LoggregatorClient.new(STDOUT)
+      loggregrator_client.listen(input[:loggregator_host], space_guid, app_guid, client.token.auth_header)
+    end
+  end
+end

data/vendor/log_message/log_message.pb.rb

@@ -0,0 +1,30 @@
+## Generated from log_message.proto for logMessage
+require "beefcake"
+
+
+class LogMessage
+  include Beefcake::Message
+
+  module MessageType
+    OUT = 1
+    ERR = 2
+  end
+  module SourceType
+    CLOUD_CONTROLLER = 1
+    ROUTER = 2
+    UAA = 3
+    DEA = 4
+    WARDEN_CONTAINER = 5
+  end
+
+  required :message, :bytes, 1
+  required :message_type, LogMessage::MessageType, 2
+  required :timestamp, :sint64, 3
+  required :app_id, :string, 4
+  required :source_type, LogMessage::SourceType, 5
+  optional :source_id, :string, 6
+
+  def message_type_name
+    {MessageType::OUT => 'STDOUT', MessageType::ERR => 'STDERR'}[message_type]
+  end
+end

data/vendor/log_message/log_message.proto

@@ -0,0 +1,23 @@
+package logMessage;
+
+message LogMessage {
+    enum MessageType {
+        OUT = 1;
+        ERR = 2;
+    }
+
+    enum SourceType {
+        CLOUD_CONTROLLER = 1;
+        ROUTER = 2;
+        UAA = 3;
+        DEA = 4;
+        WARDEN_CONTAINER = 5;
+    }
+
+    required bytes message = 1;
+    required MessageType message_type = 2;
+    required sint64 timestamp = 3;
+    required string app_id = 4;
+    required SourceType source_type = 5;
+    optional string source_id = 6;
+}

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: tail-cf-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.8.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Pivotal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: beefcake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+description: CF command line tool to tail CF Application Logs
+email:
+- vcap-dev@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tail-cf-plugin/loggregrator_client.rb
+- lib/tail-cf-plugin/plugin.rb
+- vendor/log_message/log_message.pb.rb
+- vendor/log_message/log_message.proto
+- README.md
+homepage: http://github.com/cloudfoundry/tail-cf-plugin
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- vendor
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: CF Tail
+test_files: []