opencensus-datadog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb0b07845e74c490ca55bd81add0a808dd3fc5b5a717a8844a137cebb5611e75
+  data.tar.gz: 1c296eb88966fff0781a7438ca6568467a58679d701100ca217a7b990fb0fc89
+SHA512:
+  metadata.gz: ada9d34c361eb95691cd0c5b84de0ea0739c31288dbd39dc1b4e7b387dd33dd020debd9e1134f3261ae13da24a5be8ecf7539b69c3a20e02ef287824ee00413c
+  data.tar.gz: 6cd7dbbd48d9b1ca8b06b9b62ad1d9d6467dc4a929a7aab190e0782f12f305673b0d86d88016f9106eb14472ddd97c27cadf13f330bacd7b2cc98efdfd4a1a2f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in opencensus-datadog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 munisystem
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Ruby Datadog APM Exporter for OpenCensus
+
+This library is the implementation of [OpenCensus](https://census-instrumentation/opencensus-ruby) exporter that transfer metrics to [Datadog APM](https://www.datadoghq.com/apm/).
+It is depending on Datadog Agent v6.
+
+## Installation
+
+Add `opencensus-datadog` to your application's Gemfile:
+
+```ruby
+gem 'opencensus-datadog'
+```
+
+And install the gem using Bundler:
+
+```shell
+$ bundle install
+```
+
+## Usage
+
+Register this gem using OpenCensus configuration:
+
+
+```ruby
+OpenCensus.configure do |c|
+  c.trace.exporter = OpenCensus::Trace::Integrations::Datadog.new
+end
+```
+
+You can also use the following code if using Ruby on Rails:
+
+```ruby
+config.opencensus.trace.exporter = OpenCensus::Trace::Integrations::Datadog.new
+```
+
+By default, this gem sends metrics to the Datadog Agent at `http://localhost:8126`. You can send to different host or port.
+
+```ruby
+OpenCensus.configure do |c|
+  c.trace.exporter = OpenCensus::Trace::Integrations::Datadog.new \
+    agent_hostname: '192.168.1.1',
+    agent_port: '1234'
+end
+```
+
+## License
+
+This project is releases under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opencensus/datadog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/opencensus-datadog.rb

@@ -0,0 +1 @@
+require 'opencensus/datadog'

data/lib/opencensus/datadog.rb

@@ -0,0 +1,10 @@
+module Opencensus
+  module Datadog
+  end
+end
+
+require 'opencensus/datadog/version'
+require 'opencensus/trace/exporters/datadog'
+
+require 'thread'
+require 'logger'

data/lib/opencensus/datadog/version.rb

@@ -0,0 +1,5 @@
+module OpenCensus
+  module Datadog
+    VERSION = "0.1.0"
+  end
+end

data/lib/opencensus/trace/exporters/datadog.rb

@@ -0,0 +1,70 @@
+require 'logger'
+
+require 'opencensus/trace/exporters/datadog/transport'
+require 'opencensus/trace/exporters/datadog/worker'
+require 'opencensus/trace/exporters/datadog/converter'
+require 'opencensus/trace/exporters/datadog/buffer'
+
+module OpenCensus
+  module Trace
+    module Exporters
+      class Datadog
+        DEFAULT_SERVICE = 'opencensus-app'.freeze
+
+        def self.log
+          unless defined? @logger
+            @logger = Logger.new(STDOUT)
+            @logger.level = Logger::WARN
+          end
+          @logger
+        end
+
+        def initialize(options = {})
+          # create HTTP client for sending spans do Datadog Agent
+          agent_hostname = options.fetch(:agent_hostname, nil)
+          port = options.fetch(:port, nil)
+          @transport = Transport.new(agent_hostname, port)
+
+          # worker parameters
+          @max_buffer_size = options.fetch(:buffer_size, 1000)
+          @flush_interval = options.fetch(:flush_interval, 1)
+
+          # traces metadata
+          @service_name = options.fetch(:service, DEFAULT_SERVICE)
+
+          # each processes have one worker thread
+          @mutex_after_fork = Mutex.new
+          @pid = nil
+          @worker = nil
+        end
+
+        def start
+          @pid = Process.pid
+          @worker = Worker.new(@transport, @max_buffer_size, @flush_interval, @service_name)
+          @worker.start()
+        end
+
+        def shutdown!
+          return if @worker.nil?
+          @worker.stop
+        end
+
+        def export(spans)
+          return nil if spans.nil? || spans.empty?
+
+          # create worker thread if not exist in this process
+          pid = Process.pid
+          if pid != @pid
+            @mutex_after_fork.synchronize do
+              start() if pid != @pid
+            end
+          end
+
+          spans.each do |span|
+            @worker.enqueue(span)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/trace/exporters/datadog/buffer.rb

@@ -0,0 +1,48 @@
+module OpenCensus
+  module Trace
+    module Exporters
+      class Datadog
+        class SpanBuffer
+          def initialize(max_size)
+            @max_size = max_size
+            @spans = []
+            @mutex = Mutex.new()
+            @closed = false
+          end
+
+          def push(span)
+            @mutex.synchronize do
+              return if @closed
+              len = @spans.length
+              if len < @max_size || @max_size <= 0
+                return @spans << span
+              else
+                Datadog.log.error("[datadog-exporter] failed to write span into buffer due to exceeding by max buffer size")
+              end
+            end
+          end
+
+          def empty?
+            @mutex.synchronize do
+              return @spans.empty?
+            end
+          end
+
+          def pop
+            @mutex.synchronize do
+              spans = @spans
+              @spans = []
+              return spans
+            end
+          end
+
+          def close
+            @mutex.synchronize do
+              @closed = true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/trace/exporters/datadog/converter.rb

@@ -0,0 +1,120 @@
+require 'opencensus'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/ext/priority'
+require 'ddtrace/ext/errors'
+
+module OpenCensus
+  module Trace
+    module Exporters
+      class Datadog
+        class Converter
+
+          DATADOG_MAX_TRACE_ID = 0xffff_ffff_ffff_ffff
+
+          DATADOG_SPAN_TYPE_KEY = 'span.type'.freeze
+          DATADOG_SERVICE_NAME_KEY = 'service.name'.freeze
+          DATADOG_RESOURCE_NAME_KEY = 'resource.name'.freeze
+          DATADOG_SAMPLING_PRIORITY_KEY = ::Datadog::Ext::DistributedTracing::SAMPLING_PRIORITY_KEY
+
+          STATUS_DESCRIPTION_KEY = 'opencensus.status_description'.freeze
+
+          CANONICAL_CODES = [
+            'ok',
+            'cancelled',
+            'unknown',
+            'invalid_argument',
+            'deadline_exceeded',
+            'not_found',
+            'already_exists',
+            'permission_denied',
+            'resource_exhausted',
+            'failed_precondition',
+            'aborted',
+            'out_of_range',
+            'unimplemented',
+            'internal',
+            'unavailable',
+            'data_loss',
+            'unauthenticated'
+          ]
+
+          def initialize(service)
+            @service = service
+          end
+
+          def convert_span(span)
+            dd_span = {
+              span_id: span.span_id.to_i(16),
+              parent_id: span.parent_span_id.to_i(16),
+              trace_id: (span.trace_id.to_i(16) & DATADOG_MAX_TRACE_ID),
+              name: span.name.to_s,
+              service: @service,
+              resource: span.name.to_s,
+              type: span_type(span.kind.to_s),
+              meta: {},
+              metrics: {},
+              error: 0,
+              start: (span.start_time.to_f * 1e9).to_i,
+              duration: ((span.end_time.to_f - span.start_time.to_f) * 1e9).to_i,
+            }
+
+            dd_span[:metrics][DATADOG_SAMPLING_PRIORITY_KEY] = ::Datadog::Ext::Priority::AUTO_KEEP
+
+            convert_status(dd_span, span.status)
+
+            span.attributes.each do |k, v|
+              case v
+              when Integer
+                if k == DATADOG_SAMPLING_PRIORITY_KEY
+                  dd_span[:metrics][DATADOG_SAMPLING_PRIORITY_KEY] = v
+                else
+                  dd_span[:metrics][k] = v
+                end
+              when ::OpenCensus::Trace::TruncatableString
+                case k
+                when DATADOG_SPAN_TYPE_KEY
+                  dd_span[:type] = v.to_s
+                when DATADOG_SERVICE_NAME_KEY
+                  dd_span[:service] = v.to_s
+                when DATADOG_RESOURCE_NAME_KEY
+                  dd_span[:resource] = v.to_s
+                else
+                  dd_span[:meta][k] = v.to_s
+                end
+              else
+                dd_span[:meta][k] = v.to_s
+              end
+            end
+
+            dd_span
+          end
+
+          def convert_status(dd_span, status)
+            status_key = STATUS_DESCRIPTION_KEY
+            return if status.nil?
+            if status.code != 0 then
+              status_key = ::Datadog::Ext::Errors::MSG
+              dd_span[:error] = 1
+              code = status.code.to_i
+              return if code < 0 || code >= CANONICAL_CODES.length
+              dd_span[:meta][status_key] = CANONICAL_CODES[code]
+            end
+            dd_span[:meta][status_key] = status.message.to_s unless status.message.empty?
+            return
+          end
+
+          def span_type(kind)
+            case kind
+            when OpenCensus::Trace::Span::SERVER
+              'server'
+            when OpenCensus::Trace::Span::CLIENT
+              'client'
+            else
+              ''
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/trace/exporters/datadog/transport.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+
+module OpenCensus
+  module Trace
+    module Exporters
+      class Datadog
+        class Transport
+          DEFAULT_HOSTNAME = '127.0.0.1'.freeze
+          DEFAULT_PORT = '8126'.freeze
+
+          TRACE_ENDPOINT = '/v0.4/traces'.freeze
+          TIMEOUT = 5
+
+          TRACE_COUNT_HEADER = 'X-Datadog-Trace-Count'.freeze
+          RUBY_INTERPRETER = RUBY_VERSION > '1.9' ? RUBY_ENGINE + '-' + RUBY_PLATFORM : 'ruby-' + RUBY_PLATFORM
+          TRACER_VERSION = 'OC/' + OpenCensus::Datadog::VERSION
+
+          def initialize(hostname, port)
+            @hostname = hostname.nil? ? DEFAULT_HOSTNAME : hostname
+            @port = port.nil? ? DEFAULT_PORT : port
+
+            @headers = {}
+            @headers['Datadog-Meta-Lang'] = 'ruby'
+            @headers['Datadog-Meta-Lang-Version'] = RUBY_VERSION
+            @headers['Datadog-Meta-Lang-Interpreter'] = RUBY_INTERPRETER
+            @headers['Datadog-Meta-Tracer-Version'] = TRACER_VERSION
+            @headers['Content-Type'] = 'application/msgpack'
+          end
+
+          def upload(data, count = nil)
+            begin
+              headers = count.nil? ? {} : { TRACE_COUNT_HEADER => count.to_s }
+              headers = headers.merge(@headers)
+              request = Net::HTTP::Post.new(TRACE_ENDPOINT, headers)
+              request.body = data
+
+              response = Net::HTTP.start(@hostname, @port, read_timeout: TIMEOUT) { |http| http.request(request) }
+
+              status_code = response.code.to_i
+              if status_code >= 400 then
+                Datadog.log.error("[daatadog-exporter] #{response.message} (status: #{status_code})")
+              end
+              status_code
+            rescue StandardError => e
+              Datadog.log.error("[daatadog-exporter] failed HTTP request to agent: #{e.message}")
+              500
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/trace/exporters/datadog/worker.rb

@@ -0,0 +1,81 @@
+require 'msgpack'
+
+module OpenCensus
+  module Trace
+    module Exporters
+      class Datadog
+        class Worker
+
+          SHUTDOWN_TIMEOUT = 1
+
+          def initialize(transport, max_buffer_size, flush_interval, service_name)
+            @transport = transport
+            @flush_interval = flush_interval
+            @span_buffer = SpanBuffer.new(max_buffer_size)
+            @converter = Converter.new(service_name)
+            @shutdown = ConditionVariable.new
+            @mutex = Mutex.new
+
+            @worker = nil
+            @run = false
+          end
+
+          def callback_spans
+            return if @span_buffer.empty?
+
+            begin
+              spans = @span_buffer.pop()
+              hash = Hash.new { |h, k| h[k] = [] }
+              spans.each do |span|
+                dd_span = @converter.convert_span(span)
+                hash[dd_span[:trace_id]] << dd_span
+              end
+              traces = hash.map {|key,value| value}
+              count = traces.length
+              @transport.upload(MessagePack.pack(traces), count)
+            rescue StandardError => e
+              Datadog.log.error("[daatadog-exporter] failed to flush spans: #{e}")
+            end
+          end
+
+          def start
+            @mutex.synchronize do
+              return if @run
+              @run = true
+              @worker = Thread.new { perform }
+            end
+          end
+
+          def stop
+            @mutex.synchronize do
+              return unless @run
+              @span_buffer.close
+              @run = false
+              @shutdown.signal
+            end
+            join
+            true
+          end
+
+          def join
+            @worker.join(SHUTDOWN_TIMEOUT)
+          end
+
+          def perform
+            loop do
+              callback_spans
+              @mutex.synchronize do
+                return if !@run && @span_buffer.empty?
+                @shutdown.wait(@mutex, @flush_interval) if @run
+              end
+            end
+          end
+
+          def enqueue(span)
+            @span_buffer.push(span)
+          end
+        end
+      end
+    end
+  end
+end

data/opencensus-datadog.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "opencensus/datadog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "opencensus-datadog"
+  spec.version       = OpenCensus::Datadog::VERSION
+  spec.authors       = ["Yuichi Saito"]
+  spec.email         = ["munisystem@gmail.com"]
+
+  spec.summary       = "Datadog APM exporter for OpenCensus"
+  spec.description   = "Datadog APM exporter for OpenCensus"
+  spec.homepage      = "https://github.com/munisystem/opencensus-datadog"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'msgpack'
+  spec.add_dependency 'opencensus'
+  spec.add_dependency 'ddtrace'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: opencensus-datadog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuichi Saito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opencensus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Datadog APM exporter for OpenCensus
+email:
+- munisystem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opencensus-datadog.rb
+- lib/opencensus/datadog.rb
+- lib/opencensus/datadog/version.rb
+- lib/opencensus/trace/exporters/datadog.rb
+- lib/opencensus/trace/exporters/datadog/buffer.rb
+- lib/opencensus/trace/exporters/datadog/converter.rb
+- lib/opencensus/trace/exporters/datadog/transport.rb
+- lib/opencensus/trace/exporters/datadog/worker.rb
+- opencensus-datadog.gemspec
+homepage: https://github.com/munisystem/opencensus-datadog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Datadog APM exporter for OpenCensus
+test_files: []