opentelemetry-instrumentation-redis 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 26b7e8579226986dd26597380e0acb245a6ce2f3e255a85a567da7f3e50b6a9c
4
- data.tar.gz: 4cc3ca92dc96ce82404c45dd81648b3ca5974d2df0feaf5b8fbfb6a8c5ddd983
3
+ metadata.gz: 91d520ee35bf02a65866bcd28970e55a938fc8598b2d00596268465537242ec8
4
+ data.tar.gz: 6ef70eb9f8c56c9792b831c82212560232c9097c669b9aacdc3caa566ba2d5b0
5
5
  SHA512:
6
- metadata.gz: 9396b5bf86be53b7dc696ea9f445c7fbcaa23a149f42c783c80d878ad783354dacaee81fcab738335116a67ad30b4fe1fdb841704740df85b971c2167cb72fe1
7
- data.tar.gz: 8bfbe1764db9e7e6a615780243e8ef183074fc0e0ec2207b4307b3097369cf0ffe02ec2ee46254f443115738e41fc59dc977bba9e6f35f2a6610b82064e92aa5
6
+ metadata.gz: ea046671b54c38bf743ce7f54bc1be72be456bc0865e6525adce728d2e7c6f0157c878e85c3b28e2183dd28064cfa7dd5144fb4cd68e0fed087475e2ccc817fd
7
+ data.tar.gz: 76458adee32440f760d8d64d036ac720f9e24d4788281f9f49e436c9c7fe05af21e0fac17ff4009dc677c3cdd3a7759dbae4b4f893d89a3372cab21b107c4ff9
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Redis Instrumentation
3
+ --markup=markdown
4
+ --main=README.md
5
+ ./lib/opentelemetry/instrumentation/**/*.rb
6
+ ./lib/opentelemetry/instrumentation.rb
7
+ -
8
+ README.md
9
+ CHANGELOG.md
@@ -1,5 +1,10 @@
1
1
  # Release History: opentelemetry-instrumentation-redis
2
2
 
3
+ ### v0.7.0 / 2020-10-07
4
+
5
+ * DOCS: Added redis documentation
6
+ * DOCS: Standardize toplevel docs structure and readme
7
+
3
8
  ### v0.6.0 / 2020-09-10
4
9
 
5
10
  * (No significant changes)
@@ -0,0 +1,53 @@
1
+ # OpenTelemetry Redis Instrumentation
2
+
3
+ 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.
4
+
5
+ ## How do I get started?
6
+
7
+ Install the gem using:
8
+
9
+ ```
10
+ gem install opentelemetry-instrumentation-redis
11
+ ```
12
+
13
+ Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-redis` in your `Gemfile`.
14
+
15
+ ## Usage
16
+
17
+ To install the instrumentation, call `use` with the name of the instrumentation.
18
+
19
+ ```ruby
20
+ OpenTelemetry::SDK.configure do |c|
21
+ c.use 'OpenTelemetry::Instrumentation::Redis'
22
+ end
23
+ ```
24
+
25
+ Alternatively, you can also call `use_all` to install all the available instrumentation.
26
+
27
+ ```ruby
28
+ OpenTelemetry::SDK.configure do |c|
29
+ c.use_all
30
+ end
31
+ ```
32
+
33
+ ## Example
34
+
35
+ 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).
36
+
37
+ ## How can I get involved?
38
+
39
+ The `opentelemetry-instrumentation-redis` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
40
+
41
+ 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].
42
+
43
+ ## License
44
+
45
+ Apache 2.0 license. See [LICENSE][license-github] for more information.
46
+
47
+ [redis-home]: https://redis.io
48
+ [bundler-home]: https://bundler.io
49
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
50
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
51
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
52
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
53
+ [ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
@@ -4,6 +4,12 @@
4
4
  #
5
5
  # SPDX-License-Identifier: Apache-2.0
6
6
 
7
+ # OpenTelemetry is an open source observability framework, providing a
8
+ # general-purpose API, SDK, and related tools required for the instrumentation
9
+ # of cloud-native software, frameworks, and libraries.
10
+ #
11
+ # The OpenTelemetry module provides global accessors for telemetry objects.
12
+ # See the documentation for the `opentelemetry-api` gem for details.
7
13
  module OpenTelemetry
8
14
  # "Instrumentation" are specified by
9
15
  # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
@@ -7,7 +7,7 @@
7
7
  module OpenTelemetry
8
8
  module Instrumentation
9
9
  module Redis
10
- VERSION = '0.6.0'
10
+ VERSION = '0.7.0'
11
11
  end
12
12
  end
13
13
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: opentelemetry-instrumentation-redis
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.0
4
+ version: 0.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenTelemetry Authors
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-09-11 00:00:00.000000000 Z
11
+ date: 2020-10-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 0.6.0
19
+ version: 0.7.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 0.6.0
26
+ version: 0.7.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: appraisal
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -171,8 +171,10 @@ executables: []
171
171
  extensions: []
172
172
  extra_rdoc_files: []
173
173
  files:
174
+ - ".yardopts"
174
175
  - CHANGELOG.md
175
176
  - LICENSE
177
+ - README.md
176
178
  - lib/opentelemetry-instrumentation-redis.rb
177
179
  - lib/opentelemetry/instrumentation.rb
178
180
  - lib/opentelemetry/instrumentation/redis.rb
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
199
201
  - !ruby/object:Gem::Version
200
202
  version: '0'
201
203
  requirements: []
202
- rubygems_version: 3.1.2
204
+ rubygems_version: 3.1.4
203
205
  signing_key:
204
206
  specification_version: 4
205
207
  summary: Redis instrumentation for the OpenTelemetry framework