sentry-opentelemetry 5.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9aaffd9cda5f20379323be1ae47da2e64bc2ec9c1b27d514982925391c9b38c8
+  data.tar.gz: 7e4c3b121b94781318c914ee60f107bd371084edf77e438c14eab736278d02b3
+SHA512:
+  metadata.gz: eda20f66ce75fd0e1457338d6bde1790f473b201801f93e4a81f998c9391c2f3d1a1e55f5702cc079914c05bd0ef613a95f917deea0bf5c8257c2bdbd5707edc
+  data.tar.gz: e8c7c44bcf9efac91692055bd9376cbe5f6ec36e8000f97f96bc32b08fe0a233caa5665e4ea0fd19d357ca9ece6ab177abc763a87284cf03d31de277dc154296

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

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 stan001212@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,24 @@
+source "https://rubygems.org"
+git_source(:github) { |name| "https://github.com/#{name}.git" }
+
+# Specify your gem's dependencies in sentry-ruby.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'simplecov'
+gem "simplecov-cobertura", "~> 1.4"
+gem "rexml"
+
+# opentelemetry_version = ENV["OPENTELEMETRY_VERSION"]
+# opentelemetry_version = "1.2.0" if opentelemetry_version.nil?
+# gem "opentelemetry-sdk", "~> #{opentelemetry_version}"
+
+gem "opentelemetry-sdk"
+gem "opentelemetry-instrumentation-rails"
+
+gem "sentry-ruby", path: "../sentry-ruby"
+
+gem "object_tracer"
+gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sentry
+
+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/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-opentelemetry.gemspec

data/README.md

@@ -0,0 +1,65 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
+</p>
+
+# sentry-opentelemetry, the OpenTelemetry integration for Sentry's Ruby client
+
+---
+
+
+[![Gem Version](https://img.shields.io/gem/v/sentry-opentelemetry.svg)](https://rubygems.org/gems/sentry-opentelemetry)
+![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-opentelemetry%20Test/badge.svg)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
+[![Gem](https://img.shields.io/gem/dt/sentry-opentelemetry.svg)](https://rubygems.org/gems/sentry-opentelemetry/)
+[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-opentelemetry&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-opentelemetry&package-manager=bundler&version-scheme=semver)
+
+
+[Documentation](https://docs.sentry.io/platforms/ruby/guides/opentelemetry/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
+
+
+## Getting Started
+
+### Install
+
+```ruby
+gem "sentry-ruby"
+gem "sentry-rails"
+gem "sentry-opentelemetry"
+
+gem "opentelemetry-sdk"
+gem "opentelemetry-instrumentation-all"
+```
+
+### Configuration
+
+Initialize Sentry for tracing and set the `instrumenter` to `:otel`.
+```ruby
+# config/initializers/sentry.rb
+
+Sentry.init do |config|
+  config.dsn = "MY_DSN"
+  config.traces_sample_rate = 1.0
+  config.instrumenter = :otel
+end
+```
+
+This will disable all Sentry instrumentation and rely on the chosen OpenTelemetry tracers for creating spans.
+
+Next, configure OpenTelemetry as per your needs and hook in the Sentry span processor and propagator.
+
+```ruby
+# config/initializers/otel.rb
+
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+  c.add_span_processor(Sentry::OpenTelemetry::SpanProcessor.instance)
+end
+
+OpenTelemetry.propagation = Sentry::OpenTelemetry::Propagator.new
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec).tap do |task|
+  task.rspec_opts = "--order rand"
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sentry/opentelemetry"
+
+# 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/sentry/opentelemetry/propagator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sentry
+  module OpenTelemetry
+    class Propagator
+
+      FIELDS = [SENTRY_TRACE_HEADER_NAME, BAGGAGE_HEADER_NAME].freeze
+
+      SENTRY_TRACE_KEY = ::OpenTelemetry::Context.create_key('sentry-trace')
+      SENTRY_BAGGAGE_KEY = ::OpenTelemetry::Context.create_key('sentry-baggage')
+
+      def inject(
+        carrier,
+        context: ::OpenTelemetry::Context.current,
+        setter: ::OpenTelemetry::Context::Propagation.text_map_setter
+      )
+        span_context = ::OpenTelemetry::Trace.current_span(context).context
+        return unless span_context.valid?
+
+        span_map = SpanProcessor.instance.span_map
+        sentry_span = span_map[span_context.hex_span_id]
+        return unless sentry_span
+
+        setter.set(carrier, SENTRY_TRACE_HEADER_NAME, sentry_span.to_sentry_trace)
+
+        baggage = sentry_span.to_baggage
+        setter.set(carrier, BAGGAGE_HEADER_NAME, baggage) if baggage && !baggage.empty?
+      end
+
+      def extract(
+        carrier,
+        context: ::OpenTelemetry::Context.current,
+        getter: ::OpenTelemetry::Context::Propagation.text_map_getter
+      )
+        sentry_trace = getter.get(carrier, SENTRY_TRACE_HEADER_NAME)
+        return context unless sentry_trace
+
+        sentry_trace_data = Transaction.extract_sentry_trace(sentry_trace)
+        return context unless sentry_trace_data
+
+        context = context.set_value(SENTRY_TRACE_KEY, sentry_trace_data)
+        trace_id, span_id, _parent_sampled = sentry_trace_data
+
+        span_context = ::OpenTelemetry::Trace::SpanContext.new(
+          trace_id: [trace_id].pack('H*'),
+          span_id: [span_id].pack('H*'),
+          # we simulate a sampled trace on the otel side and leave the sampling to sentry
+          trace_flags: ::OpenTelemetry::Trace::TraceFlags::SAMPLED,
+          remote: true
+        )
+
+        baggage_header = getter.get(carrier, BAGGAGE_HEADER_NAME)
+
+        baggage = if baggage_header && !baggage_header.empty?
+                    Baggage.from_incoming_header(baggage_header)
+                  else
+                    # If there's an incoming sentry-trace but no incoming baggage header,
+                    # for instance in traces coming from older SDKs,
+                    # baggage will be empty and frozen and won't be populated as head SDK.
+                    Baggage.new({})
+                  end
+
+        baggage.freeze!
+        context = context.set_value(SENTRY_BAGGAGE_KEY, baggage)
+
+        span = ::OpenTelemetry::Trace.non_recording_span(span_context)
+        ::OpenTelemetry::Trace.context_with_span(span, parent_context: context)
+      end
+
+      def fields
+        FIELDS
+      end
+    end
+  end
+end

data/lib/sentry/opentelemetry/span_processor.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Sentry
+  module OpenTelemetry
+    TraceData = Struct.new(:trace_id, :span_id, :parent_span_id, :parent_sampled, :baggage)
+
+    class SpanProcessor < ::OpenTelemetry::SDK::Trace::SpanProcessor
+      include Singleton
+
+      SEMANTIC_CONVENTIONS = ::OpenTelemetry::SemanticConventions::Trace
+      INTERNAL_SPAN_KINDS = %i(client internal)
+
+      # The mapping from otel span ids to sentry spans
+      # @return [Hash]
+      attr_reader :span_map
+
+      def initialize
+        @span_map = {}
+      end
+
+      def on_start(otel_span, parent_context)
+        return unless Sentry.initialized? && Sentry.configuration.instrumenter == :otel
+        return unless otel_span.context.valid?
+        return if from_sentry_sdk?(otel_span)
+
+        trace_data = get_trace_data(otel_span, parent_context)
+
+        sentry_parent_span = @span_map[trace_data.parent_span_id] if trace_data.parent_span_id
+
+        sentry_span = if sentry_parent_span
+          sentry_parent_span.start_child(
+            span_id: trace_data.span_id,
+            description: otel_span.name,
+            start_timestamp: otel_span.start_timestamp / 1e9
+          )
+        else
+          options = {
+            instrumenter: :otel,
+            name: otel_span.name,
+            span_id: trace_data.span_id,
+            trace_id: trace_data.trace_id,
+            parent_span_id: trace_data.parent_span_id,
+            parent_sampled: trace_data.parent_sampled,
+            baggage: trace_data.baggage,
+            start_timestamp: otel_span.start_timestamp / 1e9
+          }
+
+          Sentry.start_transaction(**options)
+        end
+
+        @span_map[trace_data.span_id] = sentry_span
+      end
+
+      def on_finish(otel_span)
+        return unless Sentry.initialized? && Sentry.configuration.instrumenter == :otel
+        return unless otel_span.context.valid?
+
+        sentry_span = @span_map.delete(otel_span.context.hex_span_id)
+        return unless sentry_span
+
+        sentry_span.set_op(otel_span.name)
+
+        if sentry_span.is_a?(Sentry::Transaction)
+          sentry_span.set_name(otel_span.name)
+          sentry_span.set_context(:otel, otel_context_hash(otel_span))
+        else
+          update_span_with_otel_data(sentry_span, otel_span)
+        end
+
+        sentry_span.finish(end_timestamp: otel_span.end_timestamp / 1e9)
+      end
+
+      def clear
+        @span_map = {}
+      end
+
+      private
+
+      def from_sentry_sdk?(otel_span)
+        dsn = Sentry.configuration.dsn
+        return false unless dsn
+
+        if otel_span.name.start_with?("HTTP")
+          # only check client requests, connects are sometimes internal
+          return false unless INTERNAL_SPAN_KINDS.include?(otel_span.kind)
+
+          address = otel_span.attributes[SEMANTIC_CONVENTIONS::NET_PEER_NAME]
+
+          # if no address drop it, just noise
+          return true unless address
+          return true if dsn.host == address
+        end
+
+        false
+      end
+
+      def get_trace_data(otel_span, parent_context)
+        trace_data = TraceData.new
+        trace_data.span_id = otel_span.context.hex_span_id
+        trace_data.trace_id = otel_span.context.hex_trace_id
+
+        unless otel_span.parent_span_id == ::OpenTelemetry::Trace::INVALID_SPAN_ID
+          trace_data.parent_span_id = otel_span.parent_span_id.unpack1("H*")
+        end
+
+        sentry_trace_data = parent_context[Propagator::SENTRY_TRACE_KEY]
+        trace_data.parent_sampled = sentry_trace_data[2] if sentry_trace_data
+
+        trace_data.baggage = parent_context[Propagator::SENTRY_BAGGAGE_KEY]
+
+        trace_data
+      end
+
+      def otel_context_hash(otel_span)
+        otel_context = {}
+        otel_context[:attributes] = otel_span.attributes unless otel_span.attributes.empty?
+
+        resource_attributes = otel_span.resource.attribute_enumerator.to_h
+        otel_context[:resource] = resource_attributes unless resource_attributes.empty?
+
+        otel_context
+      end
+
+      def update_span_with_otel_data(sentry_span, otel_span)
+        sentry_span.set_data('otel.kind', otel_span.kind)
+        otel_span.attributes&.each { |k, v| sentry_span.set_data(k, v) }
+
+        op = otel_span.name
+        description = otel_span.name
+
+        if (http_method = otel_span.attributes[SEMANTIC_CONVENTIONS::HTTP_METHOD])
+          op = "http.#{otel_span.kind}"
+          description = http_method
+
+          peer_name = otel_span.attributes[SEMANTIC_CONVENTIONS::NET_PEER_NAME]
+          description += " #{peer_name}" if peer_name
+
+          target = otel_span.attributes[SEMANTIC_CONVENTIONS::HTTP_TARGET]
+          description += target if target
+
+          status_code = otel_span.attributes[SEMANTIC_CONVENTIONS::HTTP_STATUS_CODE]
+          sentry_span.set_http_status(status_code) if status_code
+        elsif otel_span.attributes[SEMANTIC_CONVENTIONS::DB_SYSTEM]
+          op = "db"
+
+          statement = otel_span.attributes[SEMANTIC_CONVENTIONS::DB_STATEMENT]
+          description = statement if statement
+        end
+
+        sentry_span.set_op(op)
+        sentry_span.set_description(description)
+      end
+    end
+  end
+end

data/lib/sentry/opentelemetry/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sentry
+  module OpenTelemetry
+    VERSION = "5.7.0"
+  end
+end

data/lib/sentry-opentelemetry.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "sentry-ruby"
+require "opentelemetry-sdk"
+
+require "sentry/opentelemetry/version"
+require "sentry/opentelemetry/span_processor"
+require "sentry/opentelemetry/propagator"

data/sentry-opentelemetry.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/sentry/opentelemetry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-opentelemetry"
+  spec.version       = Sentry::OpenTelemetry::VERSION
+  spec.authors = ["Sentry Team"]
+  spec.description = spec.summary = "A gem that provides OpenTelemetry integration for the Sentry error logger"
+  spec.email = "accounts@sentry.io"
+  spec.license = 'MIT'
+  spec.homepage = "https://github.com/getsentry/sentry-ruby"
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.4'
+  spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sentry-ruby", "~> 5.7.0"
+  spec.add_dependency "opentelemetry-sdk", "~> 1.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: sentry-opentelemetry
+version: !ruby/object:Gem::Version
+  version: 5.7.0
+platform: ruby
+authors:
+- Sentry Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A gem that provides OpenTelemetry integration for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-opentelemetry.rb
+- lib/sentry/opentelemetry/propagator.rb
+- lib/sentry/opentelemetry/span_processor.rb
+- lib/sentry/opentelemetry/version.rb
+- sentry-opentelemetry.gemspec
+homepage: https://github.com/getsentry/sentry-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/getsentry/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A gem that provides OpenTelemetry integration for the Sentry error logger
+test_files: []