opentelemetry-instrumentation-ethon 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb66b4eba5d2b3fb1cb1570dc09615c5516ddafadb7027f0fa4320cdd757e4e9
-  data.tar.gz: 397ad38265176fb78405ae1a3dece4a5414a668f4177753c091c3c1aec7e847d
+  metadata.gz: 03daf0fd830a610223afad9365d593c897c7ed131c301c5a5ad5d115ce97e519
+  data.tar.gz: 075e588ac402ac54e57b466467cb3632e0a6afed2ad34f2b7882641e0fb65b64
 SHA512:
-  metadata.gz: d7495a8e45867cc5e31df659c09a1d5a8968a3a3e43c963742fcf58b62921d971f562b57d37c5e228224d52ba1c99457a35e26eabf7c2f967ee02b234167f119
-  data.tar.gz: f06ae4520e0d3607b254b90be8b6ba92bea595efe266f1438478af50f7ad3d1d73d79d16c10ae54ade09f9d0814d3b3a55a8399a08375ad68365add101c04df6
+  metadata.gz: d0052a59d72b29787a252190fd28862b4d0220dd783a5cd5c7008d3e7bac987ca2c3bba13da8debac19be2ed031daa10467b570637b561aad6d6c3a1a14c927d
+  data.tar.gz: 00e05594964f1acd786605fdc4680032ccb859282d77bea21164aff7219fea77c32a2b86ac740be26842696a2c875915e859bb3fbf3d9d092480c3fe99af7ded

data/.yardopts

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

data/README.md

@@ -0,0 +1,54 @@
+# Ethon Instrumentation
+
+The ethon instrumentation is a community-maintained instrumentation for the [ethon][ethon-home] HTTP library.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-ethon
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-ethon` to 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::Ethon'
+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 of faraday can be seen in the `./example/ethon.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/ethon/example/ethon.rb)
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-ethon` 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-all` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[ethon]:https://github.com/typhoeus/ethon
+[ethon-home]:https://github.com/typhoeus/ethon
+[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/ethon/patches/easy.rb

@@ -40,7 +40,7 @@ module OpenTelemetry
                 return_code = response_options[:return_code]
                 message = return_code ? ::Ethon::Curl.easy_strerror(return_code) : 'unknown reason'
                 @otel_span.status = OpenTelemetry::Trace::Status.new(
-                  OpenTelemetry::Trace::Status::UNKNOWN_ERROR,
+                  OpenTelemetry::Trace::Status::ERROR,
                   description: "Request has failed: #{message}"
                 )
               else

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

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

metadata

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