Contents

# frozen_string_literal: true

# Copyright 2019 OpenTelemetry Authors
#
# SPDX-License-Identifier: Apache-2.0

module OpenTelemetry
  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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
opentelemetry-api-0.5.1	lib/opentelemetry/trace/event.rb
opentelemetry-api-0.5.0	lib/opentelemetry/trace/event.rb
opentelemetry-api-0.4.0	lib/opentelemetry/trace/event.rb
opentelemetry-api-0.3.0	lib/opentelemetry/trace/event.rb