Starting to prep for a new release that uses the SDK.

Author: wyhaines

shard.yml

@@ -11,8 +11,9 @@ license: "Apache 2.0"
 dependencies:
   tracer:
     github: wyhaines/tracer.cr
-  opentelemetry-api:
-    github: wyhaines/opentelemetry-api.cr
+  opentelemetry-sdk:
+    github: wyhaines/opentelemetry-sdk.cr
+    branch: main
   defined:
     github: wyhaines/defined.cr
 

spec/instrumentation/crystal_log_spec.cr

@@ -15,6 +15,7 @@ describe Log, tags: "Log" do
   end
 
   it "can log as normal and send attach the log as an event to a span" do
+    checkout_config do
     memory = IO::Memory.new
     OpenTelemetry.configure do |config|
       config.service_name = "Crystal OTel Instrumentation - HTTP::Server"
@@ -25,16 +26,16 @@ describe Log, tags: "Log" do
     message = "I am a message, and there is an active span."
     Log.setup(:info, backend)
 
-    trace = OpenTelemetry.trace
-    trace.in_span("logging test span") do |_span|
+    OpenTelemetry.trace.in_span("logging test span") do |_span|
       Log.info { message }
     end
 
     backend.entries.first.message.should eq message
-    json = JSON.parse(memory.rewind.gets_to_end)
-
-    json["spans"][0]["name"].should eq "logging test span"
-    json["spans"][0]["events"][0]["name"].should eq "Log.INFO"
-    json["spans"][0]["events"][0]["attributes"]["message"].as_s.should contain(message)
+    _client_traces, server_traces = FindJson.from_io(memory)
+    server_traces[0]["spans"][0]["name"].should eq "logging test span"
+    server_traces[0]["spans"][0]["events"].size.should be > 0
+    server_traces[0]["spans"][0]["events"][0]["name"].should eq "Log.INFO"
+    server_traces[0]["spans"][0]["events"][0]["attributes"]["message"].as_s.should contain(message)
   end
 end
+end

spec/log_backend_spec.cr

@@ -1,61 +1,36 @@
 require "./spec_helper"
 require "../src/opentelemetry-instrumentation/log_backend"
 
-class Log
-    class AsyncDispatcher
-      def initialize(buffer_size = 2048)
-        puts "AsyncDispatcher.initialize"
-        previous_def
-        # @channel = Channel({Entry, Backend}).new(buffer_size)
-        # @done = Channel(Nil).new
-        # spawn write_logs
-      end
-
-      private def write_logs
-        while msg = @channel.receive?
-          entry, backend = msg
-          pp entry
-          pp backend
-          pp Fiber.current.current_span
-          backend.write(entry)
-        end
-  
-        @done.send nil
-      end
-    end
-end
-
 describe OpenTelemetry::Instrumentation::LogBackend, tags: ["LogBackend"] do
-  it "should add the log to the existing span" do
-    checkout_config do
-      memory = IO::Memory.new
-      OpenTelemetry.configure do |config|
-        config.service_name = "Crystal OTel Instrumentation - OpenTelemetry::Instrumentation::LogBackend"
-        config.service_version = "1.0.0"
-        config.exporter = OpenTelemetry::Exporter.new(variant: :io, io: memory)
-      end
+  if Spec.tags.try(&.includes?("LogBackend"))
+    it "should add the log to the existing span" do
+      checkout_config do
+        memory = IO::Memory.new
+        OpenTelemetry.configure do |config|
+          config.service_name = "Crystal OTel Instrumentation - OpenTelemetry::Instrumentation::LogBackend"
+          config.service_version = "1.0.0"
+          config.exporter = OpenTelemetry::Exporter.new(variant: :io, io: memory)
+        end
 
-      random_source = Random::DEFAULT.base64
-      ::Log.setup(sources: random_source, level: Log::Severity::Trace, backend: OpenTelemetry::Instrumentation::LogBackend.new)
+        random_source = Random::DEFAULT.base64
+        ::Log.setup(sources: random_source, level: Log::Severity::Trace, backend: OpenTelemetry::Instrumentation::LogBackend.new)
 
-      trace = OpenTelemetry.trace
-      trace.in_span("Fake Span") do |_span|
-        exception = Exception.new("Oh no!")
-        ::Log.with_context do
-          ::Log.context.set(context: 42)
-          ::Log.context.set(fiber: Fiber.current.current_span.object_id.to_s)
-          ::Log.for(random_source).warn(exception: exception, &.emit("Oh no!", data: "stuff"))
+        OpenTelemetry.trace.in_span("Fake Span") do |_span|
+          exception = Exception.new("Oh no!")
+          ::Log.with_context do
+            ::Log.context.set(context: 42)
+            ::Log.context.set(fiber: Fiber.current.current_span.object_id.to_s)
+            ::Log.for(random_source).warn(exception: exception, &.emit("Oh no!", data: "stuff"))
+          end
         end
-      end
 
-      client_traces, server_traces = FindJson.from_io(memory)
+        _client_traces, server_traces = FindJson.from_io(memory)
 
-      pp client_traces, server_traces
-      # The following only works if the regular logging is turned on, NOT the log_backend based logging.
-      # traces[0]["spans"][0]["kind"].should eq 1
-      # traces[0]["spans"][0]["name"].should eq "Fake Span"
-      # traces[0]["spans"][0]["events"][0]["attributes"]["data"].should eq "stuff"
-      # traces[0]["spans"][0]["events"][0]["attributes"]["context"].should eq 42
+        server_traces[0]["spans"][0]["kind"].should eq 1
+        server_traces[0]["spans"][0]["name"].should eq "Fake Span"
+        server_traces[0]["spans"][0]["events"][0]["attributes"]["data"].should eq "stuff"
+        server_traces[0]["spans"][0]["events"][0]["attributes"]["context"].should eq 42
+      end
     end
   end
 end

spec/spec_helper.cr

@@ -84,6 +84,11 @@ class FindJson
   end
 end
 
+module Spec
+  # Make the CLI specified tags actually accessible.
+  class_getter tags : Set(String)? = nil
+end
+
 # This helper macro can be used to selectively run only specific specs by turning on their
 # focus in response to an environment variable.
 macro it_may_focus_and_it(description, tags = "", &block)

src/opentelemetry-instrumentation.cr

@@ -1,5 +1,5 @@
 require "defined"
-require "opentelemetry-api"
+require "opentelemetry-sdk"
 require "tracer"
 require "./ext/*"
 require "./opentelemetry-instrumentation/log_backend"

src/opentelemetry-instrumentation/log_backend.cr

@@ -1,4 +1,4 @@
-require "opentelemetry-api"
+require "opentelemetry-sdk"
 require "log"
 require "log/backend"
 
@@ -13,6 +13,10 @@ require "log/backend"
 # Log.builder.bind("*", Log::Severity::Warn, OpenTelemetry::Instrumentation::LogBackend.new)
 # ```
 class OpenTelemetry::Instrumentation::LogBackend < ::Log::Backend
+  def initialize(dispatch_mode = nil)
+    @dispatcher = ::Log::Dispatcher.for(:sync) # There is no reason for it to ever be anything but sync.
+  end
+
   def self.apply_log_entry(entry, event)
     entry.context.each do |key, value|
       if (raw = value.raw).is_a?(ValueTypes)
@@ -39,7 +43,6 @@ class OpenTelemetry::Instrumentation::LogBackend < ::Log::Backend
 
   def write(entry : ::Log::Entry)
     if (span = OpenTelemetry::Trace.current_span)
-      puts "<><><><><><><><><><><><><><><><><><><>"
       span.add_event("Log.#{entry.severity.label}#{" - #{entry.source}" unless entry.source.empty?}") do |event|
         self.class.apply_log_entry(entry, event)
       end

src/opentelemetry/instrumentation/crystal/http_server.cr

@@ -169,7 +169,6 @@ unless_disabled?("OTEL_CRYSTAL_DISABLE_INSTRUMENTATION_HTTP_SERVER") do
                   response.version = request.version
                   response.headers["Connection"] = "keep-alive" if request.keep_alive?
                   context = Context.new(request, response)
-                  puts ">> #{context.object_id.to_s(16)}"
 
                   if span
                     span["http.host"] = request.hostname.to_s