dyndnsd 3.4.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6103d147e0009badc20c17fc1019e3a66602ed04cb256216a024b9f464c1f1c3
-  data.tar.gz: bbefd6e7ec3bac69ac6b32c23f52d991699b636393607c22e102f7d6f6799cfd
+  metadata.gz: 9eb3566b683e5a63a61b3f9627faee372f137498652e1d6760f0b4baa4edc986
+  data.tar.gz: 8a412e370ccf739826c79450a6464de68d06e20ae681726c78a3ca97d691b704
 SHA512:
-  metadata.gz: 0d30625375f42ecb9e6ca6db557fe96bc395a3531bf8411c08bc164f239a0ddb27e276a8bd606360670c8f4c2f8f6d8ad0ae095993b76f84b5b82ab9125a34c9
-  data.tar.gz: 0d3da41b59c05e40ba739726d1d8efa03ac7916b1feaad2ce38ab5e635a8298d9fc0a2f30042bd3aeacf3171fffa066b7d048a49c7f6b17b6d626faf21ebac44
+  metadata.gz: bb50e6aa85ca663cea2d504c4aa3d42c6f12b17dca08839886e59ad6b0f0b78f50d7ba97757aa1953555fe61dae02a3d1d83aeb88c27ca9d08d6b9ca95049d76
+  data.tar.gz: 8e6e1395d2e52ea14fae024560d8587457562084ec6767ac817bd7837f686069e33eac7885ba63e633e89adbd0b494200aebd344c4c76b95e0474b68ef1b982a

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 3.4.2 (July 30, 2021)
+
+IMPROVEMENTS:
+
+- move from OpenTracing to OpenTelemetry for experimental tracing feature
+
+OTHER:
+
+- re-release 3.4.1 to rebuild Docker image with security vulnerabilities fixes
+- adopt Renovate for dependency updates
+
 ## 3.4.1 (April 15, 2021)
 
 OTHER:

data/README.md

@@ -271,9 +271,9 @@ users:
 
 ### Tracing (experimental)
 
-For tracing, dyndnsd.rb is instrumented using the [OpenTracing](http://opentracing.io/) framework and will emit span tracing data for the most important operations happening during the request/response cycle. Using a middleware for Rack allows handling incoming OpenTracing span information properly.
+For tracing, dyndnsd.rb is instrumented using the [OpenTelemetry](https://opentelemetry.io/docs/ruby/) framework and will emit span tracing data for the most important operations happening during the request/response cycle. Using an [instrumentation for Rack](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/rack) allows handling incoming OpenTelemetry parent span information properly (when desired, turned off by default to reduce attack surface).
 
-Currently, only one OpenTracing-compatible tracer implementation named [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be configured to use with dyndnsd.rb.
+Currently, the [OpenTelemetry trace exporter](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/jaeger) for [CNCF Jaeger](https://github.com/jaegertracing/jaeger) can be enabled via dyndnsd.rb configuration. Alternatively, you can also enable other exporters via the environment variable `OTEL_TRACES_EXPORTER`, e.g. `OTEL_TRACES_EXPORTER=console`.
 
 ```yaml
 host: "0.0.0.0"
@@ -282,11 +282,9 @@ db: "/opt/dyndnsd/db.json"
 domain: "dyn.example.org"
 # enable and configure tracing using the (currently only) tracer jaeger
 tracing:
-  trust_incoming_span: false # default value, change to accept incoming OpenTracing spans as parents
-  jaeger:
-    host: 127.0.0.1 # defaults for host and port of local jaeger-agent
-    port: 6831
-    service_name: "my.dyndnsd.identifier"
+  trust_incoming_span: false # default value, change to accept incoming OpenTelemetry spans as parents
+  service_name: "my.dyndnsd.identifier" # default unset, will be populated by OpenTelemetry
+  jaeger: true # enables the Jaeger AgentExporter
 # configure the updater, here we use command_with_bind_zone, params are updater-specific
 updater:
   name: "command_with_bind_zone"

data/lib/dyndnsd.rb

@@ -8,9 +8,9 @@ require 'json'
 require 'yaml'
 require 'rack'
 require 'metriks'
+require 'opentelemetry/instrumentation/rack'
+require 'opentelemetry/sdk'
 require 'metriks/reporter/graphite'
-require 'opentracing'
-require 'rack/tracer'
 
 require 'dyndnsd/generator/bind'
 require 'dyndnsd/updater/command_with_bind_zone'
@@ -69,7 +69,7 @@ module Dyndnsd
     # @return [Boolean]
     def authorized?(username, password)
       Helper.span('check_authorized') do |span|
-        span.set_tag('dyndnsd.user', username)
+        span.set_attribute('enduser.id', username)
 
         allow = Helper.user_allowed?(username, password, @users)
         if !allow
@@ -112,7 +112,7 @@ module Dyndnsd
 
       Dyndnsd.logger.info 'Starting...'
 
-      # drop priviliges as soon as possible
+      # drop privileges as soon as possible
       # NOTE: first change group than user
       if config['group']
         group = Etc.getgrnam(config['group'])
@@ -170,7 +170,7 @@ module Dyndnsd
     def process_changes(hostnames, myips)
       changes = []
       Helper.span('process_changes') do |span|
-        span.set_tag('dyndnsd.hostnames', hostnames.join(','))
+        span.set_attribute('dyndnsd.hostnames', hostnames.join(','))
 
         hostnames.each do |hostname|
           # myips order is always deterministic
@@ -252,6 +252,8 @@ module Dyndnsd
       Dyndnsd.logger.progname = 'dyndnsd'
       Dyndnsd.logger.formatter = LogFormatter.new
       Dyndnsd.logger.level = config['debug'] ? Logger::DEBUG : Logger::INFO
+
+      OpenTelemetry.logger = Dyndnsd.logger
     end
 
     # @return [void]
@@ -296,16 +298,31 @@ module Dyndnsd
     # @param config [Hash{String => Object}]
     # @return [void]
     private_class_method def self.setup_tracing(config)
-      # configure OpenTracing
-      if config.dig('tracing', 'jaeger')
-        require 'jaeger/client'
-
-        host = config['tracing']['jaeger']['host'] || '127.0.0.1'
-        port = config['tracing']['jaeger']['port'] || 6831
-        service_name = config['tracing']['jaeger']['service_name'] || 'dyndnsd'
-        OpenTracing.global_tracer = Jaeger::Client.build(
-          host: host, port: port, service_name: service_name, flush_interval: 1
-        )
+      # by default do not try to emit any traces until the user opts in
+      ENV['OTEL_TRACES_EXPORTER'] ||= 'none'
+
+      # configure OpenTelemetry
+      OpenTelemetry::SDK.configure do |c|
+        if config.dig('tracing', 'jaeger')
+          require 'opentelemetry/exporter/jaeger'
+
+          c.add_span_processor(
+            OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+              OpenTelemetry::Exporter::Jaeger::AgentExporter.new
+            )
+          )
+        end
+
+        if config.dig('tracing', 'service_name')
+          c.service_name = config['tracing']['service_name']
+        end
+
+        c.service_version = Dyndnsd::VERSION
+        c.use('OpenTelemetry::Instrumentation::Rack')
+      end
+
+      if !config.dig('tracing', 'trust_incoming_span')
+        OpenTelemetry.propagation = OpenTelemetry::Context::Propagation::NoopTextMapPropagator.new
       end
     end
 
@@ -331,8 +348,7 @@ module Dyndnsd
         app = Responder::DynDNSStyle.new(app)
       end
 
-      trust_incoming_span = config.dig('tracing', 'trust_incoming_span') || false
-      app = Rack::Tracer.new(app, trust_incoming_span: trust_incoming_span)
+      app = OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware.new(app)
 
       Rack::Handler::WEBrick.run app, Host: config['host'], Port: config['port']
     end

data/lib/dyndnsd/helper.rb

@@ -45,24 +45,17 @@ module Dyndnsd
     # @param block [Proc]
     # @return [void]
     def self.span(operation, &block)
-      scope = OpenTracing.start_active_span(operation)
-      span = scope.span
-      span.set_tag('component', 'dyndnsd')
-      span.set_tag('span.kind', 'server')
-      begin
+      tracer = OpenTelemetry.tracer_provider.tracer(Dyndnsd.name, Dyndnsd::VERSION)
+      tracer.in_span(
+        operation,
+        attributes: {'component' => 'dyndnsd'},
+        kind: :server
+      ) do |span|
+        Dyndnsd.logger.debug "Creating span ID #{span.context.hex_span_id} for trace ID #{span.context.hex_trace_id}"
         block.call(span)
       rescue StandardError => e
-        span.set_tag('error', true)
-        span.log_kv(
-          event: 'error',
-          'error.kind': e.class.to_s,
-          'error.object': e,
-          message: e.message,
-          stack: e.backtrace&.join("\n") || ''
-        )
+        span.record_exception(e)
         raise e
-      ensure
-        scope.close
       end
     end
   end

data/lib/dyndnsd/updater/command_with_bind_zone.rb

@@ -18,7 +18,7 @@ module Dyndnsd
         return if !db.changed?
 
         Helper.span('updater_update') do |span|
-          span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
+          span.set_attribute('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
 
           # write zone file in bind syntax
           File.open(@zone_file, 'w') { |f| f.write(@generator.generate(db)) }

data/lib/dyndnsd/updater/zone_transfer_server.rb

@@ -35,7 +35,7 @@ module Dyndnsd
       # @return [void]
       def update(db)
         Helper.span('updater_update') do |span|
-          span.set_tag('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
+          span.set_attribute('dyndnsd.updater.name', self.class.name&.split('::')&.last || 'None')
 
           soa_rr = Resolv::DNS::Resource::IN::SOA.new(
             @zone_nameservers[0], @zone_email_address,

data/lib/dyndnsd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dyndnsd
-  VERSION = '3.4.1'
+  VERSION = '3.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dyndnsd
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.2
 platform: ruby
 authors:
 - Christian Nicolai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-dns
@@ -25,75 +25,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: jaeger-client
+  name: metriks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: metriks
+  name: opentelemetry-exporter-jaeger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: opentracing
+  name: opentelemetry-instrumentation-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.0.rc2
 - !ruby/object:Gem::Dependency
-  name: rack-tracer
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -184,56 +184,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.18.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.43.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.43.0
 description: A small, lightweight and extensible DynDNS server written with Ruby and
   Rack.
 email: