newrelic-telemetry_sdk 0.1.0

data/lib/newrelic/telemetry_sdk/span.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+# frozen_string_literal: true
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-telemetry-sdk-ruby/blob/main/LICENSE for complete details.
+
+module NewRelic
+  module TelemetrySdk
+    # This class represents a timed operation that is part of a distributed trace.
+    # This operation will be represented as a Span in the New Relic UI.
+    #
+    # @api public
+    class Span
+      include NewRelic::TelemetrySdk::Logger
+
+      attr_accessor :id,
+                    :trace_id,
+                    :start_time,
+                    :duration_ms,
+                    :name,
+                    :parent_id,
+                    :service_name,
+                    :custom_attributes
+
+      # @param id [optional, String]
+      #     A random, unique identifier associated with this specific New Relic span.
+      # @param trace_id [optional, String]
+      #     A random, unique identifier associated with a collection of spans that
+      #     will be grouped together as a trace in the New Relic UI.
+      # @param start_time [optional, Time]
+      #     A Time object corresponding to the start time of the operation represented
+      #     by this span.
+      # @param duration_ms [optional, Integer]
+      #     The duration of the operation represented by this span, in milliseconds.
+      # @param name [optional, String]
+      #     The name of the span.
+      # @param parent_id [optional, String]
+      #     A random, unique identifier associated with the parent of this span.
+      # @param service_name [optional, String]
+      #     The name of the entity that created this span.
+      # @param custom_attributes [optional, Hash]
+      #     Custom attributes that will appear on this span.
+      # @see https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/report-new-relic-format-traces-trace-api#other-attributes Report Traces (New Relic format)
+      #
+      # @api public
+      def initialize id: Util.generate_guid(16),
+                     trace_id: Util.generate_guid(32),
+                     start_time: Util.current_time,
+                     duration_ms: nil,
+                     name: nil,
+                     parent_id: nil,
+                     service_name: nil,
+                     custom_attributes: nil
+
+        @id = id
+        @trace_id = trace_id
+        @start_time = start_time
+        @duration_ms = duration_ms
+        @name = name
+        @parent_id = parent_id
+        @service_name = service_name
+        @custom_attributes = custom_attributes
+      end
+
+      # Mark the operation represented by this Span as finished and calculate is duration.
+      # @param end_time [optional, Time]
+      #     A Time object corresponding to the end time of the operation represented
+      #     by this span.
+      #
+      # @api public
+      def finish end_time: Util.current_time
+        @duration_ms = Util.time_to_ms(end_time - @start_time)
+      rescue => e
+        log_error "Encountered error finishing span", e
+      end
+
+      def to_h
+        data = {
+          :id => @id,
+          :'trace.id' => @trace_id,
+          :timestamp => Util.time_to_ms(@start_time),
+          :attributes => {
+            :'duration.ms' => @duration_ms,
+            :name => @name,
+            :'parent.id' => @parent_id,
+            :'service.name' => @service_name
+          }
+        }
+
+        data[:attributes].merge! @custom_attributes if @custom_attributes
+
+        data
+      rescue => e
+        log_error "Encountered error converting span to hash", e
+      end
+    end
+  end
+end

data/lib/newrelic/telemetry_sdk/util.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+# frozen_string_literal: true
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+
+module NewRelic
+  module TelemetrySdk
+    module Util
+      extend self
+
+      HEX_DIGITS = (0..15).map{|i| i.to_s(16)}
+
+      module_function
+
+      # This method intentionally does not use SecureRandom, because it relies
+      # on urandom, which raises an exception in MRI when the interpreter runs
+      # out of allocated file descriptors.
+      # The guids generated by this method may not be _secure_, but they are
+      # random enough for our purposes.
+      def generate_guid length = 16
+        guid = String.new
+        length.times do |a|
+          guid << HEX_DIGITS[rand(16)]
+        end
+        guid
+      end
+
+      def current_time
+        Time.now
+      end
+
+      def time_to_ms time = current_time
+        (time.to_f * 1000).round
+      end
+    end
+  end
+end

data/lib/newrelic/telemetry_sdk/version.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# frozen_string_literal: true
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-telemetry-sdk-ruby/blob/main/LICENSE for complete details.
+
+module NewRelic
+  module TelemetrySdk
+    VERSION = "0.1.0"
+
+    extend self
+
+    def gem_version
+      Gem::Version.create VERSION
+    end
+  end
+end

data/newrelic-telemetry_sdk.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "newrelic/telemetry_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "newrelic-telemetry_sdk"
+  spec.version       = NewRelic::TelemetrySdk::VERSION
+  spec.authors       = ["Rachel Klein", "Tanna McClure", "Michael Lang"]
+  spec.email         = ["support@newrelic.com"]
+
+  spec.summary       = %q{New Relic Telemetry SDK}
+  spec.description   = <<-EOS
+Send your telemetry data to New Relic, no agent required.
+EOS
+  spec.homepage      = "https://newrelic.com/ruby"
+  spec.licenses      = ['Apache-2.0']
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/newrelic/newrelic-telemetry-sdk-ruby/"
+  spec.metadata["changelog_uri"] = "https://github.com/newrelic/newrelic-telemetry-sdk-ruby/blob/main/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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.11"
+  spec.add_development_dependency "pry-nav", "~> 0.3.0"
+  spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "simplecov", "~> 0.19.0"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-telemetry_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rachel Klein
+- Tanna McClure
+- Michael Lang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+description: 'Send your telemetry data to New Relic, no agent required.
+
+'
+email:
+- support@newrelic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/enhancement.md"
+- ".github/workflows/assignproj.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/scripts/rubygems-authenticate.py"
+- ".github/workflows/scripts/rubygems-publish.rb"
+- ".github/workflows/snyk.yml"
+- ".gitignore"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cla.md
+- examples/external_request/Gemfile
+- examples/external_request/simple.rb
+- examples/external_request/with_harvester.rb
+- lib/newrelic/telemetry_sdk.rb
+- lib/newrelic/telemetry_sdk/buffer.rb
+- lib/newrelic/telemetry_sdk/clients/client.rb
+- lib/newrelic/telemetry_sdk/clients/trace_client.rb
+- lib/newrelic/telemetry_sdk/config.rb
+- lib/newrelic/telemetry_sdk/configurator.rb
+- lib/newrelic/telemetry_sdk/exception.rb
+- lib/newrelic/telemetry_sdk/harvester.rb
+- lib/newrelic/telemetry_sdk/logger.rb
+- lib/newrelic/telemetry_sdk/span.rb
+- lib/newrelic/telemetry_sdk/util.rb
+- lib/newrelic/telemetry_sdk/version.rb
+- newrelic-telemetry_sdk.gemspec
+homepage: https://newrelic.com/ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://newrelic.com/ruby
+  source_code_uri: https://github.com/newrelic/newrelic-telemetry-sdk-ruby/
+  changelog_uri: https://github.com/newrelic/newrelic-telemetry-sdk-ruby/blob/main/CHANGELOG.md
+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.1.4
+signing_key: 
+specification_version: 4
+summary: New Relic Telemetry SDK
+test_files: []