apm_traceable-datadog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cad6c65c6bdc0865f8ecf3cf89a6b858abeb222e4e6ebbfc0f8eed0cb00fccb
+  data.tar.gz: 6a668366c9933e2856a59734c482c47715823f194e73b6333654cde4a8c98d15
+SHA512:
+  metadata.gz: 402533775b87b1ebefc88d6a1501c63b1a15c476120145546dc4edaee11c5fab62a873cbddd7632106355200950a8e60e66b2dc3062eedc76d0d93d9e7bae539
+  data.tar.gz: 5379fa9861dc26226fbb1cfeab0ac51da6e84d111b9299b9a2813da7ed901fc3ac3613a2dd2956b721693024b135d0cf96b5242f23c013455fdc1aec716f5325

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-datadog.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,46 @@
+# ApmTraceable::Datadog
+
+[![Gem Version](https://badge.fury.io/rb/apm_traceable-datadog.svg)](https://badge.fury.io/rb/apm_traceable-datadog)
+[![Build Status](https://github.com/kokuyouwind/apm_traceable-datadog/actions/workflows/main.yml/badge.svg)](https://github.com/kokuyouwind/apm_traceable-datadog/actions/workflows/main.yml)
+
+[APM Traceable gem](https://github.com/kokuyouwind/apm_traceable) の [Datadog APM](https://docs.datadoghq.com/ja/tracing/) 用アダプターです。
+
+## Installation
+
+APM Traceable とこのgemの2つを Gemfile に記述します。
+
+
+```ruby
+gem 'apm_traceable'
+gem 'apm_traceable-datadog' # Datadogの場合
+```
+
+その後、以下を実行してください。
+
+    $ bundle install
+
+アダプタを設定する際、Datadog APM のサービス名を `service_name` に指定してください。
+
+```ruby
+ApmTraceable.configure do |config|
+  config.adapter = 'datadog', { service_name: 'test_service' }
+end
+```
+
+## Usage
+
+利用方法は [APM Traceable の README](https://github.com/kokuyouwind/apm_traceable#usage) を参照してください。
+
+## 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-datadog.
+
+## 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-datadog.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/apm_traceable/datadog/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'apm_traceable-datadog'
+  spec.version = ApmTraceable::Datadog::VERSION
+  spec.authors = ['kokuyouwind']
+  spec.email = ['kokuyouwind@gmail.com']
+
+  spec.summary = 'APM Traceable gem Plugin for Datadog'
+  spec.description = 'APM Traceable gem Plugin for Datadog'
+  spec.homepage = 'https://github.com/kokuyouwind/apm_traceable-datadog'
+  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-datadog'
+  spec.metadata['changelog_uri'] = 'https://github.com/kokuyouwind/apm_traceable-datadog'
+
+  # 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.add_dependency 'activesupport', '>= 7.0.0'
+  spec.add_dependency 'apm_traceable', '>= 1.0.0'
+  spec.add_dependency 'ddtrace', '~> 1.14.0'
+  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/datadog'
+
+# 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/datadog_adapter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'datadog/tracing'
+
+module ApmTraceable
+  module Adapters
+    # Datadogへトレース結果を送るためのアダプター
+    class DatadogAdapter
+      def initialize(service_name:)
+        super()
+
+        @service_name = service_name
+      end
+
+      def trace(trace_name, context_class:, **options, &block)
+        ::Datadog::Tracing.trace(
+          trace_name,
+          **options.merge(service: service_name, resource: resource_name(context_class)),
+          &block
+        )
+      end
+
+      private
+
+      attr_reader :service_name
+
+      def resource_name(context_class)
+        # include 先のクラス名を利用して `admin.users_controller` のような文字列を作る
+        context_class.name.underscore&.tr('/', '.')
+      end
+    end
+  end
+end

data/lib/apm_traceable/datadog/version.rb

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

data/lib/apm_traceable/datadog.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'apm_traceable'
+
+require_relative 'adapters/datadog_adapter'
+require_relative 'datadog/version'
+
+module ApmTraceable
+  # ApmTraceable::Datadog 全体のモジュール
+  module Datadog
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: apm_traceable-datadog
+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:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: apm_traceable
+  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: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+description: APM Traceable gem Plugin for Datadog
+email:
+- kokuyouwind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apm_traceable-datadog.gemspec
+- bin/console
+- bin/setup
+- lib/apm_traceable/adapters/datadog_adapter.rb
+- lib/apm_traceable/datadog.rb
+- lib/apm_traceable/datadog/version.rb
+homepage: https://github.com/kokuyouwind/apm_traceable-datadog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kokuyouwind/apm_traceable-datadog
+  source_code_uri: https://github.com/kokuyouwind/apm_traceable-datadog
+  changelog_uri: https://github.com/kokuyouwind/apm_traceable-datadog
+  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 gem Plugin for Datadog
+test_files: []