datadog_thread_tracer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a9269375e08409b1f01256df83467ac65683ff520c8cf3b2f97b3ee65f71ccc
+  data.tar.gz: f9a818c5c1c369903a72b35cf7c3d72cbfc0c2639d923210a8d4612230f74fd0
+SHA512:
+  metadata.gz: '09c27a91709e8da2cb1126452f85e8cc79c888f9eaf957c96c61e9f53b082cdb0a357b854d807a5ac15d4b62fb452088abad146891bdaed922edb02f3403b1ed'
+  data.tar.gz: b7debfd6ee57ac0a3078a9916d420365f62aafc6b615b7cb6e5f03183e17311194e6473e56f08eb348ced002b9fb83f0e683f3810ac311ddf4f20f22f8da2a69

data/.env.example

@@ -0,0 +1 @@
+DD_API_KEY=

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--no-private
+--hide-void-return
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-10
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:3.1.2
+
+WORKDIR /app
+
+COPY . /app
+
+RUN bundle install

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in datadog_thread_tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 sue445
+
+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,76 @@
+# DatadogThreadTracer
+
+[ddtrace](https://github.com/DataDog/dd-trace-rb) helper to collect traces in thread
+
+[![test](https://github.com/sue445/datadog_thread_tracer/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/datadog_thread_tracer/actions/workflows/test.yml)
+
+## Example
+### Before (without datadog_thread_tracer)
+![before](img/before.png)
+
+### After (with datadog_thread_tracer)
+![after](img/after.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datadog_thread_tracer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install datadog_thread_tracer
+
+## Usage
+```ruby
+require "datadog_thread_tracer"
+
+DatadogThreadTracer.trace do |t|
+  t.trace do
+    # do something. (this block is called in thread)
+  end
+
+  t.trace(trace_name: "trace_name") do
+    # do something. (this block is called in thread)
+  end
+
+  # Pass single arg to Thread
+  t.trace(thread_args: 1) do |a|
+    a
+    #=> 1
+  end
+
+  # Pass multiple args to Thread
+  t.trace(thread_args: [2, 3]) do |a, b|
+    a + b
+    #=> 5
+  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).
+
+## Integration test
+```bash
+cp .env.example .env
+vi .env
+docker-compose up --build
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/datadog_thread_tracer.
+
+## 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/datadog_thread_tracer.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/datadog_thread_tracer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "datadog_thread_tracer"
+  spec.version = DatadogThreadTracer::VERSION
+  spec.authors = ["sue445"]
+  spec.email = ["sue445@sue445.net"]
+
+  spec.summary = "ddtrace helper to collect traces in thread"
+  spec.description = "ddtrace helper to collect traces in thread"
+  spec.homepage = "https://github.com/sue445/datadog_thread_tracer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(?:(?:bin|test|spec|features|img)/|\.(?: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 "ddtrace", ">= 1.0.0"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop_auto_corrector"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/docker-compose.yml

@@ -0,0 +1,37 @@
+version: "3"
+
+services:
+  app:
+    build: .
+    command: bundle exec ruby spec/integration/bench.rb
+    environment:
+      - DD_AGENT_HOST=ddagent
+      - DD_TRACE_SAMPLE_RATE=1.0
+    depends_on:
+      - ddagent
+    volumes:
+      - .:/app
+      - bundle:/app/vendor/bundle
+
+  ddagent:
+    image: gcr.io/datadoghq/agent:latest
+
+    restart: always
+
+    ports:
+      - "8126:8126/tcp"
+
+    environment:
+      - DD_API_KEY
+      - DD_TAGS="service:datadog_thread_tracer"
+      - DD_LOG_LEVEL=WARN
+      - DD_APM_ENABLED=true
+      - DD_APM_NON_LOCAL_TRAFFIC=true
+
+    volumes:
+      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+      - "/proc/:/host/proc/:ro"
+      - "/sys/fs/cgroup/:/host/sys/fs/cgroup:ro"
+
+volumes:
+  bundle:

data/lib/datadog_thread_tracer/thread_tracer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module DatadogThreadTracer
+  # trace within threads
+  class ThreadTracer
+    def initialize
+      @threads = []
+      @thread_count = 0
+    end
+
+    # @param trace_name [String]
+    # @param thread_args [Array,Object] Passed to `Thread.start`
+    # @yield Processes you want to execute in a thread
+    #
+    # @example Pass `trace_name`
+    #   DatadogThreadTracer.trace do |t|
+    #     t.trace(trace_name: "trace_name") do
+    #       # do something. (this block is called in thread)
+    #     end
+    #   end
+    #
+    # @example Pass single arg to `Thread`
+    #   DatadogThreadTracer.trace do |t|
+    #     t.trace(thread_args: 1) do |a|
+    #       a
+    #       #=> 1
+    #     end
+    #   end
+    #
+    # @example Pass multiple args to `Thread`
+    #   DatadogThreadTracer.trace do |t|
+    #     t.trace(thread_args: [2, 3]) do |a, b|
+    #       a + b
+    #       #=> 5
+    #     end
+    #   end
+    #
+    def trace(trace_name: nil, thread_args: [])
+      @thread_count += 1
+      trace_name ||= "thread_#{@thread_count}"
+
+      tracer = Datadog::Tracing.send(:tracer)
+
+      @threads << Thread.start(trace_name, tracer.provider.context, Array(thread_args)) do |name, context, args|
+        tracer = Datadog::Tracing.send(:tracer)
+
+        # c.f. https://github.com/DataDog/dd-trace-rb/issues/1460
+        tracer.provider.context = context
+        Datadog::Tracing.trace(name) do
+          yield(*args)
+        end
+      end
+    end
+
+    def join_threads
+      @threads.each(&:join)
+    end
+  end
+end

data/lib/datadog_thread_tracer/version.rb

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

data/lib/datadog_thread_tracer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "ddtrace"
+
+require_relative "datadog_thread_tracer/version"
+require_relative "datadog_thread_tracer/thread_tracer"
+require "datadog_thread_tracer"
+
+module DatadogThreadTracer # rubocop:disable Style/Documentation
+  class Error < StandardError; end
+
+  DEFAULT_TRACE_NAME = "DatadogThreadTracer.trace"
+
+  # @param trace_name [String]
+  # @yield Processes you want to execute in a thread
+  # @yieldparam [DatadogThreadTracer::ThreadTracer] t
+  #
+  # @example
+  #   DatadogThreadTracer.trace do |t|
+  #     t.trace do
+  #       # do something. (this block is called in thread)
+  #     end
+  #   end
+  #
+  def self.trace(trace_name = DEFAULT_TRACE_NAME)
+    Datadog::Tracing.trace(trace_name) do
+      t = DatadogThreadTracer::ThreadTracer.new
+
+      yield t
+
+      t.join_threads
+    end
+  end
+end

data/sig/datadog_thread_tracer/thread_tracer.rbs

@@ -0,0 +1,9 @@
+module DatadogThreadTracer
+  class ThreadTracer
+    def initialize: () -> void
+
+    def trace: (?trace_name: string, ?thread_args: untyped) { (*untyped) -> untyped } -> untyped
+
+    def join_threads: () -> untyped
+  end
+end

data/sig/datadog_thread_tracer.rbs

@@ -0,0 +1,11 @@
+module DatadogThreadTracer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
+
+  DEFAULT_TRACE_NAME: ::String
+
+  def self.trace: (string trace_name) { (ThreadTracer) -> untyped } -> untyped
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: datadog_thread_tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rubocop
+  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: rubocop_auto_corrector
+  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: rubocop-performance
+  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: webmock
+  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: yard
+  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: ddtrace helper to collect traces in thread
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- datadog_thread_tracer.gemspec
+- docker-compose.yml
+- lib/datadog_thread_tracer.rb
+- lib/datadog_thread_tracer/thread_tracer.rb
+- lib/datadog_thread_tracer/version.rb
+- sig/datadog_thread_tracer.rbs
+- sig/datadog_thread_tracer/thread_tracer.rbs
+homepage: https://github.com/sue445/datadog_thread_tracer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/datadog_thread_tracer
+  source_code_uri: https://github.com/sue445/datadog_thread_tracer
+  changelog_uri: https://github.com/sue445/datadog_thread_tracer/blob/main/CHANGELOG.md
+  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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ddtrace helper to collect traces in thread
+test_files: []