event_meter 0.1.0

data/lib/event_meter.rb

@@ -0,0 +1,150 @@
+require "time"
+
+require_relative "event_meter/version"
+require_relative "event_meter/errors"
+require_relative "event_meter/hash_input"
+require_relative "event_meter/configuration"
+require_relative "event_meter/write_result"
+require_relative "event_meter/event"
+require_relative "event_meter/event_payload"
+require_relative "event_meter/index_key"
+require_relative "event_meter/path_name"
+require_relative "event_meter/report_definition"
+require_relative "event_meter/rollup"
+require_relative "event_meter/time_buckets"
+require_relative "event_meter/keys"
+require_relative "event_meter/reports"
+require_relative "event_meter/processor"
+require_relative "event_meter/auto_cleanup"
+require_relative "event_meter/stores/namespace"
+require_relative "event_meter/stores/cleanup_helpers"
+require_relative "event_meter/stores/file_helpers"
+require_relative "event_meter/stores/redis_lock"
+require_relative "event_meter/stores/stream/file"
+require_relative "event_meter/stores/stream/redis"
+require_relative "event_meter/stores/rollup/file"
+require_relative "event_meter/stores/rollup/postgres"
+require_relative "event_meter/stores/rollup/active_record_postgres"
+require_relative "event_meter/stores/rollup/redis"
+
+module EventMeter
+  class << self
+    def start(name, attributes = nil, **keyword_attributes)
+      Event.start(name, attributes, keyword_attributes, started_at: Time.now.utc)
+    rescue StandardError => error
+      Event.failed(error)
+    end
+
+    def configure
+      yield configuration if block_given?
+      configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def process_pending(name, version:, &block)
+      definition = build_report_definition(name, version: version, &block)
+
+      result = Processor.new(
+        configuration: configuration,
+        report_definition: definition,
+        stream_storage: stream_storage,
+        rollup_storage: rollup_storage_for(definition)
+      ).process
+
+      auto_cleanup_history unless result.locked
+      result
+    end
+
+    def cleanup_history(before:, events: nil, interval_state: true)
+      namespaced_rollup_storage.cleanup_history(
+        before: time_value(before),
+        events: Array(events).compact.map(&:to_s),
+        interval_state: interval_state
+      )
+    end
+
+    def summary(name, version:, from: nil, to: nil, by: {})
+      reports(name, version: version).summary(name, version: version, from: from, to: to, by: by)
+    end
+
+    def series(name, version:, from: nil, to: nil, every: :minute, by: {})
+      reports(name, version: version).series(name, version: version, from: from, to: to, every: every, by: by)
+    end
+
+    def compare(name, version:, before:, after:, by: {})
+      reports(name, version: version).compare(name, version: version, before: before, after: after, by: by)
+    end
+
+    def report_definition(name, version:)
+      storage = rollup_storage_for_name(name, version: version)
+      stored = storage.report_definition(name: name, version: version)
+      raise DefinitionNotFoundError, "no definition stored for #{name} v#{version}" unless stored
+
+      ReportDefinition.from_h(stored).to_h
+    end
+
+    def stream_storage
+      configuration.stream_storage
+    end
+
+    def rollup_storage
+      configuration.rollup_storage
+    end
+
+    private
+
+    def auto_cleanup_history
+      AutoCleanup.new(
+        configuration: configuration,
+        rollup_storage: namespaced_rollup_storage
+      ).run
+    end
+
+    def time_value(value)
+      return value.utc if value.respond_to?(:utc)
+      raise ArgumentError unless value.respond_to?(:to_str)
+
+      Time.parse(value.to_str).utc
+    rescue ArgumentError, TypeError, RangeError
+      raise ArgumentError, "time must be a Time or parseable time string"
+    end
+
+    def reports(name, version:)
+      Reports.new(
+        configuration: configuration,
+        rollup_storage: rollup_storage_for_name(name, version: version)
+      )
+    end
+
+    def build_report_definition(name, version:, &block)
+      ReportDefinition.build(name, version: version) do |definition|
+        block.call(definition) if block
+      end
+    end
+
+    def rollup_storage_for(definition)
+      rollup_storage_for_name(definition.name, version: definition.version)
+    end
+
+    def rollup_storage_for_name(name, version:)
+      storage = namespaced_rollup_storage
+      return storage.for_report(name: name, version: version) if storage.respond_to?(:for_report)
+
+      storage
+    end
+
+    def namespaced_rollup_storage
+      storage = rollup_storage
+      return storage.for_namespace(configuration.namespace) if storage.respond_to?(:for_namespace)
+
+      storage
+    end
+  end
+end

data/lib/generators/event_meter/install_generator.rb

@@ -0,0 +1,57 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+require_relative "../../event_meter/rails"
+
+module EventMeter
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :table_prefix,
+        type: :string,
+        default: "event_meter",
+        desc: "PostgreSQL table prefix"
+
+      class_option :namespace,
+        type: :string,
+        default: "event_meter:v1",
+        desc: "EventMeter namespace"
+
+      def copy_migration
+        migration_template(
+          "create_event_meter_tables.rb.erb",
+          "db/migrate/create_event_meter_tables.rb"
+        )
+      end
+
+      def create_initializer
+        template "event_meter.rb.erb", "config/initializers/event_meter.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      private
+
+      def table_prefix
+        options.fetch(:table_prefix)
+      end
+
+      def namespace
+        options.fetch(:namespace)
+      end
+
+      def migration_sql
+        EventMeter::Rails.migration_sql(table_prefix: table_prefix)
+      end
+
+      def indented_migration_sql
+        migration_sql.lines.map { |line| "      #{line}" }.join
+      end
+    end
+  end
+end

data/lib/generators/event_meter/templates/create_event_meter_tables.rb.erb

@@ -0,0 +1,12 @@
+class CreateEventMeterTables < ActiveRecord::Migration[7.0]
+  def up
+    execute <<~SQL
+<%= indented_migration_sql %>    SQL
+  end
+
+  def down
+    drop_table :<%= table_prefix %>_processed_entries, if_exists: true
+    drop_table :<%= table_prefix %>_strings, if_exists: true
+    drop_table :<%= table_prefix %>_rollups, if_exists: true
+  end
+end

data/lib/generators/event_meter/templates/event_meter.rb.erb

@@ -0,0 +1,12 @@
+require "event_meter/rails"
+
+EventMeter::Rails.configure(
+  namespace: "<%= namespace %>",
+  stream_storage: :file,
+  stream_path: Rails.root.join("tmp/event_meter/<%= namespace.tr(':', '-') %>").to_s,
+  rollup_storage: :postgres,
+  table_prefix: "<%= table_prefix %>",
+  stream_sync: :flush,
+  auto_cleanup_history: true,
+  logger: Rails.logger
+)

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: event_meter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Lim
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: time_bucket_stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: EventMeter records application events and turns them into storage-backed
+  metrics for counts, speed, duration, and intervals.
+email:
+- aaron.lim.yu.kwang@gmail.com
+executables:
+- event_meter
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/event_meter
+- lib/event_meter.rb
+- lib/event_meter/auto_cleanup.rb
+- lib/event_meter/cli.rb
+- lib/event_meter/configuration.rb
+- lib/event_meter/errors.rb
+- lib/event_meter/event.rb
+- lib/event_meter/event_payload.rb
+- lib/event_meter/hash_input.rb
+- lib/event_meter/index_key.rb
+- lib/event_meter/keys.rb
+- lib/event_meter/path_name.rb
+- lib/event_meter/processor.rb
+- lib/event_meter/rails.rb
+- lib/event_meter/report_definition.rb
+- lib/event_meter/reports.rb
+- lib/event_meter/rollup.rb
+- lib/event_meter/stores/cleanup_helpers.rb
+- lib/event_meter/stores/file_helpers.rb
+- lib/event_meter/stores/lock_refresher.rb
+- lib/event_meter/stores/namespace.rb
+- lib/event_meter/stores/redis_lock.rb
+- lib/event_meter/stores/rollup/active_record_postgres.rb
+- lib/event_meter/stores/rollup/file.rb
+- lib/event_meter/stores/rollup/postgres.rb
+- lib/event_meter/stores/rollup/redis.rb
+- lib/event_meter/stores/stream/file.rb
+- lib/event_meter/stores/stream/redis.rb
+- lib/event_meter/time_buckets.rb
+- lib/event_meter/version.rb
+- lib/event_meter/write_result.rb
+- lib/generators/event_meter/install_generator.rb
+- lib/generators/event_meter/templates/create_event_meter_tables.rb.erb
+- lib/generators/event_meter/templates/event_meter.rb.erb
+homepage: https://github.com/aaron-lim/event_meter
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/aaron-lim/event_meter
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Small event-based runtime metrics for Ruby applications.
+test_files: []