opentelemetry-instrumentation-redis 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b7e8579226986dd26597380e0acb245a6ce2f3e255a85a567da7f3e50b6a9c
-  data.tar.gz: 4cc3ca92dc96ce82404c45dd81648b3ca5974d2df0feaf5b8fbfb6a8c5ddd983
+  metadata.gz: 91d520ee35bf02a65866bcd28970e55a938fc8598b2d00596268465537242ec8
+  data.tar.gz: 6ef70eb9f8c56c9792b831c82212560232c9097c669b9aacdc3caa566ba2d5b0
 SHA512:
-  metadata.gz: 9396b5bf86be53b7dc696ea9f445c7fbcaa23a149f42c783c80d878ad783354dacaee81fcab738335116a67ad30b4fe1fdb841704740df85b971c2167cb72fe1
-  data.tar.gz: 8bfbe1764db9e7e6a615780243e8ef183074fc0e0ec2207b4307b3097369cf0ffe02ec2ee46254f443115738e41fc59dc977bba9e6f35f2a6610b82064e92aa5
+  metadata.gz: ea046671b54c38bf743ce7f54bc1be72be456bc0865e6525adce728d2e7c6f0157c878e85c3b28e2183dd28064cfa7dd5144fb4cd68e0fed087475e2ccc817fd
+  data.tar.gz: 76458adee32440f760d8d64d036ac720f9e24d4788281f9f49e436c9c7fe05af21e0fac17ff4009dc677c3cdd3a7759dbae4b4f893d89a3372cab21b107c4ff9

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Redis 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-redis
 
+### v0.7.0 / 2020-10-07
+
+* DOCS: Added redis documentation 
+* DOCS: Standardize toplevel docs structure and readme 
+
 ### v0.6.0 / 2020-09-10
 
 * (No significant changes)

data/README.md

@@ -0,0 +1,53 @@
+# OpenTelemetry Redis Instrumentation
+
+The OpenTelemetry Redis Ruby gem is a community maintained instrumentation for [Redis][redis-home]. This is an in-memory data store that is used as a database, cache, and message broker.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-redis
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-redis` 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::Redis'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+## Example
+
+An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/redis/example/redis.rb).
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-redis` 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.
+
+[redis-home]: https://redis.io
+[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/redis/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 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-redis.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/redis.rb
@@ -199,7 +201,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: Redis instrumentation for the OpenTelemetry framework