logstash-output-mageshlogs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6c4064d475c7b3888cb102e97032ace990371d9d1b819332bb20c52320fc1f4
+  data.tar.gz: 5f3b3181be0c13013a7fee4ed2023da2e95aab27a0daaace4ffead6a1ebefad3
+SHA512:
+  metadata.gz: c413d7d9f65f805e05e8cf3da60757f59782eb37f8385135b68ac832258f0df4a8e873a3b46d8da39c6f007a5e450ee7b3fd7a0710d758dd0966eb70b16ab169
+  data.tar.gz: 35d9433ac3ec4f2784d55adf94330881f43e6ee8e201038ad45644f9926f0971a1dbcb1c1339620df3204d62e002668e400f8826199398916bcde9c758afaae8

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+*  - 
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-mageshlogs
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/mageshlogs.rb

@@ -0,0 +1,309 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/json"
+require "zlib"
+require "date"
+require "json"
+require "base64"
+
+# An mageshlogs output that does nothing.
+class LogStash::Outputs::Mageshlogs < LogStash::Outputs::Base
+  config_name "mageshlogs"
+
+  S247_MAX_RECORD_COUNT = 500
+  S247_MAX_RECORD_SIZE = 1000000
+  S247_MAX_BATCH_SIZE = 5000000
+  S247_LOG_UPLOAD_CHECK_INTERVAL = 600 #10 minutes
+  S247_TRUNCATION_SUFFIX = "##TRUNCATED###"
+
+  default :codec, "json"
+
+  config :log_type_config,:validate => :string, :required => true
+  config :max_retry, :validate => :number, :required => false,  :default => 3
+  config :retry_interval, :validate => :number, :required => false, :default => 2
+  config :http_idle_timeout, :validate => :number, :required => false, default: 5
+  config :http_read_timeout, :validate => :number, :required => false, default: 30
+  config :http_proxy, :validate => :string, :required => false, :default => nil
+
+  public
+  def register
+    init_variables()
+    init_http_client(@logtype_config)
+  end # def register
+
+
+  public
+  def multi_receive(events)
+    return if events.empty?
+    @logger.info("Events received : #{events}")
+    process_http_events(events)
+  end
+
+  def close
+      @s247_http_client.close if @s247_http_client
+  end
+
+  def base64_url_decode(str)
+     str += '=' * (4 - str.length.modulo(4))
+     Base64.decode64(str.tr('-_','+/'))
+  end
+  def init_variables()
+    @logtype_config = JSON.parse(base64_url_decode(@log_type_config))
+    @s247_custom_regex = if @logtype_config.has_key? 'regex' then Regexp.compile(@logtype_config['regex'].gsub('?P<','?<')) else nil end
+    @s247_ignored_fields = if @logtype_config.has_key? 'ignored_fields' then @logtype_config['ignored_fields'] else [] end
+    @s247_tz = {'hrs': 0, 'mins': 0} #UTC
+    @log_source = Socket.gethostname
+    @valid_logtype = true
+    @log_upload_allowed = true
+    @log_upload_stopped_time = 0
+    @s247_datetime_format_string = @logtype_config['dateFormat']
+    @s247_datetime_format_string = @s247_datetime_format_string.sub('%f', '%N')
+    if !@s247_datetime_format_string.include? 'unix'
+      @is_year_present = if @s247_datetime_format_string.include?('%y') || @s247_datetime_format_string.include?('%Y') then true else false end
+      if !@is_year_present
+	@s247_datetime_format_string = @s247_datetime_format_string+ ' %Y'
+      end   
+      @is_timezone_present = if @s247_datetime_format_string.include? '%z' then true else false end
+      if !@is_timezone_present && @logtype_config.has_key?('timezone')
+	tz_value = @logtype_config['timezone']
+	if tz_value.start_with?('+')
+	    @s247_tz['hrs'] = Integer('-' + tz_value[1..4])
+	    @s247_tz['mins'] = Integer('-' + tz_value[3..6])
+	elsif tz_value.start_with?('-')
+	    @s247_tz['hrs'] = Integer('+' + tz_value[1..4])
+	    @s247_tz['mins'] = Integer('+' + tz_value[3..6])
+	end
+      end
+    end
+  end
+
+  def init_http_client(logtype_config)
+    require 'manticore'
+    @upload_url = 'https://'+logtype_config['uploadDomain']+'/upload'
+    @logger.info("Starting HTTP connection to #{@upload_url}")
+    @headers = {"Content-Type" => "application/json", "Content-Encoding" => "gzip", "X-DeviceKey" => logtype_config['apiKey'], "X-LogType" => logtype_config['logType'], "X-StreamMode" => "1", "User-Agent" => "LogStash"}
+    @s247_http_client = Manticore::Client.new({})
+    #@s247_http_client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    #@s247_http_client.idle_timeout = @http_idle_timeout
+    #@s247_http_client.read_timeout = @http_read_timeout
+  
+  end
+
+  def get_timestamp(datetime_string)
+    begin
+        # If the date value is in unix format the no need to process the date string
+        if @s247_datetime_format_string.include? 'unix'
+            return (if @s247_datetime_format_string == 'unix' then datetime_string+'000' else datetime_string end)
+        end
+        datetime_string += if !@is_year_present then ' '+String(Time.new.year) else '' end
+        if !@is_timezone_present && @logtype_config.has_key?('timezone')
+            @s247_datetime_format_string += '%z'
+            time_zone = String(@s247_tz['hrs'])+':'+String(@s247_tz['mins'])
+            datetime_string += if time_zone.start_with?('-') then time_zone else '+'+time_zone end
+        end
+        datetime_data = DateTime.strptime(datetime_string, @s247_datetime_format_string)
+        return Integer(datetime_data.strftime('%Q'))
+    rescue
+        return 0
+    end
+  end
+
+  def parse_lines(lines)
+    parsed_lines = []
+    log_size = 0
+    lines.each do |line|
+       if !line.empty?
+	    begin
+		if match = line.match(@s247_custom_regex)
+                    log_size += line.bytesize
+		    log_fields = match&.named_captures
+		    removed_log_size=0
+		    @s247_ignored_fields.each do |field_name|
+		        removed_log_size += if log_fields.has_key?field_name then log_fields.delete(field_name).bytesize else 0 end
+		    end
+		    formatted_line = {'_zl_timestamp' => get_timestamp(log_fields[@logtype_config['dateField']]), 's247agentuid' => @log_source}
+		    formatted_line.merge!(log_fields)
+                    parsed_lines.push(formatted_line)
+		    log_size -= removed_log_size
+		end
+	    rescue Exception => e
+		@logger.error("Exception in parse_line #{e.backtrace}")
+	    end
+       end
+    end
+    return parsed_lines, log_size
+  end
+
+  def is_filters_matched(formatted_line)
+    if @logtype_config.has_key?'filterConfig'
+        @logtype_config['filterConfig'].each do |config|
+            if formatted_line.has_key?config && (filter_config[config]['match'] ^ (filter_config[config]['values'].include?formatted_line[config]))
+                return false
+	    end
+        end
+    end
+    return true
+  end
+
+  def get_json_value(obj, key, datatype=nil)
+    if obj != nil && (obj.has_key?key)
+       if datatype and datatype == 'json-object'
+	  arr_json = []
+          child_obj = obj[key]
+          if child_obj.class == String
+             child_obj = JSON.parse(child_obj.gsub('\\','\\\\'))
+          end             
+          child_obj.each do |key, value|
+             arr_json.push({'key' => key, 'value' => String(value)})
+          end
+          return arr_json
+       else
+         return (if obj.has_key?key then obj[key] else obj[key.downcase] end)
+       end
+    elsif key.include?'.'
+	parent_key = key[0..key.index('.')-1]
+	child_key = key[key.index('.')+1..-1]
+        child_obj = obj[if obj.has_key?parent_key then parent_key else parent_key.capitalize() end]
+	if child_obj.class == String
+            child_obj = JSON.parse(child_obj.replace('\\','\\\\'))
+        end
+        return get_json_value(child_obj, child_key)
+    end
+  end
+
+  def json_log_parser(lines_read)
+    log_size = 0
+    parsed_lines = []
+    lines_read.each do |line|
+        if !line.empty?
+          current_log_size = 0
+	  formatted_line = {}
+	  event_obj = Yajl::Parser.parse(line)
+	  @logtype_config['jsonPath'].each do |path_obj|
+	    value = get_json_value(event_obj, path_obj[if path_obj.has_key?'key' then 'key' else 'name' end], path_obj['type'])
+            if value
+	      formatted_line[path_obj['name']] = value 
+	      current_log_size+= String(value).size - (if value.class == Array then value.size*20 else 0 end)
+            end
+          end
+	  if is_filters_matched(formatted_line)
+	    formatted_line['_zl_timestamp'] = get_timestamp(formatted_line[@logtype_config['dateField']])
+	    formatted_line['s247agentuid'] = @log_source
+	    parsed_lines.push(formatted_line)
+            log_size+=current_log_size
+          end
+	end
+    end
+    return parsed_lines, log_size
+  end
+  
+  def process_http_events(events)
+    batches = batch_http_events(events)
+    batches.each do |batched_event|
+      formatted_events, log_size = format_http_event_batch(batched_event)
+      formatted_events = gzip_compress(formatted_events)
+      send_logs_to_s247(formatted_events, log_size)
+    end
+  end
+
+  def batch_http_events(encoded_events)
+    batches = []
+    current_batch = []
+    current_batch_size = 0
+    encoded_events.each_with_index do |encoded_event, i|
+      #dump = LogStash::Json.dump(encoded_event.to_hash)
+      event_message = encoded_event.to_hash['message']
+      @logger.info("Message : #{event_message}")
+      current_event_size = event_message.bytesize
+      if current_event_size > S247_MAX_RECORD_SIZE
+        event_message = event_message[0..(S247_MAX_RECORD_SIZE-DD_TRUNCATION_SUFFIX.length)]+DD_TRUNCATION_SUFFIX
+        current_event_size = event_message.bytesize
+      end
+
+      if (i > 0 and i % S247_MAX_RECORD_COUNT == 0) or (current_batch_size + current_event_size > S247_MAX_BATCH_SIZE)
+        batches << current_batch
+        current_batch = []
+        current_batch_size = 0
+      end
+
+      current_batch_size += current_event_size
+      current_batch << event_message
+    end
+    batches << current_batch
+    batches
+  end
+
+  def format_http_event_batch(events)
+    parsed_lines = []
+    log_size = 0
+    if @logtype_config.has_key?'jsonPath'
+      parsed_lines, log_size = json_log_parser(events)
+    else
+       parsed_lines, log_size = parse_lines(events)
+    end
+    return LogStash::Json.dump(parsed_lines), log_size
+  end
+
+  def gzip_compress(payload)
+    gz = StringIO.new
+    gz.set_encoding("BINARY")
+    z = Zlib::GzipWriter.new(gz, 9)
+    begin
+      z.write(payload)
+    ensure
+      z.close
+    end
+    gz.string
+  end
+
+  def send_logs_to_s247(gzipped_parsed_lines, log_size)
+     @headers['Log-Size'] = String(log_size)
+     @logger.info("log_size = #{log_size}")
+     sleep_interval = @retry_interval
+     begin
+        @max_retry.times do |counter|
+          need_retry = false
+          begin
+            response = @s247_http_client.post(@upload_url, body: gzipped_parsed_lines, headers: @headers).call
+            resp_headers = response.headers.to_h
+            if response.code == 200
+              if resp_headers.has_key?'LOG_LICENSE_EXCEEDS' && resp_headers['LOG_LICENSE_EXCEEDS'] == 'True'
+                @logger.error("Log license limit exceeds so not able to send logs")
+                @log_upload_allowed = false
+		@log_upload_stopped_time =Time.now.to_i
+              elsif resp_headers.has_key?'BLOCKED_LOGTYPE' && resp_headers['BLOCKED_LOGTYPE'] == 'True'
+                @logger.error("Max upload limit reached for log type")
+                @log_upload_allowed = false
+		@log_upload_stopped_time =Time.now.to_i
+              elsif resp_headers.has_key?'INVALID_LOGTYPE' && resp_headers['INVALID_LOGTYPE'] == 'True'
+                @logger.error("Log type not present in this account so stopping log collection")
+		@valid_logtype = false
+              else
+		@log_upload_allowed = true
+                @logger.info("Successfully sent logs with size #{gzipped_parsed_lines.size} / #{log_size} to site24x7. Upload Id : #{resp_headers['x-uploadid']}")
+              end
+            else
+              @logger.error("Response Code #{response.code} from Site24x7, so retrying (#{counter + 1}/#{@max_retry})")
+              need_retry = true
+            end
+          rescue StandardError => e
+            @logger.error("Error connecting to Site24x7. exception: #{e.backtrace}")
+          end
+
+          if need_retry
+            if counter == @max_retry - 1
+              @logger.error("Could not send your logs after #{max_retry} tries")
+              break
+            end
+            sleep(sleep_interval)
+            sleep_interval *= 2
+          else
+            return
+          end
+        end
+      rescue Exception => e
+        @logger.error("Exception occurred in sendig logs : #{e.backtrace}")
+      end
+  end
+
+end

data/logstash-output-mageshlogs.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-mageshlogs'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Write a short summary, because Rubygems requires one.'
+  s.homepage      = 'https://site24x7.com'
+  s.authors       = ['']
+  s.email         = ''
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/mageshlogs_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/mageshlogs"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Mageshlogs do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Mageshlogs.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-mageshlogs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/mageshlogs.rb
+- logstash-output-mageshlogs.gemspec
+- spec/outputs/mageshlogs_spec.rb
+homepage: https://site24x7.com
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/outputs/mageshlogs_spec.rb