utrace 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46ed491afce143bf3ba3d5dc901052b0a14203a242d03b2d71e78f7e5d7c8235
+  data.tar.gz: 9f617cb819e87ded61ebba36fdcd1fb454b1df5f3cd663720a4e1ebb3fd0b690
+SHA512:
+  metadata.gz: c328834aacb892e790e9bcb49698e68410652370acda9860ccb959fd69238bc5bfa048ccd96e785e195d3608055c69fedd2d6d0990acfa3ce2f63e190cc3684d
+  data.tar.gz: 5aeb5a695e025cef8dbb019f90413d8f97e8918ce5ae2712fe65867c1efc85de9f83a3dc5a82693b6fcf68206d83ce9eaa69e960f85fcd0774edae2582a514e6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in utrace.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    utrace (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  utrace!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,45 @@
+# Utrace
+
+A framework runs on a variety of trace tools and provides unified interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utrace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install utrace
+
+## Usage
+
+Pick a trace tool:
+
+```ruby
+# none by default
+Utrace.instance = Utrace::None.new
+# opentelemetry
+Utrace.instance = Utrace::Otel.new
+```
+
+Make instrumentation
+
+```ruby
+Utrace.new_span('slow-query') do
+  Utrace.add_attrs({user_id: 123})
+  Utrace.log_event('step-1-start')
+  # ...
+  Utrace.log_event('step-2-start')
+  # ...
+rescue => e
+  Utrace.log_error(e)
+end
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "utrace"
+
+# 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/utrace/none.rb

@@ -0,0 +1,13 @@
+module Utrace
+  class None
+    def new_span(name, &block); end
+
+    def event(name, attrs: nil); end
+
+    def error(err); end
+
+    def attrs(attrs); end
+
+    def trace_id; end
+  end
+end

data/lib/utrace/otel.rb

@@ -0,0 +1,40 @@
+module Utrace
+  class Otel
+    def initialize(name: self.class.name)
+      @tracer = OpenTelemetry.tracer_provider.tracer(name)
+    end
+
+    def new_span(name, &block)
+      @tracer.in_span(name.to_s) { |_span| block.call }
+    end
+
+    def event(name, attrs: nil)
+      ::OpenTelemetry::Trace.current_span.add_event(name, attributes: validate_attrs(attrs))
+    end
+
+    def error(err)
+      ::OpenTelemetry::Trace.current_span.record_exception(err)
+    end
+
+    def attrs(attrs)
+      attrs = validate_attrs(attrs)
+      ::OpenTelemetry::Trace.current_span.add_attributes(attrs)
+    end
+
+    def trace_id
+      ::OpenTelemetry::Trace.current_span.context.trace_id.unpack1('H*')
+    end
+
+    private
+
+    def validate_attrs(attrs)
+      return nil unless attrs
+
+      new_attrs = {}
+      attrs.each_pair do |key, value|
+        new_attrs[key.to_s] = value if ::OpenTelemetry::SDK::Internal.valid_value?(value)
+      end
+      new_attrs
+    end
+  end
+end

data/lib/utrace/version.rb

@@ -0,0 +1,3 @@
+module Utrace
+  VERSION = "0.2.0"
+end

data/lib/utrace.rb

@@ -0,0 +1,34 @@
+require "utrace/version"
+
+require "utrace/none"
+require "utrace/otel"
+
+module Utrace
+  class << self
+    attr_writer :instance
+
+    def instance
+      @instance ||= None.new
+    end
+
+    def new_span(name, &block)
+      instance.new_span(name, &block)
+    end
+
+    def event(name, attrs: nil)
+      instance.event(name, attrs: attrs)
+    end
+
+    def error(err)
+      instance.error(err)
+    end
+
+    def attrs(attrs)
+      instance.attrs(attrs)
+    end
+
+    def trace_id
+      instance.trace_id
+    end
+  end
+end

data/utrace.gemspec

@@ -0,0 +1,24 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "utrace/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "utrace"
+  spec.version       = Utrace::VERSION
+  spec.authors       = ["ken"]
+  spec.email         = ["block24block@gmail.com"]
+
+  spec.summary       = %q{Unified trace tool}
+  spec.homepage      = "https://github.com/turnon/utrace"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: utrace
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ken
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-08 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- block24block@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/utrace.rb
+- lib/utrace/none.rb
+- lib/utrace/otel.rb
+- lib/utrace/version.rb
+- utrace.gemspec
+homepage: https://github.com/turnon/utrace
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Unified trace tool
+test_files: []