logtastic 0.1.0

data/lib/logtastic/ecs.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "logtastic/setup"
+
+module Logtastic
+  class ECS
+    def initialize(index: nil, template: nil, ilm: nil, version: "1.5", output: :default)
+      @index = index
+      @output = output
+      @elasticsearch = Logtastic.client(@output)
+
+      @setup = Logtastic::Setup.new(
+        @elasticsearch,
+        template: { json: { path: File.new(template_path(version)) } }.merge(template || {}),
+        ilm: ilm
+      )
+      @setup.perform!
+    end
+
+    def write(event)
+      Logtastic.write(@output, index: write_index(event), body: event)
+    end
+
+    def write_now(event)
+      @elasticsearch.index(index: write_index(event), body: event)
+    end
+
+    def search(**args)
+      @elasticsearch.search({ index: query_index }.merge(**args))
+    end
+
+    def count(**args)
+      @elasticsearch.count({ index: query_index }.merge(**args))
+    end
+
+    def query_index
+      if @setup.ilm_enabled?
+        "#{@setup.rollover_alias}-*"
+      else
+        @setup.template_pattern
+      end
+    end
+
+    private
+
+    def write_index(_event)
+      if @index.nil?
+        @setup.rollover_alias
+      else
+        @index
+      end
+    end
+
+    def template_path(version)
+      File.join(__dir__, "ecs-template-#{version}.json")
+    end
+  end
+end

data/lib/logtastic/setup.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Logtastic
+  class Setup
+    class Error < StandardError; end
+    class AliasAlreadyExists < Error; end
+
+    DEFAULT_ILM_POLICY = {
+      "policy" => {
+        "phases" => {
+          "hot" => {
+            "actions" => {
+              "rollover" => {
+                "max_size" => "50gb",
+                "max_age" => "30d"
+              }
+            }
+          }
+        }
+      }
+    }.freeze
+
+    def initialize(elasticsearch, template: nil, ilm: nil)
+      @elasticsearch = elasticsearch
+      @template = template || {}
+      @ilm = ilm || {}
+    end
+
+    def perform!
+      @elasticsearch.xpack.ilm.put_policy(put_ilm_policy_args) if put_ilm_policy?
+      @elasticsearch.indices.put_template(put_template_args) if put_template?
+
+      begin
+        @elasticsearch.indices.create(create_rollover_alias_args) if create_rollover_alias?
+      rescue Elasticsearch::Transport::Transport::Errors::BadRequest
+        raise AliasAlreadyExists, "An index exists with the same name as the alias [#{rollover_alias}]"
+      end
+
+      true
+    end
+
+    def ilm_enabled?
+      @ilm.fetch(:enabled, true)
+    end
+
+    def ilm_overwrite?
+      @ilm.fetch(:overwrite, false)
+    end
+
+    def ilm_policy_id
+      @ilm.fetch(:policy_name, "logtastic")
+    end
+
+    def rollover_alias
+      @ilm.fetch(:rollover_alias, "logtastic")
+    end
+
+    def ilm_pattern
+      @ilm.fetch(:pattern, "{now/d}-000001")
+    end
+
+    def ilm_policy_body
+      policy_file = @ilm.fetch(:policy_file, DEFAULT_ILM_POLICY)
+
+      if policy_file.is_a?(Hash)
+        policy_file
+      else
+        JSON.load(policy_file)
+      end
+    end
+
+    def put_ilm_policy?
+      return false unless ilm_enabled?
+      return true if ilm_overwrite?
+
+      begin
+        @elasticsearch.xpack.ilm.get_policy(policy_id: ilm_policy_id)
+        false
+      rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        true
+      end
+    end
+
+    def put_ilm_policy_args
+      {
+        policy_id: ilm_policy_id,
+        body: ilm_policy_body
+      }
+    end
+
+    def template_name
+      @template.fetch(:name, "logtastic")
+    end
+
+    def template_pattern
+      @template.fetch(:pattern, "logtastic-*")
+    end
+
+    def template_body
+      JSON.load(@template.dig(:json, :path)).tap do |base_template|
+        index_patterns = Array(template_pattern)
+        base_template["index_patterns"] = index_patterns unless index_patterns.empty?
+        base_template["settings"]["index"].merge!(template_index_settings)
+      end
+    end
+
+    def template_index_settings
+      {}.tap do |hash|
+        if ilm_enabled?
+          hash.merge!(
+            "lifecycle.name" => ilm_policy_id,
+            "lifecycle.rollover_alias" => rollover_alias
+          )
+        end
+
+        hash.merge!(@template.dig(:settings, :index)) if @template.dig(:settings, :index)
+      end
+    end
+
+    def template_overwrite?
+      @template.fetch(:overwrite, false)
+    end
+
+    def put_template?
+      return true if template_overwrite?
+
+      !@elasticsearch.indices.exists_template?(name: template_name)
+    end
+
+    def put_template_args
+      {
+        name: template_name,
+        create: !template_overwrite?,
+        body: template_body
+      }
+    end
+
+    def create_rollover_alias?
+      return false unless ilm_enabled?
+
+      !@elasticsearch.indices.exists_alias?(name: rollover_alias)
+    end
+
+    def create_rollover_alias_args
+      {
+        index: "<#{rollover_alias}-#{ilm_pattern}>",
+        body: {
+          "aliases" => {
+            rollover_alias => {
+              "is_write_index" => true
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/logtastic/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Logtastic
+  VERSION = "0.1.0"
+end

data/logtastic.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/logtastic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logtastic"
+  spec.version       = Logtastic::VERSION
+  spec.authors       = ["Orhan Toy"]
+  spec.email         = ["toyorhan@gmail.com"]
+
+  spec.summary       = "Logtastic"
+  spec.description   = "Logtastic"
+  spec.homepage      = "https://github.com/orhantoy/logtastic"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/orhantoy/logtastic"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "elasticsearch"
+  spec.add_dependency "elasticsearch-xpack"
+  spec.add_dependency "concurrent-ruby"
+
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: logtastic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Orhan Toy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  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: elasticsearch-xpack
+  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: concurrent-ruby
+  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: byebug
+  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: Logtastic
+email:
+- toyorhan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logtastic.rb
+- lib/logtastic/ecs-template-1.5.json
+- lib/logtastic/ecs.rb
+- lib/logtastic/setup.rb
+- lib/logtastic/version.rb
+- logtastic.gemspec
+homepage: https://github.com/orhantoy/logtastic
+licenses: []
+metadata:
+  homepage_uri: https://github.com/orhantoy/logtastic
+  source_code_uri: https://github.com/orhantoy/logtastic
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Logtastic
+test_files: []