Class: LogStash::Settings
Constant Summary
collapse
- PIPELINE_SETTINGS_WHITE_LIST =
there are settings that the pipeline uses and can be changed per pipeline instance
[
"config.debug",
"config.support_escapes",
"config.reload.automatic",
"config.reload.interval",
"config.string",
"dead_letter_queue.enable",
"dead_letter_queue.max_bytes",
"metric.collect",
"pipeline.java_execution",
"pipeline.plugin_classloaders",
"path.config",
"path.dead_letter_queue",
"path.queue",
"pipeline.batch.delay",
"pipeline.batch.size",
"pipeline.id",
"pipeline.reloadable",
"pipeline.system",
"pipeline.workers",
"queue.checkpoint.acks",
"queue.checkpoint.interval",
"queue.checkpoint.writes",
"queue.checkpoint.retry",
"queue.drain",
"queue.max_bytes",
"queue.max_events",
"queue.page_capacity",
"queue.type",
]
Util::SubstitutionVariables::SUBSTITUTION_PLACEHOLDER_REGEX
Instance Method Summary
collapse
#deep_replace, #replace_placeholders
Constructor Details
Returns a new instance of Settings.
46
47
48
49
50
51
52
53
|
# File 'lib/logstash/settings.rb', line 46
def initialize
@settings = {}
@transient_settings = {}
end
|
Instance Method Details
#==(other) ⇒ Object
186
187
188
189
|
# File 'lib/logstash/settings.rb', line 186
def ==(other)
return false unless other.kind_of?(::LogStash::Settings)
self.to_hash == other.to_hash
end
|
#clone ⇒ Object
Also known as:
dup
87
88
89
|
# File 'lib/logstash/settings.rb', line 87
def clone
get_subset(".*")
end
|
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
# File 'lib/logstash/settings.rb', line 134
def format_settings
output = []
output << "-------- Logstash Settings (* means modified) ---------"
@settings.each do |setting_name, setting|
value = setting.value
default_value = setting.default
if default_value == value output << "#{setting_name}: #{value.inspect}" unless value.nil?
elsif default_value.nil? output << "*#{setting_name}: #{value.inspect}"
elsif value.nil? output << "#{setting_name}: #{default_value.inspect}"
else output << "*#{setting_name}: #{value.inspect} (default: #{default_value.inspect})"
end
end
output << "--------------- Logstash Settings -------------------"
output
end
|
#from_yaml(yaml_path, file_name = "logstash.yml") ⇒ Object
158
159
160
161
162
|
# File 'lib/logstash/settings.rb', line 158
def from_yaml(yaml_path, file_name="logstash.yml")
settings = read_yaml(::File.join(yaml_path, file_name))
self.merge(deep_replace(flatten_hash(settings)), true)
self
end
|
#get_default(setting_name) ⇒ Object
92
93
94
|
# File 'lib/logstash/settings.rb', line 92
def get_default(setting_name)
get_setting(setting_name).default
end
|
#get_setting(setting_name) ⇒ Object
67
68
69
70
71
|
# File 'lib/logstash/settings.rb', line 67
def get_setting(setting_name)
setting = @settings[setting_name]
raise ArgumentError.new("Setting \"#{setting_name}\" hasn't been registered") if setting.nil?
setting
end
|
#get_subset(setting_regexp) ⇒ Object
73
74
75
76
77
78
79
80
81
|
# File 'lib/logstash/settings.rb', line 73
def get_subset(setting_regexp)
regexp = setting_regexp.is_a?(Regexp) ? setting_regexp : Regexp.new(setting_regexp)
settings = self.class.new
@settings.each do |setting_name, setting|
next unless setting_name.match(regexp)
settings.register(setting.clone)
end
settings
end
|
#get_value(setting_name) ⇒ Object
Also known as:
get
96
97
98
|
# File 'lib/logstash/settings.rb', line 96
def get_value(setting_name)
get_setting(setting_name).value
end
|
#merge(hash, graceful = false) ⇒ Object
120
121
122
123
|
# File 'lib/logstash/settings.rb', line 120
def merge(hash, graceful = false)
hash.each {|key, value| set_value(key, value, graceful) }
self
end
|
#merge_pipeline_settings(hash, graceful = false) ⇒ Object
125
126
127
128
129
130
131
132
|
# File 'lib/logstash/settings.rb', line 125
def merge_pipeline_settings(hash, graceful = false)
hash.each do |key, _|
unless PIPELINE_SETTINGS_WHITE_LIST.include?(key)
raise ArgumentError.new("Only pipeline related settings are expected. Received \"#{key}\". Allowed settings: #{PIPELINE_SETTINGS_WHITE_LIST}")
end
end
merge(hash, graceful)
end
|
#on_post_process(&block) ⇒ Object
172
173
174
175
|
# File 'lib/logstash/settings.rb', line 172
def on_post_process(&block)
@post_process_callbacks ||= []
@post_process_callbacks << block
end
|
#post_process ⇒ Object
164
165
166
167
168
169
170
|
# File 'lib/logstash/settings.rb', line 164
def post_process
if @post_process_callbacks
@post_process_callbacks.each do |callback|
callback.call(self)
end
end
end
|
#register(setting) ⇒ Object
55
56
57
58
59
60
61
|
# File 'lib/logstash/settings.rb', line 55
def register(setting)
if @settings.key?(setting.name)
raise ArgumentError.new("Setting \"#{setting.name}\" has already been registered as #{setting.inspect}")
else
@settings[setting.name] = setting
end
end
|
#registered?(setting_name) ⇒ Boolean
63
64
65
|
# File 'lib/logstash/settings.rb', line 63
def registered?(setting_name)
@settings.key?(setting_name)
end
|
#reset ⇒ Object
154
155
156
|
# File 'lib/logstash/settings.rb', line 154
def reset
@settings.values.each(&:reset)
end
|
#set?(setting_name) ⇒ Boolean
83
84
85
|
# File 'lib/logstash/settings.rb', line 83
def set?(setting_name)
get_setting(setting_name).set?
end
|
#set_value(setting_name, value, graceful = false) ⇒ Object
Also known as:
set
101
102
103
104
105
106
107
108
109
|
# File 'lib/logstash/settings.rb', line 101
def set_value(setting_name, value, graceful = false)
get_setting(setting_name).set(value)
rescue ArgumentError => e
if graceful
@transient_settings[setting_name] = value
else
raise e
end
end
|
#to_hash ⇒ Object
112
113
114
115
116
117
118
|
# File 'lib/logstash/settings.rb', line 112
def to_hash
hash = {}
@settings.each do |name, setting|
hash[name] = setting.value
end
hash
end
|
#validate_all ⇒ Object
177
178
179
180
181
182
183
184
|
# File 'lib/logstash/settings.rb', line 177
def validate_all
self.merge(@transient_settings)
@settings.each do |name, setting|
setting.validate_value
end
end
|