codecov_opentelem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60048234598ab361913a778271de941824f809ffbcd10a99a196a633e85fca4c
+  data.tar.gz: 6929cb70f8ad00564757efdc05a5d8e848d1b35652e97e908f9f10f157d1855a
+SHA512:
+  metadata.gz: 3dab6244c860ce0955fda8e3f21b26702a37223601395ab604e175057f3e3db0bb2272ad879da8cf824cde34ccf830e7f6bab35ec513ea9a9d33281ae7a0f5d8
+  data.tar.gz: d7e275ad9f8a9eb9d3b59b428078bd5682e72326e51d1a4a6aef7c9dfd954dceff66f7de705e103f36c296e33f1fdfaa4ea2309d2bb58ac35c1a0e4be9cef936

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+## [0.1.0] - 2022-05-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in codecov_opentelem.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem 'opentelemetry-sdk'
+gem 'opentelemetry-exporter-otlp'
+gem 'opentelemetry-instrumentation-all'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Codecov
+
+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,27 @@
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add codecov_opentelem
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install codecov_opentelem
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/codecov/opentelem-ruby.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/codecov_opentelem.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/codecov_opentelem/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "codecov_opentelem"
+  spec.version = CodecovOpentelem::VERSION
+  spec.authors = ["Ahmed-Elghrbawy"]
+  spec.email = ["hello@codecov.io"]
+
+  spec.summary = "Ruby Opentelemtry"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/codecov/opentelem-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/codecov/opentelem-ruby."
+  spec.metadata["changelog_uri"] = "https://github.com/codecov/opentelem-ruby/blob/master/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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|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"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/codecov_opentelem/coverage_exporter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+require 'net/http'
+
+require 'opentelemetry/sdk'
+require 'coverage'
+
+module CoverageSpanFilter
+  REGEX_NAME = 'name_regex'
+  SPAN_KIND = 'span_kind'
+end
+
+class CodecovCoverageStorageManager
+  def initialize(filters)
+    @filters = filters
+    @inner = {}
+  end
+
+  def start_coverage_for_span(span)
+    if !@filters[CoverageSpanFilter::REGEX_NAME].nil? && @filters[CoverageSpanFilter::REGEX_NAME].match(span.name)
+      return false
+    end
+
+    Coverage.resume
+    true
+  end
+
+  def stop_coverage_for_span(_span)
+    span_id = span.context.span_id
+    Coverage.suspend
+    @inner[span_id] = Coverage.result(stop: false, clear: true)
+  end
+
+  def pop_coverage_for_span(_span)
+    span_id = span.context.span_id
+    @inner.delete(span_id)
+  end
+end
+
+class CodecovCoverageGenerator < SpanProcessor
+  def initialize(cov_storage, sample_rate)
+    super()
+    @cov_storage = cov_storage
+    @sample_rate = sample_rate
+  end
+
+  def on_start(span, _parent_context = nil)
+    @cov_storage.possibly_start_cov_for_span(span) if rand < @sample_rate
+  end
+
+  def on_end(span)
+    @cov_storage.stop_coverage_for_span(span)
+  end
+end
+
+class CoverageExporter < SpanExporter
+  def initialize(cov_storage, repository_token, code, codecov_url, untracked_export_rate)
+    super()
+    @cov_storage = cov_storage
+    @repository_token = repository_token
+    @code = code
+    @codecov_url = codecov_url
+    @untracked_export_rate = untracked_export_rate
+  end
+
+  def export(spans)
+    tracked_spans = []
+    untracked_spans = []
+    spans.each do |span|
+      cov = cov_storage.pop_cov_for_span(span)
+      s = JSON.parse(span)
+      if !cov.nil?
+        s['codecov'] = { 'type' => 'bytes', 'coverage' => cov }
+        tracked_spans.append(s)
+      elsif rand < @untracked_export_rate
+        untracked_spans.append(s)
+      end
+    end
+    return SpanExportResult.SUCCESS if !tracked_spans && !untracked_spans
+
+    res = Net::HTTP.post(URI.join(@codecov_url, '/profiling/uploads'),
+                         { 'code' => @code }.to_json,
+                         'Content-Type' => 'application/json',
+                         'Authorization' => "repotoken #{@repository_token}")
+    return SpanExportResult.FAILURE if res.is_a?(Net::HTTPError)
+
+    location = res.body.raw_upload_location
+    Net::HTTP.put(URI(location),
+                  { 'spans' => tracked_spans,
+                    'untracked' => untracked_spans }.to_json,
+                  'Content-Type' => 'text/plain')
+    SpanExportResult.SUCCESS
+  end
+end

data/lib/codecov_opentelem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodecovOpentelem
+  VERSION = "0.1.0"
+end

data/lib/codecov_opentelem.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "codecov_opentelem/version"
+require 'codecov_opentelem/coverage_exporter'
+
+
+# Entrypoint for getting a span processor/span exporter pair to send profiling data to codecov
+# @param [String] repository_token The profiling authentication token
+# @param [Numeric] sample_rate The sampling rate for codecov, a number from 0 to 1
+# @param [Numeric] untracked_export_rate The export rate for codecov for non-sampled spans, a number from 0 to 1
+# @param [optional Hash] filters A hash of filters for determining which spans should have its coverage tracked
+# @param [optional String] version_identifier The identifier for what software version is being profiled
+# @param [optional String] environment The environment name this profiling is running on
+# @param [optional Boolean] needs_version_creation Whether the "create this version" needs to be called (one can choose
+#     to call it manually beforehand and disable it here)
+# @param [optional String] codecov_url For configuring the endpoint in case the user is in enterprise (not
+#     supported yet). Default is "https://api.codecov.io/"
+# @return [Array<CodecovCoverageGenerator,CoverageExporter>]
+def get_codecov_opentelemetry_instances(
+  repository_token:,
+  sample_rate:,
+  untracked_export_rate:,
+  code:,
+  filters: {},
+  version_identifier: nil,
+  environment: nil,
+  needs_version_creation: true,
+  codecov_url: nil
+)
+  codecov_url = 'https://api.codecov.io' if codecov_url.nil?
+  raise UnableToStartProcessorException, 'Codecov profiling needs a code set' if code.nil?
+
+  if needs_version_creation && version_identifier && environment
+    res = Net::HTTP.post(URI.join(codecov_url, '/profiling/versions'), {
+      'version_identifier' => version_identifier,
+      'environment' => environment,
+      'code' => code
+    }.to_json,
+                         'Content-Type' => 'application/json',
+                         'Authorization' => "repotoken #{repository_token}")
+    raise UnableToStartProcessorException if res.is_a?(Net::HTTPError)
+  end
+  manager = CodecovCoverageStorageManager(filters)
+  generator = CodecovCoverageGenerator(manager, sample_rate)
+  exporter = CoverageExporter(
+    manager, repository_token, code, codecov_url, untracked_export_rate
+  )
+  [generator, exporter]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: codecov_opentelem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed-Elghrbawy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- hello@codecov.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- codecov_opentelem.gemspec
+- lib/codecov_opentelem.rb
+- lib/codecov_opentelem/coverage_exporter.rb
+- lib/codecov_opentelem/version.rb
+homepage: https://github.com/codecov/opentelem-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codecov/opentelem-ruby
+  source_code_uri: https://github.com/codecov/opentelem-ruby.
+  changelog_uri: https://github.com/codecov/opentelem-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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.13
+signing_key: 
+specification_version: 4
+summary: Ruby Opentelemtry
+test_files: []