opentelemetry-instrumentation-dalli 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42889194f8175f062633d899440b58ea0b362b6f4dec479e6dc918441c92001d
-  data.tar.gz: 2d96d67cf8c442f00d54a90094634fea7b12de1924106d11f75f459f5bb3e078
+  metadata.gz: 0c1e6b393e01abad1680a4de749c939d8b5228e1aa76fa9936a95bf5f3e0efa9
+  data.tar.gz: 382ec5392b8632542d468279433d35b052f3f98f6d000e9e0679d11bb6b0e565
 SHA512:
-  metadata.gz: 6d05f610b5b604de834814b4c164c8ec0b6555eb79bd5e499f96f59dc142cca3b633acdfe2cbfce2832ab938c49e09c163199f0f4d1296fbf0002697e7ddd324
-  data.tar.gz: ffb428c4ad3a7e6970b43e843a0275ae4bebd6a946adeca6ef735e16fc0f5c12a96fed1e97a3abbffdc8e1574a1fb30bf3d73843cf8c62b40a5dcc13a51412d2
+  metadata.gz: cbf8f03e88623049092b6aa331f64fc930bc3053aa3903c7f8b72f2bde63973954f9794f29ad3a06feea741d325cfd82345389c302522e89ff92d9219b6bb433
+  data.tar.gz: 931bf3b79f4a4313f58a4ec533fb7f9536218c730947add8dcd059987f3c57ff3d7bc32694b5e9f9af41769d94e449830e1f85ebce64178f74d55378ea4c7309

data/.yardopts

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

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History: opentelemetry-instrumentation-dalli
 
+### v0.11.0 / 2020-12-11
+
+* ADDED: Add peer service config to dalli 
+* ADDED: Move utf8 encoding to common utils 
+* FIXED: Copyright comments to not reference year 
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+
+* ADDED: Add timeout for force_flush and shutdown 
+
+### v0.8.0 / 2020-10-27
+
+* (No significant changes)
+
+### v0.7.0 / 2020-10-07
+
+* DOCS: Standardize toplevel docs structure and readme 
+
 ### v0.6.0 / 2020-09-10
 
 * Initial release.

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # 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/dalli.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry/common'
 
 module OpenTelemetry
   module Instrumentation

data/lib/opentelemetry/instrumentation/dalli/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/dalli/patches/server.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -18,7 +18,7 @@ module OpenTelemetry
               'net.peer.name' => hostname,
               'net.peer.port' => port
             }
-
+            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
             tracer.in_span(operation, attributes: attributes, kind: :client) do
               super
             end
@@ -29,6 +29,10 @@ module OpenTelemetry
           def tracer
             Dalli::Instrumentation.instance.tracer
           end
+
+          def config
+            Dalli::Instrumentation.instance.config
+          end
         end
       end
     end

data/lib/opentelemetry/instrumentation/dalli/utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -47,7 +47,7 @@ module OpenTelemetry
       def format_command(operation, args)
         placeholder = "#{operation} BLOB (OMITTED)"
         command = [operation, *args].join(' ').strip
-        command = utf8_encode(command, binary: true, placeholder: placeholder)
+        command = OpenTelemetry::Common::Utilities.utf8_encode(command, binary: true, placeholder: placeholder)
         truncate(command, CMD_MAX_LEN)
       rescue StandardError => e
         OpenTelemetry.logger.debug("Error sanitizing Dalli operation: #{e}")
@@ -57,24 +57,6 @@ module OpenTelemetry
       def truncate(string, size)
         string.size > size ? "#{string[0...size - 3]}..." : string
       end
-
-      def utf8_encode(str, binary: false, placeholder: STRING_PLACEHOLDER)
-        str = str.to_s
-
-        if binary
-          # This option is useful for "gracefully" displaying binary data that
-          # often contains text such as marshalled objects
-          str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-        elsif str.encoding == ::Encoding::UTF_8
-          str
-        else
-          str.encode(::Encoding::UTF_8)
-        end
-      rescue StandardError => e
-        OpenTelemetry.logger.debug("Error encoding string in UTF-8: #{e}")
-
-        placeholder
-      end
     end
   end
 end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Instrumentation
     module Dalli
-      VERSION = '0.6.0'
+      VERSION = '0.11.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-dalli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
+- README.md
 - lib/opentelemetry-instrumentation-dalli.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/dalli.rb
@@ -169,7 +185,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.11.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/dalli
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.11.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -185,7 +205,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: Dalli instrumentation for the OpenTelemetry framework