pyroscope-otel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c24fd4fe4eaa5a86fdbd3ff36fbb2978bc59373887d549a2adc067e9593ec67
+  data.tar.gz: c743055c7ff448ba3394ca17c30a6e8be888c942cc19dcf3cf971569ce5bbc70
+SHA512:
+  metadata.gz: c953e4562c093bfa84246b4014b9c4d060a6c23bafe7507087241334eb68c6656643d1a6567053fc1690ff04c90c4e4536c7429ad5dbc1673fb97a0a91f473f3
+  data.tar.gz: d1f0f006af18bf0461e74907cce9bc8bbb6d8e105786a8a10e66c3e9c9992fad6ef6516d88704420876ebec8cee6c901193b90c3ff3e1689be6c9f04bc744f54

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - "*"
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Configure git
+        run: |
+          git config user.name "Pyroscope Bot"
+          git config user.email "dmitry+bot@pyroscope.io"
+
+      - name: Release Gem
+        uses: cadwallion/publish-rubygems-action@master
+        if: contains(github.ref, 'refs/tags/v')
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: rake build release:source_control_push release:rubygem_push 

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pyroscope-otel.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    pyroscope-otel (0.1.0)
+      opentelemetry-api (~> 1.1.0)
+      pyroscope (~> 0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    opentelemetry-api (1.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pyroscope (0.5.1-x86_64-linux)
+      ffi
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pyroscope-otel!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tolya Korniltsev
+
+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,40 @@
+# Pyroscope::Otel
+
+Pyroscope can integrate with distributed tracing systems supporting OpenTelemetry standard which allows you to link traces with the profiling data, and find specific lines of code related to a performance issue.
+
+For full documentation visit https://pyroscope.io/docs/ruby-tracing/
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pyroscope-otel'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pyroscope-otel
+
+## Usage
+
+```ruby
+Pyroscope.configure do |config|
+  # Configure pyroscope as described https://pyroscope.io/docs/ruby/
+end
+
+OpenTelemetry::SDK.configure do |config|
+  config.add_span_processor Pyroscope::Otel::SpanProcessor.new(
+    "#{app_name}.cpu", # your app name with ".cpu" suffix, for example rideshare-ruby.cpu
+    pyroscope_endpoint # link to your pyroscope server, for example "http://localhost:4040"
+  )
+  # Configure the rest of opentelemetry as described  https://github.com/open-telemetry/opentelemetry-ruby
+end
+```
+
+## 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/bin/console

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pyroscope
+  module Otel
+    VERSION = "0.1.0"
+  end
+end

data/lib/pyroscope/otel.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "pyroscope"
+# require_relative "otel/version"
+require "uri"
+
+module Pyroscope
+  module Otel
+    class Error < StandardError; end
+
+    # SpanProcessor annotates otel spans with profile_id, profile urls,
+    # baseline urls
+    class SpanProcessor
+      ZERO_SPAN_ID = [0, 0, 0, 0, 0, 0, 0, 0].pack("C*")
+      # pyroscope app name, including ".cpu" suffix.
+      attr_accessor :app_name
+      # http address of pyroscope server for span links
+      attr_accessor :pyroscope_endpoint
+
+      # boolean flag option to annotate spans with profile attributes only on root spans.
+      attr_accessor :root_span_only
+      # boolean flag option to annotate pyroscope profiles with span name
+      attr_accessor :add_span_name
+      # boolean flag option to add profiler url to span attributes
+      attr_accessor :add_url
+
+      # @param [String] app_name - pyroscope app name, including ".cpu" suffix.
+      # @param [String] pyroscope_endpoint - http address of pyroscope server for span links.
+      def initialize(app_name,
+                     pyroscope_endpoint)
+        @app_name = app_name
+        @pyroscope_endpoint = URI.parse(pyroscope_endpoint)
+        @root_span_only = true
+        @add_span_name = true
+        @add_url = true
+      end
+
+      def on_start(span, parent_context)
+        return if @root_span_only && !root_span?(span, parent_context)
+
+        profile_id = profile_id(span)
+
+        labels = { "profile_id": profile_id }
+        labels["span"] = span.name if @add_span_name
+
+        Pyroscope._add_tags(Pyroscope.thread_id, labels)
+
+        annotate_span(profile_id, span)
+      rescue StandardError => e
+        OpenTelemetry.handle_error(exception: e, message: "unexpected error in span.on_start")
+      end
+
+      def on_finish(span)
+        profile_id = span.attributes["pyroscope.profile.id"]
+        return if profile_id.nil?
+
+        labels = { "profile_id": profile_id }
+        labels["span"] = span.name if @add_span_name
+        Pyroscope._remove_tags(Pyroscope.thread_id, labels)
+      end
+
+      def force_flush(_timeout: nil) end
+
+      def shutdown(_timeout: nil) end
+
+      private
+
+      def root_span?(parent, parent_context)
+        return true if parent.parent_span_id == ZERO_SPAN_ID
+
+        parent = OpenTelemetry::Trace.current_span(parent_context)
+        return false if parent.nil?
+
+        parent.context.remote?
+      rescue StandardError => _e
+        false
+      end
+
+      def annotate_span(profile_id, span)
+        span.set_attribute("pyroscope.profile.id", profile_id)
+        span.set_attribute("pyroscope.profile.url", profile_url(profile_id)) if @add_url
+      end
+
+      def profile_id(span)
+        span.context.span_id.unpack("H*")
+      end
+
+      def profile_url(profile_id)
+        url = @pyroscope_endpoint.clone
+        from = Time.now.to_i
+        to = from + 60 * 60
+        url.query = URI.encode_www_form({
+                                          "query": query(profile_id),
+                                          "from": from,
+                                          "until": to
+                                        })
+        url.to_s
+      end
+
+      def query(profile_id)
+        "#{app_name}{profile_id=\"#{profile_id}\"}"
+      end
+    end
+  end
+end

data/pyroscope-otel.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/pyroscope/otel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pyroscope-otel"
+  spec.version       = Pyroscope::Otel::VERSION
+  spec.authors       = ["Tolyan Korniltsev"]
+  spec.email         = ["anatoly@pyroscope.io"]
+
+  spec.summary       = "Pyroscope OTEL integration"
+  spec.description   = "Pyroscope OTEL integration"
+  spec.homepage      = "https://pyroscope.io/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pyroscope-io/otel-profiling-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/pyroscope-io/otel-profiling-ruby/CHANGELOG.md"
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opentelemetry-api", "~> 1.1.0"
+  spec.add_dependency "pyroscope", "~> 0.5.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pyroscope-otel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tolyan Korniltsev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: pyroscope
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Pyroscope OTEL integration
+email:
+- anatoly@pyroscope.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pyroscope/otel.rb
+- lib/pyroscope/otel/version.rb
+- pyroscope-otel.gemspec
+homepage: https://pyroscope.io/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://pyroscope.io/
+  source_code_uri: https://github.com/pyroscope-io/otel-profiling-ruby
+  changelog_uri: https://github.com/pyroscope-io/otel-profiling-ruby/CHANGELOG.md
+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: Pyroscope OTEL integration
+test_files: []