logs-cf-plugin 0.0.23.pre

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTI0ZDYyMGIwNjE4YTMwZjhmYWFlMDNmOTg5NmFmZGMyM2E0MjhkYQ==
+  data.tar.gz: !binary |-
+    NGI4NDQxYTUxYmM3Njc3MTBkZDVmNGI2YzM2NGY3NDYwZjY2ZTMzNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmYwNjE5NWE0MjRhMzBjZDBlYmVkM2FiZjg5OGMwYzZiNDE4ZjUxODQ1YTU0
+    NDBlZTNhM2RmNWMxYWRkZTBkZjU0YTllMTI5NTkzODc4YTY2ZjYyMTUzOGFm
+    YWQ0MTFjMmQyZjhhOGE4ZGRlMjE2OWQ0NWViMGY4MjYzNGZlMzE=
+  data.tar.gz: !binary |-
+    MmUyMWRkNDc5ZTFhMGRiMDM5NmI1M2EzMDE4ZWMzZDc3NGYyZjc5MTJkMDkw
+    NzdiNDgzNjU5NmYxYzI2OTk0MmQ4N2M3NTEyMDIyZTgyNWExMjUyMmFkZDQx
+    ZWM5NGI2MTZjY2E1NmY2Mjg4ZjVhZDJiZWFkOGVmZDZmNGYxYmY=

data/README.md

@@ -0,0 +1,49 @@
+# Logs-Cf-Plugin [![Build Status](https://travis-ci.org/cloudfoundry/logs-cf-plugin.png?branch=master)](https://travis-ci.org/cloudfoundry/logs-cf-plugin)
+
+Plugin to cf command to add streaming application logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logs-cf-plugin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logs-cf-plugin
+
+## Usage
+
+After installing you can run cf logs 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/logs-cf-plugin.git
+    cd logs-cf-plugin/
+    bundle
+
+#### Running tests
+
+    rake
+

data/lib/logs-cf-plugin/log_target.rb

@@ -0,0 +1,46 @@
+module LogsCfPlugin
+  class LogTarget
+    def initialize(target_organization, target_space, ids)
+      raise ArgumentError, "Requires 3 ids" unless ids.size == 3
+      @target_organization = target_organization
+      @target_space = target_space
+
+      @org_id = ids[0]
+      @space_id = ids[1]
+      @app_id = ids[2]
+    end
+
+    def ambiguous?
+      @target_organization && @target_space
+    end
+
+    def valid?
+      !!target
+    end
+
+    def query_params
+      case target
+        when :org
+          {org: @org_id}
+        when :space
+          {org: @org_id, space: @space_id}
+        when :app
+          {org: @org_id, space: @space_id, app: @app_id}
+      end
+    end
+
+    private
+
+    def target
+      return nil if ambiguous?
+      case
+        when @target_organization
+          :org
+        when @target_space
+          :space
+        when @app_id
+          :app
+      end
+    end
+  end
+end

data/lib/logs-cf-plugin/loggregator_client.rb

@@ -0,0 +1,116 @@
+require 'log_message/log_message.pb'
+require 'faye/websocket'
+require 'eventmachine'
+require 'uri'
+
+module LogsCfPlugin
+  class LoggregatorClient
+    include CFoundry::TraceHelpers
+
+    def initialize(loggregator_host, user_token, output, trace)
+      @output = output
+      @loggregator_host = loggregator_host
+      @user_token = user_token
+      @trace = trace
+    end
+
+    def listen(query_params)
+      websocket_address = "wss://#{loggregator_host}:4443/tail/?#{hash_to_query(query_params)}"
+      output.puts "websocket_address: #{websocket_address}" if trace
+
+      EM.run {
+        ws = Faye::WebSocket::Client.new(websocket_address, nil, :headers => {"Origin" => "http://localhost", "Authorization" => user_token})
+
+        ws.on :open do |event|
+          output.puts("Connected to server.")
+          EventMachine.add_periodic_timer(keep_alive_interval) do
+            ws.send([42])
+          end
+        end
+
+        ws.on :message do |event|
+          received_message = LogMessage.decode(event.data.pack("C*"))
+          MessageWriter.write(output, received_message)
+        end
+
+        ws.on :error do |event|
+          output.puts("Server error")
+          output.puts(event.data.inspect) if trace
+        end
+
+        ws.on :close do |event|
+          ws.close
+          output.puts("Server dropped connection...goodbye.")
+          EM.stop
+          ws = nil
+        end
+      }
+    end
+
+    def dump_messages(query_params)
+      uri = URI.parse("https://#{loggregator_host}/dump/?#{hash_to_query(query_params)}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request['Authorization'] = user_token
+
+      if trace
+        request_hash = {
+            :url => uri.request_uri,
+            :method => "GET",
+            :headers => sane_headers(request),
+            :body => ""
+        }
+        output.puts(request_trace(request_hash))
+      end
+
+      response = http.request(request)
+
+      return [] unless response.code == "200"
+
+      response_bytes = StringIO.new(response.body)
+      messages = []
+      while len = response_bytes.read(4)
+        len = len.unpack("N")[0] # 32-bit length, BigEndian stylie
+        record = response_bytes.read(len) # This returns a string even if len is 0.
+        msg = LogMessage.decode(record)
+        messages << msg
+      end
+
+      if trace
+        response_hash = {
+            :headers => sane_headers(response),
+            :status => response.code,
+            :body => messages
+        }
+        output.puts(response_trace(response_hash))
+      end
+
+      messages
+    end
+
+    private
+
+    def sane_headers(obj)
+      hds = {}
+
+      obj.each_header do |k, v|
+        hds[k] = v
+      end
+
+      hds
+    end
+
+    def keep_alive_interval
+      25
+    end
+
+    def hash_to_query(hash)
+      return URI.encode(hash.map { |k, v| "#{k}=#{v}" }.join("&"))
+    end
+
+    attr_reader :output, :loggregator_host, :user_token, :trace
+  end
+end

data/lib/logs-cf-plugin/message_writer.rb

@@ -0,0 +1,5 @@
+module MessageWriter
+  def self.write(output, message)
+    output.puts([message.app_id, message.source_id, message.message_type_name, message.message].join(" "))
+  end
+end

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

@@ -0,0 +1,54 @@
+require 'cf'
+
+module LogsCfPlugin
+  require 'logs-cf-plugin/loggregator_client'
+  require 'logs-cf-plugin/log_target'
+  require 'logs-cf-plugin/message_writer'
+
+  class Plugin < CF::CLI
+    include LoginRequirements
+
+    desc "Tail or dump logs for CF applications or spaces"
+    group :apps
+    input :app, :desc => "App to tail logs from", :argument => :optional, :from_given => by_name(:app)
+    input :space, :type => :boolean, :desc => "Logs of all apps in the current space", :default => false
+    input :org, :type => :boolean, :desc => "Logs of all apps and spaces in the current organization", :default => false
+    input :recent, :type => :boolean, :desc => "Dump recent logs instead of tailing", :default => false
+
+    def logs
+      guids = [client.current_organization.guid, client.current_space.guid, input[:app].try(:guid)]
+
+      log_target = LogTarget.new(input[:org], input[:space], guids)
+
+      if log_target.ambiguous?
+        Mothership::Help.command_help(@@commands[:logs])
+        fail "Please provide either --space or --org, but not both."
+      end
+
+      unless log_target.valid?
+        Mothership::Help.command_help(@@commands[:logs])
+        fail "Please provide an application to log."
+      end
+
+      loggregator_client = LoggregatorClient.new(loggregator_host, client.token.auth_header, STDOUT, input[:trace])
+
+      if input[:recent]
+        loggregator_client.dump_messages(log_target.query_params).each do |m|
+          MessageWriter.write(STDOUT, m)
+        end
+
+      else
+        loggregator_client.listen(log_target.query_params)
+      end
+    end
+
+    ::ManifestsPlugin.default_to_app_from_manifest(:logs, false)
+
+    private
+
+    def loggregator_host
+      target_base = client.target.sub(/^https?:\/\/([^\.]+\.)?(.+)\/?/, '\2')
+      "loggregator.#{target_base}"
+    end
+  end
+end

data/vendor/log_message/log_message.pb.rb

@@ -0,0 +1,32 @@
+## 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
+  optional :space_id, :string, 7
+  required :organization_id, :string, 8
+
+  def message_type_name
+    {MessageType::OUT => 'STDOUT', MessageType::ERR => 'STDERR'}[message_type]
+  end
+end

data/vendor/log_message/log_message.proto

@@ -0,0 +1,25 @@
+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;
+    optional string space_id = 7;
+    required string organization_id = 8;
+}

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: logs-cf-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.23.pre
+platform: ruby
+authors:
+- Pivotal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: beefcake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+description: CF command line tool to retrieve recent and tail CF Application Logs
+email:
+- vcap-dev@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/logs-cf-plugin/log_target.rb
+- lib/logs-cf-plugin/loggregator_client.rb
+- lib/logs-cf-plugin/message_writer.rb
+- lib/logs-cf-plugin/plugin.rb
+- vendor/log_message/log_message.pb.rb
+- vendor/log_message/log_message.proto
+- README.md
+homepage: http://github.com/cloudfoundry/logs-cf-plugin
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- vendor
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: CF Logs
+test_files: []