opentelemetry-instrumentation-restclient 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f50abae344ba70e4962f4d3edc8a58e7c26b6ca7d7f97752802b459d5af0cc42
-  data.tar.gz: 77b152258469441374710ef05a9081e0e780ea5f58ff551e038fc97332889087
+  metadata.gz: fe8b1598398aa2365aa6699012f530e4e5eb4d95a91686307a59c00bb022ef07
+  data.tar.gz: b648206dc4ba1afe62cc9d658146a09445d6716f6b18b913ea2e34e8736b9a99
 SHA512:
-  metadata.gz: 750858c15515f4691acd7e009e0066d3a642cf49dc3c55fe80132674e1b854ad97116a7c51d70887f6f6e957fe18cdc8420819ce1c65aa14a8657f087f9f6e18
-  data.tar.gz: d6d65077d9d48fa3e032856c12525fe50121c25d0776cd69e90a5c916a64c91971f829a9c1716b495945e3e231c56033b8e5b61f87ef727c0c7c5e238d15f06d
+  metadata.gz: c2500eb2e5e9eb0159a5a67c5e3f891d6002055a0ff901c9dbb0fa6062fb4bfbef6a3843228ef647c41307f6bcb9b41593854d9faf779fd81b29fc86b6cb519d
+  data.tar.gz: 994290c0fbf9fa6ce931c8049ec5156e5668d24010acc5d3bfc3ae0f482d0d027c7a8831a0bc6d3a87a2bbff9b0b78c2501d62aa762fb111c46b9332883becb6

data/.yardopts

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

data/CHANGELOG.md

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

data/README.md

@@ -0,0 +1,49 @@
+# OpenTelemetry RestClient Instrumentation
+
+The OpenTelemetry RestClient gem is a community maintained instrumentation for the [RestClient][restclient-home] library.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-restclient
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-restclient` 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::RestClient'
+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-restclient` 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.
+
+[restclient-home]: https://github.com/rest-client/rest-client
+[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/restclient/version.rb

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

metadata

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