Module: LogStash::Environment

Extended by:
Environment
Included in:
Environment
Defined in:
lib/logstash/environment.rb,
lib/logstash/environment.rb

Constant Summary collapse

LOGSTASH_HOME = 
Stud::Temporary.directory("logstash-home")
LOGSTASH_CORE = 
::File.expand_path(::File.join(::File.dirname(__FILE__), "..", ".."))
LOGSTASH_ENV = 
(ENV["LS_ENV"] || 'production').to_s.freeze
LINUX_OS_RE = 
/linux/
WINDOW_OS_RE = 
/mswin|msys|mingw|cygwin|bccwin|wince|emc/
MACOS_OS_RE = 
/darwin/

Instance Method Summary collapse

Instance Method Details

#add_plugin_path(path) ⇒ Object

add path for bare/ungemified plugins lookups. the path must be the base path that will include the dir structure ‘logstash/TYPE/NAME.rb’ where TYPE is ‘inputs’ ‘filters’, ‘outputs’ or ‘codecs’ and NAME is the name of the plugin

Parameters:

  • path (String) —

    plugins path to add



195
196
197
 
# File 'lib/logstash/environment.rb', line 195

def add_plugin_path(path)
  $LOAD_PATH << path
end

#development? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/logstash/environment.rb', line 120

def development?
  env.downcase == "development"
end

#env ⇒ Object 



112
113
114
 
# File 'lib/logstash/environment.rb', line 112

def env
  LOGSTASH_ENV
end

#find_jars(pattern) ⇒ Object

Raises:

  • (LogStash::EnvironmentError) 


149
150
151
152
153
154
 
# File 'lib/logstash/environment.rb', line 149

def find_jars(pattern)
  require 'java'
  jar_files = Dir.glob(pattern)
  raise(LogStash::EnvironmentError, I18n.t("logstash.environment.missing-jars", :pattern => pattern)) if jar_files.empty?
  jar_files
end

#host_os ⇒ Object 



175
176
177
 
# File 'lib/logstash/environment.rb', line 175

def host_os
  RbConfig::CONFIG['host_os']
end

#linux? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/logstash/environment.rb', line 171

def linux?
  host_os =~ LINUX_OS_RE
end

#load_jars!(pattern) ⇒ Object 



144
145
146
147
 
# File 'lib/logstash/environment.rb', line 144

def load_jars!(pattern)
  jar_files = find_jars(pattern)
  require_jars! jar_files
end

#load_locale! ⇒ Object 



183
184
185
186
187
188
189
 
# File 'lib/logstash/environment.rb', line 183

def load_locale!
  require "i18n"
  I18n.enforce_available_locales = true
  I18n.load_path << LogStash::Environment.locales_path("en.yml")
  I18n.reload!
  fail "No locale? This is a bug." if I18n.available_locales.empty?
end

#load_runtime_jars!(dir_name = "vendor", package = "jar-dependencies") ⇒ Object 



136
137
138
 
# File 'lib/logstash/environment.rb', line 136

def load_runtime_jars!(dir_name="vendor", package="jar-dependencies")
  load_jars!(::File.join(runtime_jars_root(dir_name, package), "*.jar"))
end

#load_test_jars!(dir_name = "vendor", package = "jar-dependencies") ⇒ Object 



140
141
142
 
# File 'lib/logstash/environment.rb', line 140

def load_test_jars!(dir_name="vendor", package="jar-dependencies")
  load_jars!(::File.join(test_jars_root(dir_name, package), "*.jar"))
end

#locales_path(path) ⇒ Object 



179
180
181
 
# File 'lib/logstash/environment.rb', line 179

def locales_path(path)
  return ::File.join(LOGSTASH_CORE, "locales", path)
end

#production? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/logstash/environment.rb', line 116

def production?
  env.downcase == "production"
end

#require_jars!(files) ⇒ Object 



156
157
158
159
160
161
 
# File 'lib/logstash/environment.rb', line 156

def require_jars!(files)
  files.each do |jar_file|
    loaded = require jar_file
    puts("Loaded #{jar_file}") if $DEBUG && loaded
  end
end

#ruby_bin ⇒ Object 



163
164
165
 
# File 'lib/logstash/environment.rb', line 163

def ruby_bin
  ENV["USE_RUBY"] == "1" ? "ruby" : File.join("vendor", "jruby", "bin", "jruby")
end

#runtime_jars_root(dir_name, package) ⇒ Object 



128
129
130
 
# File 'lib/logstash/environment.rb', line 128

def runtime_jars_root(dir_name, package)
  ::File.join(dir_name, package, "runtime-jars")
end

#test? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/logstash/environment.rb', line 124

def test?
  env.downcase == "test"
end

#test_jars_root(dir_name, package) ⇒ Object 



132
133
134
 
# File 'lib/logstash/environment.rb', line 132

def test_jars_root(dir_name, package)
  ::File.join(dir_name, package, "test-jars")
end

#windows? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/logstash/environment.rb', line 167

def windows?
  host_os =~ WINDOW_OS_RE
end