apm_traceable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3723420fbeb821a59ef4032f6af31fb5f0ec49faa905c85c2705b37b4c8e15ba
+  data.tar.gz: 75e2e16bc448d23e1bfdeb98d52fe114d8027b767452d11b7a85179c3ff3a7cb
+SHA512:
+  metadata.gz: 11da2030ca3ac8dbab7950d169762ef461dc0bde0a27d2892d1ef3836b6a7b82e3f90d559dcb8814ae02ae475cce7f7c2c49c5a285ecfc2c6021b6c7880cbd3c
+  data.tar.gz: 8202ec5887b20d64d67dbe4120fb4e1f6a3f539346adc9f04a080409e22ac8ea86e810c7a4ffc0cdbab8830dea3ab271310a7694ee690cb5d4a0b561a2955a83

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'apm_traceable.gemspec'
+
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 20
+RSpec/NamedSubject:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apm_traceable.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.24.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 kokuyouwind
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# ApmTraceable
+
+[![Gem Version](https://badge.fury.io/rb/apm_traceable.svg)](https://badge.fury.io/rb/apm_traceable)
+[![Build Status](https://github.com/kokuyouwind/apm_traceable/actions/workflows/main.yml/badge.svg)](https://github.com/kokuyouwind/apm_traceable/actions/workflows/main.yml)
+
+APM で任意区間のトレースを取得するためのライブラリです。
+
+## Installation
+
+この Gem と、利用する APM に対応するアダプタの2つを Gemfile に記述します。
+
+```ruby
+gem 'apm_traceable'
+gem 'apm_traceable-datadog' # Datadogの場合
+```
+
+その後、以下を実行してください。
+
+    $ bundle install
+
+アダプタの設定方法は各 Gem を参照してください。
+組み込みの `ApmTraceable::Adapters::StdoutAdapter` であれば、以下のように設定します。
+
+```ruby
+ApmTraceable.configure do |config|
+  config.adapter = 'stdout'
+end
+```
+
+## Usage
+
+トレースを取得するクラスごとに `ApmTraceable::Tracer` を include します。
+
+その後、トレースを取得したいメソッドを `trace_methods` に指定するか、 `trace_span` を利用してブロックを指定します。
+
+```ruby
+class TracerTestClass
+  include ApmTraceable::Tracer
+
+  trace_methods :test_trace_method
+  def test_trace_method
+    'test'
+  end
+
+  def test_trace_span
+    trace_span('test_name', option1: :value1) do 
+      'test'
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kokuyouwind/apm_traceable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/apm_traceable.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/apm_traceable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'apm_traceable'
+  spec.version = ApmTraceable::VERSION
+  spec.authors = ['kokuyouwind']
+  spec.email = ['kokuyouwind@gmail.com']
+
+  spec.summary = 'APM Traceable'
+  spec.description = 'Tracer to facilitate tracking of method calls, etc. in APM'
+  spec.homepage = 'https://github.com/kokuyouwind/apm_traceable'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/kokuyouwind/apm-traceable'
+  spec.metadata['changelog_uri'] = 'https://github.com/kokuyouwind/apm-traceable'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?: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.metadata['rubygems_mfa_required'] = 'true'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'apm_traceable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/apm_traceable/adapters/base_adapter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ApmTraceable
+  module Adapters
+    # トレース結果を送信するためのアダプターのベースクラス
+    # @abstract
+    class BaseAdapter
+      def trace(trace_name, context_class:, **_options, &_block)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/apm_traceable/adapters/stdout_adapter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+
+module ApmTraceable
+  module Adapters
+    # 標準出力へトレース結果を送るためのアダプター
+    class StdoutAdapter < BaseAdapter
+      def trace(trace_name, context_class:, **_options, &block)
+        result = nil
+        traced_sec = Benchmark.realtime do
+          result = block.call
+        end
+        puts "#{context_class.name}##{trace_name} #{format('%05.6f', traced_sec)}s"
+        result
+      end
+    end
+  end
+end

data/lib/apm_traceable/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ApmTraceable
+  # 設定値を保持するクラス
+  class Configuration
+    class InsufficientConfigurationError < StandardError; end
+
+    def adapter
+      @adapter || raise(InsufficientConfigurationError, 'adapter is not set')
+    end
+
+    def adapter=(args)
+      adapter_name, options = args
+      @adapter = ::ApmTraceable::Adapters.const_get("#{adapter_name.to_s.capitalize}Adapter").new(**(options || {}))
+    end
+  end
+end

data/lib/apm_traceable/tracer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ApmTraceable
+  # トレース対象クラスにincludeして利用するTracerクラス
+  # トレースに利用する以下2メソッドが利用可能になる
+  #   - trace_span: 指定したブロックをトレースする
+  #   - trace_methods: 指定したメソッドの呼び出し全体をトレースする
+  module Tracer
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    # include先クラスで利用可能にするクラスメソッド群のモジュール
+    module ClassMethods
+      # 指定したメソッド群をトレース対象にする.
+      # 引数を複数指定すると、すべてのメソッドがそれぞれトレース対象になる.
+      #
+      # fg.
+      # class Test
+      #   include DatadogTraceable
+      #   trace_methods :method_a, :method_b
+      # end
+      def trace_methods(*method_names)
+        # 計測対象をラップする必要があるため、計測対象メソッドと同名で計測用メソッドを定義したモジュールを生成する
+        wrapper = Module.new do
+          method_names.each do |method_name|
+            define_method method_name do |*args, **options|
+              trace_span(method_name.to_s) { super(*args, **options) }
+            end
+          end
+        end
+
+        # 計測対象メソッドより先に計測用メソッドが呼び出されないといけないため、
+        # prependして継承チェインの先頭側に追加する
+        prepend(wrapper)
+      end
+    end
+
+    # 指定したブロックをトレース対象にする. Datadog::Tracing#trace のラッパーメソッド.
+    # リソース名指定のみ必須で、それ以外に指定したオプションは Datadog::Tracing#trace にそのまま渡される.
+    #
+    # fg.
+    # class Test
+    #   include DatadogTraceable
+    #
+    #   def test_method
+    #     trace_span('mySpan') { some_heavy_process }
+    #   end
+    # end
+    def trace_span(trace_name, **options, &block)
+      ApmTraceable.configuration.adapter.trace(trace_name, context_class: context_class, **options, &block)
+    end
+
+    private
+
+    def context_class
+      # template から呼び出された場合、 self が ActionView::Base のオブジェクトとなるため controller から生成する
+      self.class || controller.class
+    end
+  end
+end

data/lib/apm_traceable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApmTraceable
+  VERSION = '1.0.0'
+end

data/lib/apm_traceable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'apm_traceable/adapters/base_adapter'
+require_relative 'apm_traceable/adapters/stdout_adapter'
+require_relative 'apm_traceable/configuration'
+require_relative 'apm_traceable/tracer'
+require_relative 'apm_traceable/version'
+
+# ApmTraceable 全体のモジュール
+module ApmTraceable
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: apm_traceable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kokuyouwind
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-16 00:00:00.000000000 Z
+dependencies: []
+description: Tracer to facilitate tracking of method calls, etc. in APM
+email:
+- kokuyouwind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apm_traceable.gemspec
+- bin/console
+- bin/setup
+- lib/apm_traceable.rb
+- lib/apm_traceable/adapters/base_adapter.rb
+- lib/apm_traceable/adapters/stdout_adapter.rb
+- lib/apm_traceable/configuration.rb
+- lib/apm_traceable/tracer.rb
+- lib/apm_traceable/version.rb
+homepage: https://github.com/kokuyouwind/apm_traceable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kokuyouwind/apm_traceable
+  source_code_uri: https://github.com/kokuyouwind/apm-traceable
+  changelog_uri: https://github.com/kokuyouwind/apm-traceable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.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: APM Traceable
+test_files: []