Class: LogStash::Outputs::Application_insights::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/logstash/outputs/application_insights/config.rb

Constant Summary collapse

@@configuration = 
{}

Class Method Summary collapse

Class Method Details

.current ⇒ Object 



29
30
31
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 29

def self.current
  @@configuration
end

.symbolize_table_properties(properties) ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 207

def self.symbolize_table_properties ( properties )
  new_properties = {}
  properties.each_pair { |property_name, property_value|
    new_properties[property_name.to_sym] = property_value
  }
  new_properties
end

.validate_and_adjust(property, value, type, disallow_empty = false) ⇒ Object

Raises:



289
290
291
292
293
294
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 289

def self.validate_and_adjust ( property, value, type, disallow_empty = false )
  raise ConfigurationError, "#{property.to_s} must be an #{type.to_s}" unless value.is_a?( type )
  raise ConfigurationError, "#{property.to_s} cannot be empty" if disallow_empty && value.empty? 
  return value unless String == type
  Utils.unescape( value )
end

.validate_and_adjust_boolean(property, value) ⇒ Object

Raises:



296
297
298
299
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 296

def self.validate_and_adjust_boolean( property, value )
  raise ConfigurationError, "#{property.to_s} must be a Boolean" unless !!value == value
  value
end

.validate_and_adjust_configuration(configuration) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
107
108
109
110
111
112
113
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 33

def self.validate_and_adjust_configuration ( configuration )
  configuration.each_pair { |config_name, config_value|
    raise ConfigurationError, "#{config_name.to_s} must be defined" unless config_value || BOOLEAN_PROPERTIES.include?( config_name )
    case config_name

    when :logger_level
      logger_level = validate_and_adjust( config_name, config_value, String )
      raise ConfigurationError, "#{config_name.to_s} can be set to only one of the valid log levels" unless LOGGER_LEVEL_MAP[logger_level.upcase.to_sym]
      configuration[config_name] = LOGGER_LEVEL_MAP[logger_level.upcase.to_sym]

    when :logger_files
      config_value = [ config_value ] if config_value.is_a?( String )
      logger_files = validate_and_adjust( config_name, config_value, Array )

      i = 0
      logger_files.map! do |file_name|
        file_name = validate_and_adjust( "#{config_name.to_s}[#{i}]", file_name, String )
        i += 1
        if "stdout" == file_name.downcase
          file_name = :stdout
          file = STDOUT
        elsif "stderr" == file_name.downcase
          file_name = :stderr
          file = STDERR
        else
          file = ::File.open( file_name, "a+" )
        end
        [ file_name, file ]
      end
      configuration[config_name] = logger_files

    when :logger_progname
      configuration[config_name] = validate_and_adjust( config_name, config_value, String )

    when :logger_shift_size
      configuration[config_name] = validate_and_adjust_integer( config_name, config_value, MIN_LOGGER_SHIFT_SIZE, MAX_LOGGER_SHIFT_SIZE )

    when :logger_shift_age
      if config_value.is_a?( String )
        config_value = validate_and_adjust( config_name, config_value, String ).downcase
        raise ConfigurationError, "#{config_name.to_s} if string, can be set to only one of the following values: #{VALID_LOGGER_SHIFT_AGES}" unless VALID_LOGGER_SHIFT_AGES. include?( config_value )
      elsif config_value.is_a?( Integer )
        config_value = validate_and_adjust_integer( config_name, config_value, MIN_LOGGER_SHIFT_AGE, MAX_LOGGER_SHIFT_AGE )
      else
        raise ConfigurationError, "#{config_name.to_s} must be either a string or integer"
      end
      configuration[config_name] = config_value

    when :azure_storage_container_prefix
      azure_storage_container_prefix = validate_and_adjust( config_name, config_value, String )
      unless azure_storage_container_prefix.empty?
        len = 63 - "-#{AZURE_STORAGE_CONTAINER_LOGSTASH_PREFIX}-yyyy-mm-dd".length
        validate_max( "azure_storage_container_prefix length", azure_storage_container_prefix.length, len )
        azure_storage_container_prefix += "-"
      end
      azure_storage_container_prefix = azure_storage_container_prefix.downcase
      container_name = "#{azure_storage_container_prefix}#{AZURE_STORAGE_CONTAINER_LOGSTASH_PREFIX}-yyyy-mm-dd"
      raise ConfigurationError, "#{config_name.to_s} must have only alphanumeric and dash characters, cannot start or end with a dash, and a dash cannot follow a dash" unless Utils.valid_container_name?( container_name )
      configuration[config_name] = azure_storage_container_prefix + AZURE_STORAGE_CONTAINER_LOGSTASH_PREFIX

    when :azure_storage_azure_storage_table_prefix
      azure_storage_table_prefix = validate_and_adjust( config_name, config_value, String )
      unless azure_storage_table_prefix.empty?
        len = 63 - "-#{AZURE_STORAGE_TABLE_LOGSTASH_PREFIX}yyyymmdd".length
        validate_max( "azure_storage_table_prefix length", azure_storage_table_prefix.length, len )
      end
      table_name = "#{azure_storage_table_prefix}#{AZURE_STORAGE_TABLE_LOGSTASH_PREFIX}yyyymmdd"
      raise ConfigurationError, "#{config_name} must have only alphanumeric" unless Utils.valid_table_name?( table_name )
      configuration[config_name] = azure_storage_table_prefix + AZURE_STORAGE_TABLE_LOGSTASH_PREFIX

    when :ca_file
      config_value = validate_and_adjust( config_name, config_value, String )
      unless config_value.empty?
        raise ConfigurationError, "#{config_name} must have a valid path name" unless Utils.valid_file_path?( config_value )
      end
      configuration[config_name] = validate_and_adjust( config_name, config_value, String )

    when :azure_storage_blob_prefix
      azure_storage_blob_prefix = validate_and_adjust( config_name, config_value, String )
      unless azure_storage_blob_prefix.empty?
        len = 1024 - "-#{AZURE_STORAGE_BLOB_LOGSTASH_PREFIX}_ikey-#{INSTRUMENTATION_KEY_TEMPLATE}_table-#{TABLE_ID_TEMPLATE}_yyyy-mm-dd-HH-MM-SS-LLL".length
        validate_max( "azure_storage_blob_prefix length", azure_storage_blob_prefix.length, len )
        azure_storage_blob_prefix += "-"
      end
      azure_storage_blob_prefix += AZURE_STORAGE_BLOB_LOGSTASH_PREFIX

      raise ConfigurationError, "#{config_name.to_s} doesn't meet url format" unless Utils.url?( "http://storage/container/#{azure_storage_blob_prefix}_ikey-#{INSTRUMENTATION_KEY_TEMPLATE}_table-#{TABLE_ID_TEMPLATE}.json" )
      configuration[config_name] = azure_storage_blob_prefix

    when :table_id
      configuration[config_name] = validate_and_adjust_guid( config_name, config_value )

    when :blob_max_bytesize
     configuration[config_name] = validate_and_adjust_integer( config_name, config_value, MIN_BLOB_MAX_BYTESIZE, MAX_BLOB_MAX_BYTESIZE )

    when :blob_max_events
     configuration[config_name] = validate_and_adjust_integer( config_name, config_value, MIN_BLOB_MAX_EVENTS, MAX_BLOB_MAX_EVENTS )

    when :blob_retention_time
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_BLOB_RETENTION_TIME, MAX_BLOB_RETENTION_TIME )

    when :blob_access_expiry_time
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_BLOB_ACCESS_EXPIRY_TIME, MAX_BLOB_ACCESS_EXPIRY_TIME )

    when :resurrect_delay
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_STORAGE_RESURRECT_DELAY, MAX_STORAGE_RESURRECT_DELAY )

    when :flow_control_suspend_bytes
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_FLOW_CONTROL_SUSPEND_BYTES, MAX_FLOW_CONTROL_SUSPEND_BYTES )

    when :flow_control_resume_bytes
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_FLOW_CONTROL_RESUME_BYTES, MAX_FLOW_CONTROL_RESUME_BYTES )

    when :flow_control_delay
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_FLOW_CONTROL_DELAY, MAX_FLOW_CONTROL_DELAY )

    when :io_retry_delay
      configuration[config_name] = validate_and_adjust_number( config_name, config_value, MIN_IO_RETRY_DELAY, MAX_IO_RETRY_DELAY )

    when :io_max_retries
      configuration[config_name] = validate_and_adjust_integer( config_name, config_value, MIN_IO_MAX_RETRIES, MAX_IO_MAX_RETRIES )

    when :storage_account_name_key
      config_value = validate_and_adjust( config_name, config_value, Array )
      if config_value.empty?
        raise ConfigurationError, "#{config_name.to_s} is empty, at least one storage account name should be defined" unless ENV['AZURE_STORAGE_ACCOUNT']
        raise ConfigurationError, "#{config_name.to_s} is empty, at least one storage account access key should be defined" unless ENV['AZURE_STORAGE_ACCESS_KEY']
        config_value = [ ENV['AZURE_STORAGE_ACCOUNT'], ENV['AZURE_STORAGE_ACCESS_KEY'] ]
      end

       = validate_and_adjust( config_name, config_value, Array, :disallow_empty )
      unless [0].is_a?( Array )
        raise ConfigurationError, "#{config_name.to_s} property is empty, should contain at least one pair: account_name, key" unless 2 == .length
         = [ [ [0], [1] ]]
      end

      index = 0
      .map! { |pair|
        pair = validate_and_adjust( "#{config_name.to_s}[#{index}]", pair, Array, :disallow_empty )
        raise ConfigurationError, "#{config_name.to_s}[#{index}] must have two items" unless 2 == pair.length

        ( name, keys ) = pair
        name = validate_and_adjust( "#{config_name.to_s}[#{index}]:name", name, String, :disallow_empty )
        raise ConfigurationError, "#{config_name.to_s}[#{index}]:name must between 3 to 24 characters" unless (name.length >= 3) && (name.length <= 24)
        raise ConfigurationError, "##{config_name.to_s}[#{index}]:name bad format, must have only alphanumeric characters" unless Utils.alphanumeric?( name )

        keys = [ keys ] if keys.is_a?( String )
        keys = validate_and_adjust( "#{config_name}[#{index}]:keys", keys, Array, :disallow_empty )
        keys.each_index do |i|
          key = validate_and_adjust( "#{config_name}[#{index}:keys[#{i}]", keys[i], String, :disallow_empty )
          raise ConfigurationError, "#{config_name}[#{index}:keys[#{i}] must have only valid base64 characters" unless Utils.base64?( key )
        end
        index += 1
        [ name.downcase, keys ]
      }
      configuration[config_name] = 

    when :tables
      tables = validate_and_adjust( config_name, config_value, Hash )
      tables.each_pair { |table_id, properties|
        table_id = validate_and_adjust_guid( "#{config_name}:table_id", table_id )
        info = "#{config_name}[#{table_id}]"
        properties = validate_and_adjust( info, properties, Hash )
        properties = Utils.symbolize_hash_keys( properties )
        validate_and_adjust_table_properties!( properties, configuration, info )
        configuration[config_name][table_id] = properties
      }
    end
  }
  validate_and_adjust_table_properties!( configuration, configuration )
  @@configuration = configuration
end

.validate_and_adjust_ext(property, ext, prefix) ⇒ Object

Raises:



281
282
283
284
285
286
287
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 281

def self.validate_and_adjust_ext ( property, ext, prefix )
  ext = validate_and_adjust( property, ext, String )
  raise ConfigurationError, "#{property.to_s} must be a valid extension string, have only alphanumeric, dash and underline characters" unless Utils.ext?( ext )
  len = 1024 - "#{prefix}-#{AZURE_STORAGE_BLOB_LOGSTASH_PREFIX}_ikey-#{INSTRUMENTATION_KEY_TEMPLATE}_table-#{TABLE_ID_TEMPLATE}_yyyy-mm-dd-HH-MM-SS-LLL".length
  raise ConfigurationError, "#{property.to_s} length cannot be more than #{len} characters" unless ext.length <= len
  ext
end

.validate_and_adjust_guid(property, value) ⇒ Object

Raises:



324
325
326
327
328
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 324

def self.validate_and_adjust_guid ( property, value )
  value = validate_and_adjust( property, value, String )
  raise ConfigurationError, "#{property.to_s} must be a Guid string, that followy this pattern xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" unless Utils.guid?( value )
  value
end

.validate_and_adjust_integer(property, value, min, max) ⇒ Object

Raises:



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 302

def self.validate_and_adjust_integer ( property, value, min, max )
  if value.is_a?( String )
    raise ConfigurationError, "#{property.to_s} must be an Integer or Integer string" unless Utils.integer?( value )
    value = value.to_i
  end
  raise ConfigurationError, "#{property.to_s} must be an Integer" unless value.is_a?( Integer )
  validate_max( property, value, max )
  validate_min( property, value, min )
  value
end

.validate_and_adjust_number(property, value, min, max) ⇒ Object

Raises:



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 313

def self.validate_and_adjust_number ( property, value, min, max )
  if value.is_a?( String )
    raise ConfigurationError, "#{property.to_s} must be a number or number string" unless Utils.number?( value )
    value = value.to_f
  end
  raise ConfigurationError, "#{property.to_s} must be an Integer" unless value.is_a?( Integer )
  validate_max( property, value, max )
  validate_min( property, value, min )
  value
end

.validate_and_adjust_table_properties!(properties, configuration, base_info = nil) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 215

def self.validate_and_adjust_table_properties! ( properties, configuration, base_info = nil )

  properties.each_pair { |property_name, property_value|
    info = ( base_info.nil? ? "#{property_name}" : "#{base_info}[#{property_name}]" )
    raise ConfigurationError, "#{info} must be defined" unless property_value || BOOLEAN_PROPERTIES.include?( property_name )

    case property_name.downcase

    when :intrumentation_key
      properties[:intrumentation_key] = validate_and_adjust_guid( info, property_value )
    when :blob_serialization
      property_value = property_value.downcase
      raise ConfigurationError, "#{info}, can be set to only one of the following values: #{VALID_EXT_EVENT_FORMAT}" unless VALID_EXT_EVENT_FORMAT.include?( property_value )
      properties[:blob_serialization] = validate_and_adjust_ext( info ,property_value, configuration[:azure_storage_blob_prefix] ) # be careful depends on order
    when :csv_default_value
      properties[:csv_default_value] = validate_and_adjust( info, property_value, String )
    when :csv_separator
      properties[:csv_separator] = validate_and_adjust( info, property_value, String )
    when :blob_max_delay
      properties[:blob_max_delay] = validate_and_adjust_number( info, property_value, MIN_BLOB_MAX_DELAY, MAX_BLOB_MAX_DELAY )
    when :event_separator
      properties[:event_separator] = validate_and_adjust( info, property_value, String )
    when :serialized_event_field
      properties[:serialized_event_field] = ( property_value.nil? ? nil : validate_and_adjust( info, property_value, String ) )
    when :case_insensitive_columns
      properties[:case_insensitive_columns] = validate_and_adjust_boolean( info, property_value )
    when :table_columns
      if property_value.nil?
        properties[:table_columns] = property_value
      else
        table_columns = property_value
        table_columns = [ table_columns ] if table_columns.is_a?( String )
        table_columns = validate_and_adjust( info, table_columns, Array)
        new_table_columns = []
        index = 0
        table_columns.each do |column|
          new_column = {}

          column = { COLUMN_PROPERTY_NAME => column } if column.is_a?( String )
          column = validate_and_adjust( "#{info}[#{index}]", column, Hash, :disallow_empty )
          raise ConfigurationError, "#{info}[#{index}][#{COLUMN_PROPERTY_NAME}] must be defined" unless column[COLUMN_PROPERTY_NAME]
          new_column[:name] = validate_and_adjust( "#{info}[#{index}][#{COLUMN_PROPERTY_NAME}]", column[COLUMN_PROPERTY_NAME], String )

          if column[COLUMN_PROPERTY_DEFAULT]
            new_column[:default] = validate_and_adjust( "#{info}[#{index}][#{COLUMN_PROPERTY_DEFAULT}]", column[COLUMN_PROPERTY_DEFAULT], String )
          end

          if column[COLUMN_PROPERTY_TYPE]
            new_column[:type] = validate_and_adjust( "#{info}[#{index}][#{COLUMN_PROPERTY_TYPE}]", column[COLUMN_PROPERTY_TYPE], String ).downcase
            raise ConfigurationError, "#{info}[#{index}][#{COLUMN_PROPERTY_TYPE}] can be only one of the following values: #{VALID_FIELDS_MAP_TYPES}" unless VALID_FIELDS_MAP_TYPES.any? {|type| type == new_column[:type]}
            new_column[:type] = new_column[:type].to_sym
          end
          new_table_columns << new_column
          index += 1
        end
        properties[:table_columns] = new_table_columns
      end

    else
    end
  }
end

.validate_max(property, value, max) ⇒ Object

Raises:



330
331
332
333
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 330

def self.validate_max (property, value, max)
  raise ConfigurationError, "#{property.to_s} cannot be bigger than #{max}" unless value <= max || 0 == max
  value
end

.validate_min(property, value, min) ⇒ Object

Raises:



335
336
337
338
 
# File 'lib/logstash/outputs/application_insights/config.rb', line 335

def self.validate_min (property, value, min)
  raise ConfigurationError, "#{property.to_s} cannot be less than #{min}" unless value >= min
  value
end