sbmt-kafka_producer 2.0.0

data/lib/sbmt/kafka_producer/yabeda_configurer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module KafkaProducer
+    class YabedaConfigurer
+      SIZE_BUCKETS = [1, 10, 100, 1000, 10_000, 100_000, 1_000_000].freeze
+      LATENCY_BUCKETS = [0.0001, 0.001, 0.01, 0.1, 1.0, 10, 100, 1000].freeze
+
+      def self.configure
+        Yabeda.configure do
+          group :kafka_api do
+            counter :calls,
+              tags: %i[client broker api],
+              comment: "API calls"
+            histogram :latency,
+              tags: %i[client broker api],
+              buckets: LATENCY_BUCKETS,
+              comment: "API latency"
+            histogram :request_size,
+              tags: %i[client broker api],
+              buckets: SIZE_BUCKETS,
+              comment: "API request size"
+            histogram :response_size,
+              tags: %i[client broker api],
+              buckets: SIZE_BUCKETS,
+              comment: "API response size"
+            counter :errors,
+              tags: %i[client broker api],
+              comment: "API errors"
+          end
+
+          group :kafka_producer do
+            counter :produced_messages,
+              tags: %i[client topic],
+              comment: "Messages produced"
+            histogram :message_size,
+              tags: %i[client topic],
+              buckets: SIZE_BUCKETS,
+              comment: "Producer message size"
+            histogram :buffer_size,
+              tags: %i[client],
+              buckets: SIZE_BUCKETS,
+              comment: "Producer buffer size"
+            counter :produce_errors,
+              tags: %i[client topic],
+              comment: "Produce errors"
+            counter :deliver_errors,
+              tags: %i[client topic],
+              comment: "Produce deliver error"
+            histogram :deliver_latency,
+              tags: %i[client topic],
+              buckets: LATENCY_BUCKETS,
+              comment: "Produce delivery latency"
+            counter :deliver_messages,
+              tags: %i[client topic],
+              comment: "Total count of delivered messages produced"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/kafka_producer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "waterdrop"
+require "connection_pool"
+require "dry-initializer"
+require "dry/types"
+require "dry-struct"
+require "yabeda"
+require "anyway_config"
+
+require "anyway/rails" if defined?(Rails)
+require_relative "kafka_producer/railtie" if defined?(Rails::Railtie)
+
+module Sbmt
+  module KafkaProducer
+    class << self
+      def logger
+        @logger ||= Logger.new
+      end
+    end
+    class Error < StandardError; end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.push_dir(File.join(__dir__, ".."))
+loader.tag = "sbmt-kafka_producer"
+# Do not load vendors instrumentation components. Those need to be required manually if needed
+loader.ignore("#{__dir__}/kafka_producer/version.rb")
+loader.ignore("#{File.expand_path("../", __dir__)}/generators")
+
+loader.do_not_eager_load("#{__dir__}/kafka_producer/instrumentation/open_telemetry_loader.rb")
+loader.do_not_eager_load("#{__dir__}/kafka_producer/instrumentation/open_telemetry_tracer.rb")
+
+# completely ignore testing helpers
+# because testing.rb just requires some files and does not contain any constants (e.g. Testing) which Zeitwerk expects
+loader.ignore("#{__dir__}/kafka_producer/testing.rb")
+loader.ignore("#{__dir__}/kafka_producer/testing")
+
+loader.setup
+loader.eager_load

data/rubocop/rspec.yml

@@ -0,0 +1,29 @@
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/VariableName:
+  Enabled: false

data/sbmt-kafka_producer.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "lib/sbmt/kafka_producer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sbmt-kafka_producer"
+  spec.license = "MIT"
+  spec.version = Sbmt::KafkaProducer::VERSION
+  spec.authors = ["Sbermarket Ruby-Platform Team"]
+
+  spec.summary = "Ruby gem for producing Kafka messages"
+  spec.description = "This gem is used for producing Kafka messages. It represents a wrapper over Waterdrop gem and is recommended for using as a transport with sbmt-outbox"
+  spec.homepage = "https://github.com/SberMarket-Tech/sbmt-kafka_producer"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "false" # rubocop:disable Gemspec/RequireMFA
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "anyway_config", "~> 2.4"
+  spec.add_dependency "connection_pool"
+  spec.add_dependency "dry-initializer", "~> 3.0"
+  spec.add_dependency "dry-struct"
+  spec.add_dependency "waterdrop", "~> 2.5"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+  spec.add_dependency "yabeda", ">= 0.11"
+
+  spec.add_development_dependency "appraisal", ">= 2.4"
+  spec.add_development_dependency "bundler", ">= 2.1"
+  spec.add_development_dependency "combustion", ">= 1.3"
+  spec.add_development_dependency "opentelemetry-sdk"
+  spec.add_development_dependency "opentelemetry-api", ">= 0.17.0"
+  spec.add_development_dependency "opentelemetry-common", ">= 0.17.0"
+  spec.add_development_dependency "opentelemetry-instrumentation-base", ">= 0.17.0"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rails", ">= 5.2"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", ">= 0.6"
+  spec.add_development_dependency "rspec-rails", ">= 4.0"
+  spec.add_development_dependency "rubocop-rails", ">= 2.5"
+  spec.add_development_dependency "rubocop-rspec", ">= 2.11"
+  spec.add_development_dependency "sentry-ruby", "> 5.16"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "standard", ">= 1.12"
+end

metadata

@@ -0,0 +1,427 @@
+--- !ruby/object:Gem::Specification
+name: sbmt-kafka_producer
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Sbermarket Ruby-Platform Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  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: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  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: waterdrop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  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'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: This gem is used for producing Kafka messages. It represents a wrapper
+  over Waterdrop gem and is recommended for using as a transport with sbmt-outbox
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dip.yml
+- docker-compose.yml
+- lefthook-local.dip_example.yml
+- lefthook.yml
+- lib/generators/kafka_producer/concerns/configuration.rb
+- lib/generators/kafka_producer/install/USAGE
+- lib/generators/kafka_producer/install/install_generator.rb
+- lib/generators/kafka_producer/install/templates/kafka_producer.yml
+- lib/generators/kafka_producer/outbox_producer/USAGE
+- lib/generators/kafka_producer/outbox_producer/outbox_producer_generator.rb
+- lib/generators/kafka_producer/producer/USAGE
+- lib/generators/kafka_producer/producer/producer_generator.rb
+- lib/generators/kafka_producer/producer/templates/producer.rb.erb
+- lib/sbmt/kafka_producer.rb
+- lib/sbmt/kafka_producer/base_producer.rb
+- lib/sbmt/kafka_producer/config/auth.rb
+- lib/sbmt/kafka_producer/config/kafka.rb
+- lib/sbmt/kafka_producer/config/producer.rb
+- lib/sbmt/kafka_producer/error_tracker.rb
+- lib/sbmt/kafka_producer/instrumentation/open_telemetry_loader.rb
+- lib/sbmt/kafka_producer/instrumentation/open_telemetry_tracer.rb
+- lib/sbmt/kafka_producer/instrumentation/tracing_middleware.rb
+- lib/sbmt/kafka_producer/instrumentation/yabeda_metrics_listener.rb
+- lib/sbmt/kafka_producer/kafka_client_factory.rb
+- lib/sbmt/kafka_producer/logger.rb
+- lib/sbmt/kafka_producer/outbox_producer.rb
+- lib/sbmt/kafka_producer/outbox_transport_factory.rb
+- lib/sbmt/kafka_producer/railtie.rb
+- lib/sbmt/kafka_producer/testing.rb
+- lib/sbmt/kafka_producer/testing/configure_producer_client.rb
+- lib/sbmt/kafka_producer/types.rb
+- lib/sbmt/kafka_producer/version.rb
+- lib/sbmt/kafka_producer/yabeda_configurer.rb
+- rubocop/rspec.yml
+- sbmt-kafka_producer.gemspec
+homepage: https://github.com/SberMarket-Tech/sbmt-kafka_producer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/SberMarket-Tech/sbmt-kafka_producer
+  source_code_uri: https://github.com/SberMarket-Tech/sbmt-kafka_producer
+  changelog_uri: https://github.com/SberMarket-Tech/sbmt-kafka_producer/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby gem for producing Kafka messages
+test_files: []