utrace 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 46ed491afce143bf3ba3d5dc901052b0a14203a242d03b2d71e78f7e5d7c8235
4
+ data.tar.gz: 9f617cb819e87ded61ebba36fdcd1fb454b1df5f3cd663720a4e1ebb3fd0b690
5
+ SHA512:
6
+ metadata.gz: c328834aacb892e790e9bcb49698e68410652370acda9860ccb959fd69238bc5bfa048ccd96e785e195d3608055c69fedd2d6d0990acfa3ce2f63e190cc3684d
7
+ data.tar.gz: 5aeb5a695e025cef8dbb019f90413d8f97e8918ce5ae2712fe65867c1efc85de9f83a3dc5a82693b6fcf68206d83ce9eaa69e960f85fcd0774edae2582a514e6
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ .ruby-version
10
+ *.gem
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at TODO: Write your email address. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in utrace.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,17 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ utrace (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+
10
+ PLATFORMS
11
+ ruby
12
+
13
+ DEPENDENCIES
14
+ utrace!
15
+
16
+ BUNDLED WITH
17
+ 1.17.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 TODO: Write your name
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,45 @@
1
+ # Utrace
2
+
3
+ A framework runs on a variety of trace tools and provides unified interface.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'utrace'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install utrace
20
+
21
+ ## Usage
22
+
23
+ Pick a trace tool:
24
+
25
+ ```ruby
26
+ # none by default
27
+ Utrace.instance = Utrace::None.new
28
+ # opentelemetry
29
+ Utrace.instance = Utrace::Otel.new
30
+ ```
31
+
32
+ Make instrumentation
33
+
34
+ ```ruby
35
+ Utrace.new_span('slow-query') do
36
+ Utrace.add_attrs({user_id: 123})
37
+ Utrace.log_event('step-1-start')
38
+ # ...
39
+ Utrace.log_event('step-2-start')
40
+ # ...
41
+ rescue => e
42
+ Utrace.log_error(e)
43
+ end
44
+ ```
45
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "utrace"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,13 @@
1
+ module Utrace
2
+ class None
3
+ def new_span(name, &block); end
4
+
5
+ def event(name, attrs: nil); end
6
+
7
+ def error(err); end
8
+
9
+ def attrs(attrs); end
10
+
11
+ def trace_id; end
12
+ end
13
+ end
@@ -0,0 +1,40 @@
1
+ module Utrace
2
+ class Otel
3
+ def initialize(name: self.class.name)
4
+ @tracer = OpenTelemetry.tracer_provider.tracer(name)
5
+ end
6
+
7
+ def new_span(name, &block)
8
+ @tracer.in_span(name.to_s) { |_span| block.call }
9
+ end
10
+
11
+ def event(name, attrs: nil)
12
+ ::OpenTelemetry::Trace.current_span.add_event(name, attributes: validate_attrs(attrs))
13
+ end
14
+
15
+ def error(err)
16
+ ::OpenTelemetry::Trace.current_span.record_exception(err)
17
+ end
18
+
19
+ def attrs(attrs)
20
+ attrs = validate_attrs(attrs)
21
+ ::OpenTelemetry::Trace.current_span.add_attributes(attrs)
22
+ end
23
+
24
+ def trace_id
25
+ ::OpenTelemetry::Trace.current_span.context.trace_id.unpack1('H*')
26
+ end
27
+
28
+ private
29
+
30
+ def validate_attrs(attrs)
31
+ return nil unless attrs
32
+
33
+ new_attrs = {}
34
+ attrs.each_pair do |key, value|
35
+ new_attrs[key.to_s] = value if ::OpenTelemetry::SDK::Internal.valid_value?(value)
36
+ end
37
+ new_attrs
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,3 @@
1
+ module Utrace
2
+ VERSION = "0.2.0"
3
+ end
data/lib/utrace.rb ADDED
@@ -0,0 +1,34 @@
1
+ require "utrace/version"
2
+
3
+ require "utrace/none"
4
+ require "utrace/otel"
5
+
6
+ module Utrace
7
+ class << self
8
+ attr_writer :instance
9
+
10
+ def instance
11
+ @instance ||= None.new
12
+ end
13
+
14
+ def new_span(name, &block)
15
+ instance.new_span(name, &block)
16
+ end
17
+
18
+ def event(name, attrs: nil)
19
+ instance.event(name, attrs: attrs)
20
+ end
21
+
22
+ def error(err)
23
+ instance.error(err)
24
+ end
25
+
26
+ def attrs(attrs)
27
+ instance.attrs(attrs)
28
+ end
29
+
30
+ def trace_id
31
+ instance.trace_id
32
+ end
33
+ end
34
+ end
data/utrace.gemspec ADDED
@@ -0,0 +1,24 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "utrace/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "utrace"
8
+ spec.version = Utrace::VERSION
9
+ spec.authors = ["ken"]
10
+ spec.email = ["block24block@gmail.com"]
11
+
12
+ spec.summary = %q{Unified trace tool}
13
+ spec.homepage = "https://github.com/turnon/utrace"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+ end
metadata ADDED
@@ -0,0 +1,58 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: utrace
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - ken
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-03-08 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description:
14
+ email:
15
+ - block24block@gmail.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - ".gitignore"
21
+ - ".travis.yml"
22
+ - CODE_OF_CONDUCT.md
23
+ - Gemfile
24
+ - Gemfile.lock
25
+ - LICENSE.txt
26
+ - README.md
27
+ - Rakefile
28
+ - bin/console
29
+ - bin/setup
30
+ - lib/utrace.rb
31
+ - lib/utrace/none.rb
32
+ - lib/utrace/otel.rb
33
+ - lib/utrace/version.rb
34
+ - utrace.gemspec
35
+ homepage: https://github.com/turnon/utrace
36
+ licenses:
37
+ - MIT
38
+ metadata: {}
39
+ post_install_message:
40
+ rdoc_options: []
41
+ require_paths:
42
+ - lib
43
+ required_ruby_version: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ required_rubygems_version: !ruby/object:Gem::Requirement
49
+ requirements:
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: '0'
53
+ requirements: []
54
+ rubygems_version: 3.0.3
55
+ signing_key:
56
+ specification_version: 4
57
+ summary: Unified trace tool
58
+ test_files: []