opentelemetry-instrumentation-concurrent_ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcbe93326a66368fa21f5aaef7bc7a296ea81ddae4e42ed6565da9be3b32f67
-  data.tar.gz: 5ab2dd92bbae278c2dfd3453aac8b70207c9a70e352229970bf12234e55790e5
+  metadata.gz: 52b4dc369ae868ee5511530e68e69890968bcf5b8ca4e2eb052e81fa34e30e9b
+  data.tar.gz: e20c66073ebe3e43738fe1ce0535379d70b5c1484560d501cbeaddf10389e8e1
 SHA512:
-  metadata.gz: b99e342ee975bbc9bf76fb242da016c7308deac107ddca00698bd31ee2a415a733731ddc56b3df51248698a79ad163f1c3b37b03252c4cc3b92b6218861cf4e5
-  data.tar.gz: 409de34ef07066a25ca3e426763fefa5b917a64879e1a409139913d5fdac37d37f672459bcd9b51e381153cd2698d6777531485ede0228f05038e89c62cec77c
+  metadata.gz: 80461ac15c80f92775ea007d4fee325e007dac8780e8572f040e48391d3667ff0e4e12e3e50ec172f5ed6a3811d03459158705176006c349a608417260977405
+  data.tar.gz: dbab4ddb489150d1b9391eef23ce85cf01cb63d19a0a1c6bdb2f996eb8c01f25cb74b5b07bd0231149532511532d90cc6656c0e92b2d01fcc83d5a758903a0c8

data/.yardopts

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

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History: opentelemetry-instrumentation-concurrent_ruby
 
+### v0.7.0 / 2020-10-07
+
+* DOCS: Added README for concurrent ruby  
+* DOCS: Standardize toplevel docs structure and readme 
+
 ### v0.6.0 / 2020-09-10
 
 * (No significant changes)

data/README.md

@@ -0,0 +1,49 @@
+# OpenTelemetry Concurrent Ruby Instrumentation
+
+The OpenTelemetry Concurrent Ruby gem is a community maintained instrumentation for the [Concurrent Ruby][concurrent-ruby-home]. This is a concurrency toolkit inspired from various languages and classic concurrency patterns. 
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-concurrent_ruby
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-concurrent_ruby` in your `Gemfile`.
+
+## Usage
+
+To install the instrumentation, call `use` with the name of the instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::ConcurrentRuby'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-concurrent_ruby` 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
+
+Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[concurrent-ruby-home]: https://github.com/ruby-concurrency/concurrent-ruby
+[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" are specified by
   # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-concurrent_ruby
 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
@@ -157,8 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-concurrent_ruby.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/concurrent_ruby.rb
@@ -185,7 +187,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: ConcurrentRuby instrumentation for the OpenTelemetry framework