opentelemetry-instrumentation-rack 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554df8fdcc4832dfe5c7af3bedcb7c96003e9cbc0f1ed57f1c8dac2277af64e9
-  data.tar.gz: bb4dea5f452eeed9f0ade6a18c058c99097e9b28094982200f3dfba9f3a3c581
+  metadata.gz: 191bfe0d331f53008ff34cc03eab66439601c8d4ddf5a22d7f465d292958141c
+  data.tar.gz: 17d4406f6f34e8139fc4ec2800c5d914918b399c3edfca3df4b4c5a8ffa3da79
 SHA512:
-  metadata.gz: 07d6f7edf293523eced6ad8faa0bc8df171869dc37fc8c12dfec8aa1880664f94f007ed1f4413e6e862e293c49a84efb2b74427d8573b03c8823a0a19c7724a9
-  data.tar.gz: 2a4198e6881b35a0cba43a676bc87099d40d95b36ff54a094fd1cd1450176c86ec889e2736b100b0d10998d306cf50e666f842bc824b57779f5cdfcbd7daad6f
+  metadata.gz: b252c52e9f68ab707d56bc2d372244ae29a7d5c620744f3bf7c89fd3b76394a052fc6ddb5e10752117bf77e831296e20b0364622347abbe564a43d8a8c64740a
+  data.tar.gz: 1f688dd5befebb804cb384bd1bb3bda4b36d126e2bae90c699e55ea639a7e39099251a67b0611f013100685b2721c701696895a12afa61e4b26114251ee4ce53

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Rack Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-rack
 
+### v0.7.0 / 2020-10-07
+
+* FIXED: Remove superfluous file from Rack gem 
+* DOCS: Added README for Rack Instrumentation 
+* DOCS: Standardize toplevel docs structure and readme 
+
 ### v0.6.0 / 2020-09-10
 
 * (No significant changes)

data/README.md

@@ -0,0 +1,53 @@
+# OpenTelemetry Rack Instrumentation
+
+The Rack instrumentation is a community-maintained instrumentation for the [Rack][rack-home] web server interface.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-rack
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-rack` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::Rack'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+## Examples
+
+Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/rack/example/trace_demonstration.rb)
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-rack` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+## License
+
+The `opentelemetry-instrumentation-rack` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[rack-home]: https://github.com/rack/rack
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

data/lib/opentelemetry/instrumentation.rb

@@ -4,6 +4,12 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
 module OpenTelemetry
   # Instrumentation should be able to handle the case when the library is not installed on a user's system.
   module Instrumentation

data/lib/opentelemetry/instrumentation/rack/middlewares/tracer_middleware.rb

@@ -81,7 +81,7 @@ module OpenTelemetry
             return unless config[:record_frontend_span] && !request_start_time.nil?
 
             span = tracer.start_span('http_server.proxy',
-                                     with_parent_context: extracted_context,
+                                     with_parent: extracted_context,
                                      attributes: {
                                        'start_time' => request_start_time.to_f
                                      },

data/lib/opentelemetry/instrumentation/rack/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Rack
-      VERSION = '0.6.0'
+      VERSION = '0.7.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-rack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -199,11 +199,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-rack.rb
 - lib/opentelemetry/instrumentation.rb
-- lib/opentelemetry/instrumentation/instrumentation.rb
 - lib/opentelemetry/instrumentation/rack.rb
 - lib/opentelemetry/instrumentation/rack/instrumentation.rb
 - lib/opentelemetry/instrumentation/rack/middlewares/tracer_middleware.rb
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rack instrumentation for the OpenTelemetry framework

data/lib/opentelemetry/instrumentation/instrumentation.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2019 OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  # "Instrumentation" are specified by
-  # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
-  #
-  # Instrumentation should be able to handle the case when the library is not installed on a user's system.
-  module Instrumentation
-  end
-end
-
-require_relative './instrumentation/rack'