fluentd-ui 0.1.0

data/app/controllers/welcome_controller.rb

@@ -0,0 +1,5 @@
+class WelcomeController < ApplicationController
+  def home
+    redirect_to daemon_path
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+module ApplicationHelper
+  def has_td_agent_system?
+    File.exist?("/etc/init.d/td-agent")
+  end
+
+  def fluentd_ui_logo
+    image_tag(ENV["FLUENTD_UI_LOGO"] || "/fluentd-logo-right-text.png")
+  end
+
+  def language_name(locale)
+    # NOTE: these are fixed terms, not i18n-ed
+    {
+      en: "English",
+      ja: "日本語",
+    }[locale] || locale
+  end
+
+  def language_menu
+    html = ""
+    I18n.available_locales.each do |locale|
+      text = (locale == current_locale ? icon("fa-check") : "")
+      text << language_name(locale)
+      html << %Q|<li>#{link_to text , "?lang=#{locale}"}</li>|
+    end
+    raw html
+  end
+
+  def link_to_other(text, path)
+    if current_page?(path)
+      # NOTE: sb-admin set style for element name instead of class name, such as ".nav a". So use "a" element even if it isn't a link.
+      content_tag(:a, text, class: "current")
+    else
+      link_to text, path
+    end
+  end
+
+  def icon(classes, inner=nil)
+    %Q!<i class="fa #{classes}">#{inner}</i> !.html_safe
+  end
+
+  def page_title(title, &block)
+    content_for(:page_title) do
+      title
+    end
+    page_head(title, &block) unless content_for?(:page_head)
+  end
+
+  def page_head(head, &block)
+    content_for(:page_head) do
+      head.html_safe + block.try(:call).to_s
+    end
+  end
+end

data/app/helpers/fluentd/settings_helper.rb

@@ -0,0 +1,2 @@
+module Fluentd::SettingsHelper
+end

data/app/helpers/miscs_helper.rb

@@ -0,0 +1,2 @@
+module MiscsHelper
+end

data/app/helpers/settings_helper.rb

@@ -0,0 +1,43 @@
+module SettingsHelper
+  def field(form, key, opts = {})
+    html = '<div class="form-group">'
+
+    case form.object.column_type(key)
+    when :hidden
+      return form.hidden_field(key)
+    when :boolean, :flag
+      html << form.check_box(key, {}, "true", "false")
+      html << " " # NOTE: Adding space for padding
+      html << h(form.label(key))
+    when :choice
+      html << h(form.label(key))
+      html << " " # NOTE: Adding space for padding
+      html << form.select(key, form.object.values_of(key), opts)
+    when :nested
+      child_data = form.object.class.children[key]
+      klass = child_data[:class]
+      options = child_data[:options]
+      children = form.object.send(key) || {"0" => {}}
+      children.each_pair do |index, child|
+        html << %Q!<div class="js-nested-column #{options[:multiple] ? "js-multiple" : ""} well well-sm">!
+        if options[:multiple]
+          html << %Q!<a class="btn btn-xs btn-default js-append">#{icon('fa-plus')}</a> !
+          html << %Q!<a class="btn btn-xs btn-default js-remove" style="display:none">#{icon('fa-minus')}</a> !
+        end
+        html << h(form.label(key))
+        form.fields_for("#{key}[#{index}]", klass.new(child)) do |ff|
+          klass::KEYS.each do |k|
+            html << field(ff, k)
+          end
+        end
+        html << "</div>"
+      end
+    else
+      html << h(form.label(key))
+      html << form.text_field(key, class: "form-control")
+    end
+
+    html << "</div>"
+    html.html_safe
+  end
+end

data/app/models/fluentd.rb

@@ -0,0 +1,178 @@
+class Fluentd
+  include ActiveModel::Model
+  include ActiveModel::Validations::Callbacks
+
+  validates :variant, inclusion: { in: proc { Fluentd.variants } }
+  validates :log_file, presence: true
+  validates :pid_file, presence: true
+  validates :config_file, presence: true
+  validate :validate_permissions
+
+  before_validation :expand_paths
+
+  COLUMNS = [:id, :variant, :log_file, :pid_file, :config_file]
+  DEFAULT_CONF = <<-CONF.strip_heredoc
+    <source>
+      # http://docs.fluentd.org/articles/in_forward
+      type forward
+      port 24224
+    </source>
+
+    <source>
+      # http://docs.fluentd.org/articles/in_http
+      type http
+      port 9880
+    </source>
+
+    <source>
+      type monitor_agent
+      port 24220
+    </source>
+    <source>
+      type debug_agent
+      port 24230
+    </source>
+
+    <match debug.*>
+      # http://docs.fluentd.org/articles/out_stdout
+      type stdout
+    </match>
+  CONF
+
+  attr_accessor(*COLUMNS)
+
+  def self.variants
+    %w(fluentd_gem td-agent)
+  end
+
+  def self.json_path
+    if ENV["FLUENTD_UI_DATA_DIR"].present?
+      dir = ENV["FLUENTD_UI_DATA_DIR"]
+    else
+      dir = ENV["HOME"] + "/.fluentd-ui/core_data"
+    end
+    FileUtils.mkdir_p(dir)
+    dir + "/#{Rails.env}-fluentd.json"
+  end
+
+  def fluentd?
+    variant == "fluentd_gem"
+  end
+  alias :fluentd_gem? :fluentd?
+
+  def td_agent?
+    variant == "td-agent"
+  end
+
+  def agent
+    klass = variant.underscore.camelize
+    Agent.const_get(klass).new({
+      :pid_file => pid_file,
+      :log_file => log_file,
+      :config_file => config_file,
+    })
+  end
+
+  def load_settings_from_agent_default
+    agent.class.default_options.each_pair do |key, value|
+      send("#{key}=", value)
+    end
+  end
+
+  def api
+    Api::Http.new(api_endpoint)
+  end
+
+  def api_endpoint
+    # TODO: autodetect from parsed configuration, but unused for now
+  end
+
+  def label
+    "fluentd" # NOTE: for multiple fluentd management, but only single fluentd manage now
+  end
+
+  def expand_paths
+    %w(pid_file log_file config_file).each do |column|
+      path = send(column)
+      next if path.blank?
+      self.send("#{column}=", File.expand_path(path))
+    end
+  end
+
+  def validate_permissions
+    %w(pid_file log_file config_file).each do |column|
+      check_permission(column)
+    end
+  end
+
+  def check_permission(column)
+    path = send(column)
+    return if path.blank? # if empty, presence: true will catch it
+
+    begin
+      FileUtils.mkdir_p(File.dirname(path))
+    rescue Errno::EACCES
+      errors.add(column, :lack_write_permission)
+      return
+    end
+
+    if File.exist?(path)
+      if File.directory?(path)
+        errors.add(column, :is_a_directory)
+      end
+
+      unless File.writable?(path)
+        errors.add(column, :lack_write_permission)
+      end
+      unless File.readable?(path)
+        errors.add(column, :lack_read_permission)
+      end
+    else
+      unless File.writable?(File.dirname(path))
+        errors.add(column, :lack_write_permission)
+      end
+    end
+  end
+
+  def ensure_default_config_file
+    return true if File.size?(config_file)
+
+    File.open(config_file, "w") do |f|
+      f.write DEFAULT_CONF
+    end
+  end
+
+
+  # ActiveRecord mimic
+
+  def self.instance
+    return unless exists?
+    attr = JSON.parse(File.read(json_path))
+    Fluentd.new(attr)
+  end
+
+  def self.exists?
+    File.exists?(json_path)
+  end
+
+  def update_attributes(params)
+    params.each_pair do |k, v|
+      send("#{k}=", v)
+    end
+  end
+
+  def save
+    return false unless valid?
+    json = COLUMNS.inject({}) do |result, col|
+      result[col] = send(col)
+      result
+    end.to_json
+    File.open(self.class.json_path, "w") do |f|
+      f.write json
+    end && ensure_default_config_file
+  end
+
+  def destroy
+    File.unlink(self.class.json_path)
+  end
+end

data/app/models/fluentd/agent.rb

@@ -0,0 +1,28 @@
+require 'fluent/log'
+require 'fluent/env'
+require 'fluent/version'
+require 'fluent/supervisor'
+require "fluentd/agent/common"
+require "fluentd/agent/fluentd_gem"
+require "fluentd/agent/td_agent"
+require "fluentd/agent/remote"
+
+class Fluentd
+  class Agent
+    # pidfile
+    #   td-agent: /var/run/td-agent/td-agent.pid
+    #   - https://github.com/treasure-data/td-agent/blob/master/td-agent.logrotate#L10
+    #   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.init#L25
+    #   fluentd:  nothing (or --daemon PIDFILE)
+    #
+    # logfile
+    #   td-agent: /var/log/td-agent/td-agent.log
+    #   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.init#L28
+    #   fluentd: stdout (or --log LOGFILE)
+    #
+    # config file
+    #   td-agent: /etc/td-agent/td-agent.conf
+    #   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.postinst#L69
+    #   fluentd: /etc/fluent/fluent.conf (by fluentd -s)
+  end
+end

data/app/models/fluentd/agent/common.rb

@@ -0,0 +1,76 @@
+# pidfile
+#   td-agent: /var/run/td-agent/td-agent.pid
+#   - https://github.com/treasure-data/td-agent/blob/master/td-agent.logrotate#L10
+#   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.init#L25
+#   fluentd:  nothing (or --daemon PIDFILE)
+#
+# logfile
+#   td-agent: /var/log/td-agent/td-agent.log
+#   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.init#L28
+#   fluentd: stdout (or --log LOGFILE)
+#
+# config file
+#   td-agent: /etc/td-agent/td-agent.conf
+#   - https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.postinst#L69
+#   fluentd: /etc/fluent/fluent.conf (by fluentd -s)
+
+class Fluentd
+  class Agent
+    module Common
+      attr_reader :extra_options
+
+      def initialize(options = {})
+        @extra_options = options
+      end
+
+      def wait_process_starting_seconds
+        10.seconds # wait time for fluentd pidfile created
+      end
+
+      def errors_since(since = 1.day.ago)
+        errors = []
+        logged_errors do |error|
+          break if Time.parse(error[:subject]) < since
+          errors << error
+        end
+        errors
+      end
+
+      def recent_errors(limit = 3)
+        errors = []
+        logged_errors do |error|
+          errors << error
+          break if errors.length >= limit
+        end
+        errors
+      end
+
+      def pid_file
+        extra_options[:pid_file] || self.class.default_options[:pid_file]
+      end
+
+      def log_file
+        extra_options[:log_file] || self.class.default_options[:log_file]
+      end
+
+      def config_file
+        extra_options[:config_file] || self.class.default_options[:config_file]
+      end
+
+
+      # define these methods on each Agent class
+
+      %w(start stop restart).each do |method|
+        define_method(method) do
+          raise NotImplementedError, "'#{method}' method is required to be defined"
+        end
+      end
+
+      %w(running? version log config config_write config_append log_tail configuration).each do |method|
+        define_method(method) do
+          raise NotImplementedError, "'#{method}' method is required to be defined"
+        end
+      end
+    end
+  end
+end

data/app/models/fluentd/agent/configuration.rb

@@ -0,0 +1,35 @@
+require "fluent/config/v1_parser"
+
+class Fluentd
+  class Agent
+    class Configuration
+      include Enumerable
+
+      attr_reader :file
+
+      def initialize(config_file)
+        @file = config_file
+      end
+
+      def config
+        @config ||= ::Fluent::Config::V1Parser.parse(File.read(file), File.basename(file), File.dirname(file))
+      end
+
+      def to_s
+        config.to_s.gsub(/\A<ROOT>\n/, "").gsub(/<\/ROOT>\n\z/, "").gsub(/^ {2}/, "")
+      end
+
+      def each(&block)
+        config.each_element(&block)
+      end
+
+      def sources
+        find_all{|e| e.name == "source"}
+      end
+
+      def matches
+        find_all{|e| e.name == "match"}
+      end
+    end
+  end
+end

data/app/models/fluentd/agent/fluentd_gem.rb

@@ -0,0 +1,104 @@
+class Fluentd
+  class Agent
+    class FluentdGem
+      include Common
+      include LocalCommon
+
+      def self.default_options
+        {
+          :pid_file    => "#{ENV["HOME"]}/.fluentd-ui/fluent.pid",
+          :log_file    => "#{ENV["HOME"]}/.fluentd-ui/fluent.log",
+          :config_file => "#{ENV["HOME"]}/.fluentd-ui/fluent.conf",
+        }
+      end
+
+      # return value is status_after_this_method_called == started
+      def start
+        return true if running?
+        actual_start
+      end
+
+      # return value is status_after_this_method_called == stopped
+      def stop
+        return true unless running?
+        actual_stop
+      end
+
+      # return value is status_after_this_method_called == started
+      def restart
+        if running?
+          validate_fluentd_options && stop && start
+        else
+          # NOTE: no path to here from browser operations for now
+          start
+        end
+      end
+
+      def reload # NOTE: does not used currently, and td-agent has no reload command
+        return false unless running?
+        actual_reload
+      end
+
+      def version
+        Bundler.with_clean_env do
+          `fluentd --version`.strip
+        end
+      end
+
+      private
+
+      def options_to_argv
+        argv = ""
+        argv << " --use-v1-config"
+        argv << " -c #{config_file}"
+        argv << " -d #{pid_file}"
+        argv << " -o #{log_file}"
+        argv
+      end
+
+      def validate_fluentd_options
+        Bundler.with_clean_env do
+          system("fluentd --dry-run #{options_to_argv}")
+        end
+      end
+
+      def actual_start
+        return unless validate_fluentd_options
+        Bundler.with_clean_env do
+          spawn("fluentd #{options_to_argv}")
+        end
+        wait_starting
+      end
+
+      def actual_stop
+        if Process.kill(:TERM, pid)
+          File.unlink(pid_file)
+          true
+        end
+      end
+
+      def actual_reload
+        Process.kill(:HUP, pid)
+      end
+
+      def wait_starting
+        begin
+          timeout(wait_process_starting_seconds) do
+            loop do
+              break if pid && Process.kill(0, pid)
+              sleep 0.01
+            end
+          end
+          true
+        rescue Errno::ESRCH
+          # successful to create pidfile, but process not exists.
+          # any error occured at booting process that after create pidfile. such as readling config, loading plugins, etc
+          # https://github.com/fluent/fluentd/blob/master/lib/fluent/supervisor.rb#L106
+          false
+        rescue TimeoutError
+          false
+        end
+      end
+    end
+  end
+end