Remove support for lazy event creation

README.md

@@ -111,7 +111,7 @@ tracer.in_span('foo') do |span|
   # set an attribute
   span.set_attribute('platform', 'osx')
   # add an event
-  span.add_event(name: 'event in bar')
+  span.add_event('event in bar')
   # create bar as child of foo
   tracer.in_span('bar') do |child_span|
     # inspect the span

api/benchmarks/span_bench.rb

@@ -26,7 +26,7 @@
   end
 
   x.report 'add_event' do
-    span.add_event(name: 'test event', attributes: attributes)
+    span.add_event('test event', attributes: attributes)
   end
 
   x.compare!

api/lib/opentelemetry/trace.rb

@@ -39,7 +39,6 @@ def self.generate_span_id
   end
 end
 
-require 'opentelemetry/trace/event'
 require 'opentelemetry/trace/link'
 require 'opentelemetry/trace/trace_flags'
 require 'opentelemetry/trace/span_context'

api/lib/opentelemetry/trace/span.rb

@@ -58,34 +58,26 @@ def set_attribute(key, value)
       end
       alias []= set_attribute
 
-      # Add an Event to a {Span}. This can be accomplished eagerly or lazily.
-      # Lazy evaluation is useful when the event attributes are expensive to
-      # build and where the cost can be avoided for an unsampled {Span}.
+      # Add an event to a {Span}.
       #
-      # Eager example:
+      # Example:
       #
-      #   span.add_event(name: 'event', attributes: {'eager' => true})
-      #
-      # Lazy example:
-      #
-      #   span.add_event { tracer.create_event(name: 'event', attributes: {'eager' => false}) }
+      #   span.add_event('event', attributes: {'eager' => true})
       #
       # Note that the OpenTelemetry project
       # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md
       # documents} certain "standard event names and keys" which have
       # prescribed semantic meanings.
       #
-      # @param [optional String] name Optional name of the event. This is
-      #   required if a block is not given.
+      # @param [String] name Name of the event.
       # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
       #   attributes One or more key:value pairs, where the keys must be
       #   strings and the values may be (array of) string, boolean or numeric
-      #   type. This argument should only be used when passing in a name.
+      #   type.
       # @param [optional Time] timestamp Optional timestamp for the event.
-      #   This argument should only be used when passing in a name.
       #
       # @return [self] returns itself
-      def add_event(name: nil, attributes: nil, timestamp: nil)
+      def add_event(name, attributes: nil, timestamp: nil)
         self
       end
 

api/test/opentelemetry/trace/span_test.rb

@@ -32,23 +32,19 @@
 
   describe '#add_event' do
     it 'returns self' do
-      _(span.add_event(name: 'event-name')).must_equal(span)
+      _(span.add_event('event-name')).must_equal(span)
     end
 
     it 'accepts a name and attributes' do
-      _(span.add_event(name: 'event-name', attributes: { 'foo' => 'bar' })).must_equal(span)
+      _(span.add_event('event-name', attributes: { 'foo' => 'bar' })).must_equal(span)
     end
 
     it 'accepts array-valued attributes' do
-      _(span.add_event(name: 'event-name', attributes: { 'foo' => [1, 2, 3] })).must_equal(span)
+      _(span.add_event('event-name', attributes: { 'foo' => [1, 2, 3] })).must_equal(span)
     end
 
     it 'accepts a timestamp' do
-      _(span.add_event(name: 'event-name', timestamp: Time.now)).must_equal(span)
-    end
-
-    it 'accepts an event formatter' do
-      _(span.add_event { Object.new }).must_equal(span)
+      _(span.add_event('event-name', timestamp: Time.now)).must_equal(span)
     end
   end
 

exporters/jaeger/README.md

@@ -50,7 +50,7 @@ tracer.in_span('foo') do |span|
   # set an attribute
   span.set_attribute('platform', 'osx')
   # add an event
-  span.add_event(name: 'event in bar')
+  span.add_event('event in bar')
   # create bar as child of foo
   tracer.in_span('bar') do |child_span|
     # inspect the span

exporters/jaeger/test/opentelemetry/exporters/jaeger/exporter/span_encoder_test.rb

@@ -17,7 +17,7 @@
   it 'encodes attributes in events and the span' do
     attributes = { 'akey' => 'avalue' }
     events = [
-      OpenTelemetry::Trace::Event.new(
+      OpenTelemetry::SDK::Trace::Event.new(
         name: 'event', attributes: { 'ekey' => 'evalue' }
       )
     ]
@@ -40,7 +40,7 @@
   it 'encodes array attribute values in events and the span as JSON strings' do
     attributes = { 'akey' => ['avalue'] }
     events = [
-      OpenTelemetry::Trace::Event.new(
+      OpenTelemetry::SDK::Trace::Event.new(
         name: 'event', attributes: { 'ekey' => ['evalue'] }
       )
     ]

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/middlewares/client/tracer_middleware.rb

@@ -20,7 +20,7 @@ def call(_worker_class, job, _queue, _redis_pool)
                 kind: :producer
               ) do |span|
                 OpenTelemetry.propagation.text.inject(job)
-                span.add_event(name: 'created_at', timestamp: job['created_at'])
+                span.add_event('created_at', timestamp: job['created_at'])
                 yield
               end
             end

instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/middlewares/server/tracer_middleware.rb

@@ -21,8 +21,8 @@ def call(_worker, msg, _queue)
                 with_parent_context: parent_context,
                 kind: :consumer
               ) do |span|
-                span.add_event(name: 'created_at', timestamp: msg['created_at'])
-                span.add_event(name: 'enqueued_at', timestamp: msg['enqueued_at'])
+                span.add_event('created_at', timestamp: msg['created_at'])
+                span.add_event('enqueued_at', timestamp: msg['enqueued_at'])
                 yield
               end
             end

sdk/README.md

@@ -41,7 +41,7 @@ tracer.in_span('foo') do |span|
   # set an attribute
   span.set_attribute('platform', 'osx')
   # add an event
-  span.add_event(name: 'event in bar')
+  span.add_event('event in bar')
   # create bar as child of foo
   tracer.in_span('bar') do |child_span|
     # inspect the span

sdk/lib/opentelemetry/sdk/trace.rb

@@ -15,6 +15,7 @@ module Trace
 
 require 'opentelemetry/sdk/trace/samplers'
 require 'opentelemetry/sdk/trace/config'
+require 'opentelemetry/sdk/trace/event'
 require 'opentelemetry/sdk/trace/export'
 require 'opentelemetry/sdk/trace/multi_span_processor'
 require 'opentelemetry/sdk/trace/noop_span_processor'

sdk/lib/opentelemetry/sdk/trace/config/trace_config.rb

@@ -30,13 +30,13 @@ class TraceConfig
           # The global default max number of attributes per {Span}.
           attr_reader :max_attributes_count
 
-          # The global default max number of {OpenTelemetry::Trace::Event}s per {Span}.
+          # The global default max number of {OpenTelemetry::SDK::Trace::Event}s per {Span}.
           attr_reader :max_events_count
 
           # The global default max number of {OpenTelemetry::Trace::Link} entries per {Span}.
           attr_reader :max_links_count
 
-          # The global default max number of attributes per {OpenTelemetry::Trace::Event}.
+          # The global default max number of attributes per {OpenTelemetry::SDK::Trace::Event}.
           attr_reader :max_attributes_per_event
 
           # The global default max number of attributes per {OpenTelemetry::Trace::Link}.

sdk/lib/opentelemetry/sdk/trace/event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Trace
+      # A text annotation with a set of attributes and a timestamp.
+      class Event
+        EMPTY_ATTRIBUTES = {}.freeze
+
+        private_constant :EMPTY_ATTRIBUTES
+
+        # Returns the name of this event
+        #
+        # @return [String]
+        attr_reader :name
+
+        # Returns the frozen attributes for this event
+        #
+        # @return [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
+        attr_reader :attributes
+
+        # Returns the timestamp for this event
+        #
+        # @return [Time]
+        attr_reader :timestamp
+
+        # Returns a new immutable {Event}.
+        #
+        # @param [String] name The name of this event
+        # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}]
+        #   attributes A hash of attributes for this event. Attributes will be
+        #   frozen during Event initialization.
+        # @param [optional Time] timestamp The timestamp for this event.
+        #   Defaults to Time.now.
+        # @return [Event]
+        def initialize(name:, attributes: nil, timestamp: nil)
+          @name = name
+          @attributes = attributes.freeze || EMPTY_ATTRIBUTES
+          @timestamp = timestamp || Time.now
+        end
+      end
+    end
+  end
+end

sdk/lib/opentelemetry/sdk/trace/span.rb

@@ -77,36 +77,27 @@ def set_attribute(key, value)
           self
         end
 
-        # Add an Event to a {Span}. This can be accomplished eagerly or lazily.
-        # Lazy evaluation is useful when the event attributes are expensive to
-        # build and where the cost can be avoided for an unsampled {Span}.
+        # Add an Event to a {Span}.
         #
-        # Eager example:
+        # Example:
         #
-        #   span.add_event(name: 'event', attributes: {'eager' => true})
-        #
-        # Lazy example:
-        #
-        #   span.add_event { OpenTelemetry::Trace::Event.new(name: 'event', attributes: {'eager' => false}) }
+        #   span.add_event('event', attributes: {'eager' => true})
         #
         # Note that the OpenTelemetry project
         # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md
         # documents} certain "standard event names and keys" which have
         # prescribed semantic meanings.
         #
-        # @param [optional String] name Optional name of the event. This is
-        #   required if a block is not given.
+        # @param [String] name Name of the event.
         # @param [optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
         #   One or more key:value pairs, where the keys must be strings and the
-        #   values may be string, boolean or numeric type. This argument should
-        #   only be used when passing in a name.
+        #   values may be string, boolean or numeric type.
         # @param [optional Time] timestamp Optional timestamp for the event.
-        #   This argument should only be used when passing in a name.
         #
         # @return [self] returns itself
-        def add_event(name: nil, attributes: nil, timestamp: nil)
+        def add_event(name, attributes: nil, timestamp: nil)
           super
-          event = block_given? ? yield : OpenTelemetry::Trace::Event.new(name: name, attributes: attributes, timestamp: timestamp || Time.now)
+          event = Event.new(name: name, attributes: attributes, timestamp: timestamp || Time.now)
 
           @mutex.synchronize do
             if @ended
@@ -127,7 +118,7 @@ def add_event(name: nil, attributes: nil, timestamp: nil)
         #
         # @return [void]
         def record_error(error)
-          add_event(name: 'error',
+          add_event('error',
                     attributes: {
                       'error.type' => error.class.to_s,
                       'error.message' => error.message,
@@ -325,7 +316,7 @@ def append_event(events, event) # rubocop:disable Metrics/AbcSize, Metrics/Cyclo
             attrs.keep_if { |key, value| Internal.valid_key?(key) && Internal.valid_value?(value) }
             excess = attrs.size - max_attributes_per_event
             excess.times { attrs.shift } if excess.positive?
-            event = OpenTelemetry::Trace::Event.new(name: event.name, attributes: attrs, timestamp: event.timestamp)
+            event = Event.new(name: event.name, attributes: attrs, timestamp: event.timestamp)
           end
           events << event
         end

api/test/opentelemetry/trace/event_test.rb → sdk/test/opentelemetry/sdk/trace/event_test.rb

@@ -6,8 +6,8 @@
 
 require 'test_helper'
 
-describe OpenTelemetry::Trace::Event do
-  Event = OpenTelemetry::Trace::Event
+describe OpenTelemetry::SDK::Trace::Event do
+  Event = OpenTelemetry::SDK::Trace::Event
   describe '.new' do
     it 'accepts a name' do
       event = Event.new(name: 'message')