Module: LogStash::Util

Defined in:
lib/logstash/util.rb,
lib/logstash/util/password.rb,
lib/logstash/util/byte_value.rb,
lib/logstash/util/decorators.rb,
lib/logstash/util/time_value.rb,
lib/logstash/util/thread_dump.rb,
lib/logstash/util/plugin_version.rb,
lib/logstash/util/cloud_setting_id.rb,
lib/logstash/util/cloud_setting_auth.rb,
lib/logstash/util/modules_setting_array.rb,
lib/logstash/util/manticore_ssl_config_helper.rb,
lib/logstash/util/worker_threads_default_printer.rb

Defined Under Namespace

Modules: ByteValue, Decorators, DurationFormatter, FileTools, JavaVersion, ManticoreSSLConfigHelper, SettingsHelper, SocketPeer, SubstitutionVariables, UnicodeTrimmer Classes: Charset, CloudSettingAuth, CloudSettingId, ModulesSettingArray, Password, PluginVersion, SafeURI, ThreadDump, TimeValue, WorkerThreadsDefaultPrinter

Constant Summary collapse

UNAME = 
case RbConfig::CONFIG["host_os"]
  when /^linux/; "linux"
  else; RbConfig::CONFIG["host_os"]
end
PR_SET_NAME = 
15

Class Method Summary collapse

Class Method Details

.class_name(instance) ⇒ String

Take a instance reference and return the name of the class stripping all the modules.

Parameters:

  • The (Object) —

    object to return the class)

Returns:

  • (String) —

    The name of the class



194
195
196
 
# File 'lib/logstash/util.rb', line 194

def self.class_name(instance)
  instance.class.name.split("::").last
end

.deep_clone(o) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/logstash/util.rb', line 198

def self.deep_clone(o)
  case o
  when Hash
    o.inject({}) {|h, (k,v)| h[k] = deep_clone(v); h }
  when Array
    o.map {|v| deep_clone(v) }
  when Integer, Symbol, IO, TrueClass, FalseClass, NilClass
    o
  when LogStash::Codecs::Base
    o.clone
  when String
    o.clone #need to keep internal state e.g. frozen
  when LogStash::Timestamp
    o.clone
  else
    Marshal.load(Marshal.dump(o))
  end
end

.get_thread_id(thread) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/logstash/util.rb', line 40

def self.get_thread_id(thread)
  if RUBY_ENGINE == "jruby"
    JRuby.reference(thread).native_thread.id
  else
    raise Exception.new("Native thread IDs aren't supported outside of JRuby")
  end
end

.hash_merge(dst, src) ⇒ Object

Merge hash ‘src’ into ‘dst’ nondestructively

Duplicate keys will become array values

src, dst[“foo”

]



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/logstash/util.rb', line 77

def self.hash_merge(dst, src)
  src.each do |name, svalue|
    if dst.include?(name)
      dvalue = dst[name]
      if dvalue.is_a?(Hash) && svalue.is_a?(Hash)
        dvalue = hash_merge(dvalue, svalue)
      elsif svalue.is_a?(Array)
        if dvalue.is_a?(Array)
          # merge arrays without duplicates.
          dvalue |= svalue
        else
          dvalue = [dvalue] | svalue
        end
      else
        if dvalue.is_a?(Array)
          dvalue << svalue unless dvalue.include?(svalue)
        else
          dvalue = [dvalue, svalue] unless dvalue == svalue
        end
      end

      dst[name] = dvalue
    else
      # dst doesn't have this key, just set it.
      dst[name] = svalue
    end
  end

  return dst
end

.hash_merge_many(*hashes) ⇒ Object

def self.hash_merge



145
146
147
148
149
150
151
 
# File 'lib/logstash/util.rb', line 145

def self.hash_merge_many(*hashes)
  dst = {}
  hashes.each do |hash|
    hash_merge_with_dups(dst, hash)
  end
  return dst
end

.hash_merge_with_dups(dst, src) ⇒ Object

Merge hash ‘src’ into ‘dst’ nondestructively

Duplicate keys will become array values Arrays merged will simply be appended.

src, dst[“foo”

]



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/logstash/util.rb', line 114

def self.hash_merge_with_dups(dst, src)
  src.each do |name, svalue|
    if dst.include?(name)
      dvalue = dst[name]
      if dvalue.is_a?(Hash) && svalue.is_a?(Hash)
        dvalue = hash_merge(dvalue, svalue)
      elsif svalue.is_a?(Array)
        if dvalue.is_a?(Array)
          # merge arrays without duplicates.
          dvalue += svalue
        else
          dvalue = [dvalue] + svalue
        end
      else
        if dvalue.is_a?(Array)
          dvalue << svalue unless dvalue.include?(svalue)
        else
          dvalue = [dvalue, svalue] unless dvalue == svalue
        end
      end

      dst[name] = dvalue
    else
      # dst doesn't have this key, just set it.
      dst[name] = svalue
    end
  end

  return dst
end

.normalize(o) ⇒ Object

recursively convert any Java LinkedHashMap and ArrayList to pure Ruby. will not recurse into pure Ruby objects. Pure Ruby object should never contain LinkedHashMap and ArrayList since these are only created at initial deserialization, anything after (deeper) will be pure Ruby.



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/logstash/util.rb', line 165

def self.normalize(o)
  case o
  when Java::JavaUtil::LinkedHashMap
    o.inject({}){|r, (k, v)| r[k] = normalize(v); r}
  when Java::JavaUtil::ArrayList
    o.map{|i| normalize(i)}
  else
    o
  end
end

.set_thread_name(name) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/logstash/util.rb', line 11

def self.set_thread_name(name)
  previous_name = Java::java.lang.Thread.currentThread.getName() if block_given?

  if RUBY_ENGINE == "jruby"
    # Keep java and ruby thread names in sync.
    Java::java.lang.Thread.currentThread.setName(name)
  end
  Thread.current[:name] = name

  if UNAME == "linux"
    require "logstash/util/prctl"
    # prctl PR_SET_NAME allows up to 16 bytes for a process name
    # since MRI 1.9, JRuby, and Rubinius use system threads for this.
    LibC.prctl(PR_SET_NAME, name[0..16], 0, 0, 0)
  end

  if block_given?
    begin
      yield
    ensure
      set_thread_name(previous_name)
    end
  end
end

.set_thread_plugin(plugin) ⇒ Object

def set_thread_name



36
37
38
 
# File 'lib/logstash/util.rb', line 36

def self.set_thread_plugin(plugin)
  Thread.current[:plugin] = plugin
end

.stringify_symbols(o) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/logstash/util.rb', line 176

def self.stringify_symbols(o)
  case o
  when Hash
    o.inject({}){|r, (k, v)| r[k.is_a?(Symbol) ? k.to_s : k] = stringify_symbols(v); r}
  when Array
    o.map{|i| stringify_symbols(i)}
  when Symbol
    o.to_s
  else
    o
  end
end

.thread_info(thread) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/logstash/util.rb', line 48

def self.thread_info(thread)
  # When the `thread` is dead, `Thread#backtrace` returns `nil`; fall back to an empty array.
  backtrace = (thread.backtrace || []).map do |line|
    line.gsub(LogStash::Environment::LOGSTASH_HOME, "[...]")
  end

  blocked_on = case backtrace.first
               when /in `push'/ then "blocked_on_push"
               when /(?:pipeline|base).*pop/ then "waiting_for_events"
               else nil
               end

  {
    "thread_id" => get_thread_id(thread),
    "name" => thread[:name],
    "plugin" => (thread[:plugin] ? thread[:plugin].debug_info : nil),
    "backtrace" => backtrace,
    "blocked_on" => blocked_on,
    "status" => thread.status,
    "current_call" => backtrace.first
  }
end