Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

in_monitor_agent: Add include_config parameter to remove config field from response #1317

Merged
merged 3 commits into from
Nov 21, 2016
Merged

in_monitor_agent: Add include_config parameter to remove config field from response #1317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1b7537
in_monitor_agent: config field is removed from response by default
repeatedly Nov 18, 2016
be7ffb2
Add include_config paramter to keep backward compatibility
repeatedly Nov 21, 2016
c46451b
Add assert_true for checking default include_config value
repeatedly Nov 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions lib/fluent/plugin/in_monitor_agent.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
require 'webrick'
require 'cgi'

require 'cool.io'

require 'fluent/config/types'
require 'fluent/plugin/input'
require 'fluent/plugin/output'
require 'fluent/plugin/multi_output'
Expand All @@ -35,6 +34,7 @@ class MonitorAgentInput < Input
config_param :port, :integer, default: 24220
config_param :tag, :string, default: nil
config_param :emit_interval, :time, default: 60
config_param :include_config, :bool, default: true

class MonitorServlet < WEBrick::HTTPServlet::AbstractServlet
def initialize(server, agent)
Expand Down Expand Up @@ -78,12 +78,16 @@ def build_object(req, res)

# if ?debug=1 is set, set :with_debug_info for get_monitor_info
# and :pretty_json for render_json_error
opts = {}
opts = {with_config: @agent.include_config}
if s = qs['debug'] and s[0]
opts[:with_debug_info] = true
opts[:pretty_json] = true
end

if with_config = get_search_parameter(qs, 'with_config'.freeze)
opts[:with_config] = Fluent::Config.bool_value(with_config)
end

if tag = get_search_parameter(qs, 'tag'.freeze)
# ?tag= to search an output plugin by match pattern
if obj = @agent.plugin_info_by_tag(tag, opts)
Expand Down Expand Up @@ -329,7 +333,7 @@ def get_monitor_info(pe, opts={})
obj['plugin_id'] = pe.plugin_id
obj['plugin_category'] = plugin_category(pe)
obj['type'] = pe.config['@type']
obj['config'] = pe.config if !opts.has_key?(:with_config) || opts[:with_config]
obj['config'] = pe.config if opts[:with_config]

# run MONITOR_INFO in plugins' instance context and store the info to obj
MONITOR_INFO.each_pair {|key,code|
Expand Down
100 changes: 65 additions & 35 deletions test/plugin/test_in_monitor_agent.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ def test_configure
assert_equal(24220, d.instance.port)
assert_equal(nil, d.instance.tag)
assert_equal(60, d.instance.emit_interval)
assert_true d.instance.include_config
end

sub_test_case "collect plugin information" do
Expand Down Expand Up @@ -90,48 +91,37 @@ def test_configure
assert_equal("output", d.instance.plugin_category(error_label.outputs.first))
end

test "get_monitor_info" do
data(:with_config_yes => true,
:with_config_no => false)
test "get_monitor_info" do |with_config|
d = create_driver
test_label = @ra.labels['@test']
error_label = @ra.labels['@ERROR']
input_info = {
"config" => {
"@id" => "test_in",
"@type" => "test_in"
},
"output_plugin" => false,
"plugin_category"=> "input",
"plugin_id" => "test_in",
"retry_count" => nil,
"type" => "test_in"
}
input_info.merge!("config" => {"@id" => "test_in", "@type" => "test_in"}) if with_config
filter_info = {
"config" => {
"@id" => "test_filter",
"@type" => "test_filter"
},
"output_plugin" => false,
"plugin_category" => "filter",
"plugin_id" => "test_filter",
"retry_count" => nil,
"type" => "test_filter"
}
filter_info.merge!("config" => {"@id" => "test_filter", "@type" => "test_filter"}) if with_config
output_info = {
"config" => {
"@id" => "test_out",
"@type" => "test_out"
},
"output_plugin" => true,
"plugin_category" => "output",
"plugin_id" => "test_out",
"retry_count" => 0,
"type" => "test_out"
}
output_info.merge!("config" => {"@id" => "test_out", "@type" => "test_out"}) if with_config
error_label_info = {
"config" => {
"@id"=>"null",
"@type" => "null"
},
"buffer_queue_length" => 0,
"buffer_total_queued_size" => 0,
"output_plugin" => true,
Expand All @@ -140,10 +130,12 @@ def test_configure
"retry_count" => 0,
"type" => "null"
}
assert_equal(input_info, d.instance.get_monitor_info(@ra.inputs.first))
assert_equal(filter_info, d.instance.get_monitor_info(@ra.filters.first))
assert_equal(output_info, d.instance.get_monitor_info(test_label.outputs.first))
assert_equal(error_label_info, d.instance.get_monitor_info(error_label.outputs.first))
error_label_info.merge!("config" => {"@id"=>"null", "@type" => "null"}) if with_config
opts = {with_config: with_config}
assert_equal(input_info, d.instance.get_monitor_info(@ra.inputs.first, opts))
assert_equal(filter_info, d.instance.get_monitor_info(@ra.filters.first, opts))
assert_equal(output_info, d.instance.get_monitor_info(test_label.outputs.first, opts))
assert_equal(error_label_info, d.instance.get_monitor_info(error_label.outputs.first, opts))
end

test "fluentd opts" do
Expand Down Expand Up @@ -207,7 +199,7 @@ def test_configure

def get(uri, header = {})
url = URI.parse(uri)
req = Net::HTTP::Get.new(url.path, header)
req = Net::HTTP::Get.new(url, header)
unless header.has_key?('Content-Type')
header['Content-Type'] = 'application/octet-stream'
end
Expand Down Expand Up @@ -258,6 +250,8 @@ def get(uri, header = {})
@ra = Fluent::RootAgent.new(log: $log)
stub(Fluent::Engine).root_agent { @ra }
@ra = configure_ra(@ra, conf)
# store Supervisor instance to avoid collected by GC
@supervisor = Fluent::Supervisor.new(Fluent::Supervisor.default_options)
end

test "/api/plugins" do
Expand All @@ -280,43 +274,79 @@ def get(uri, header = {})
assert_equal(expected_test_filter_response, test_filter)
end

test "/api/plugins.json" do
data(:include_config_yes => [true, "include_config yes"],
:include_config_no => [false, "include_config no"])
test "/api/plugins.json" do |(with_config, include_conf)|

d = create_driver("
@type monitor_agent
bind '127.0.0.1'
port #{@port}
tag monitor
#{include_conf}
")
d.instance.start
expected_test_in_response =
{"config" => {
"@id" => "test_in",
"@type" => "test_in"
},
expected_test_in_response = {
"output_plugin" => false,
"plugin_category" => "input",
"plugin_id" => "test_in",
"retry_count" => nil,
"type" => "test_in"}
expected_null_response =
{"config" => {
"@id" => "null",
"@type" => "null"
},
"type" => "test_in"
}
expected_test_in_response.merge!("config" => {"@id" => "test_in", "@type" => "test_in"}) if with_config
expected_null_response = {
"buffer_queue_length" => 0,
"buffer_total_queued_size" => 0,
"output_plugin" => true,
"plugin_category" => "output",
"plugin_id" => "null",
"retry_count" => 0,
"type" => "null"}
"type" => "null"
}
expected_null_response.merge!("config" => {"@id" => "null", "@type" => "null"}) if with_config
response = JSON.parse(get("http://127.0.0.1:#{@port}/api/plugins.json"))
test_in_response = response["plugins"][0]
null_response = response["plugins"][5]
assert_equal(expected_test_in_response, test_in_response)
assert_equal(expected_null_response, null_response)
end

data(:with_config_yes => [true, "?with_config=yes"],
:with_config_no => [false, "?with_config=no"])
test "/api/plugins.json with query parameter. query parameter is preferred than include_config" do |(with_config, query_param)|

d = create_driver("
@type monitor_agent
bind '127.0.0.1'
port #{@port}
tag monitor
")
d.instance.start
expected_test_in_response = {
"output_plugin" => false,
"plugin_category" => "input",
"plugin_id" => "test_in",
"retry_count" => nil,
"type" => "test_in"
}
expected_test_in_response.merge!("config" => {"@id" => "test_in", "@type" => "test_in"}) if with_config
expected_null_response = {
"buffer_queue_length" => 0,
"buffer_total_queued_size" => 0,
"output_plugin" => true,
"plugin_category" => "output",
"plugin_id" => "null",
"retry_count" => 0,
"type" => "null"
}
expected_null_response.merge!("config" => {"@id" => "null", "@type" => "null"}) if with_config
response = JSON.parse(get("http://127.0.0.1:#{@port}/api/plugins.json#{query_param}"))
test_in_response = response["plugins"][0]
null_response = response["plugins"][5]
assert_equal(expected_test_in_response, test_in_response)
assert_equal(expected_null_response, null_response)
end

test "/api/config" do
d = create_driver("
@type monitor_agent
Expand Down