opentelemetry-logs-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b95cb9f7e5a248dfe1943fb2c24f54e18b35d9360c26b64f7f93c4a1da3856eb
+  data.tar.gz: 3b0f1a5b3dc37087aae50dd0a99b7bad9709b55f28e7cdcfa9d35b3de38ddec4
+SHA512:
+  metadata.gz: 0050dac60d1856bbb9e118a7ba95e2d66297500453581214b8c853433b4782bd923b57a18c08156fd91ab7c4966ca1805c2479b1612b39b29119c6f157b873fe
+  data.tar.gz: 05aec7579acd3164a78ea62db2cf5e7b1bc9e1fc45f40c835b168d72faf20b1a2cd60298239c240f042e4da8f4e974a43e31334faf8409c2a0fc953b518d7d06

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Logs SDK
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/**/*.rb
+./lib/opentelemetry.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History: opentelemetry-logs-sdk
+
+### v0.1.0 / 2024-12-04
+
+Initial release.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The OpenTelemetry Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/opentelemetry/sdk/logs/configuration_patch.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/sdk/configurator'
+
+module OpenTelemetry
+  module SDK
+    module Logs
+      # The ConfiguratorPatch implements a hook to configure the logs portion
+      # of the SDK.
+      module ConfiguratorPatch
+        def add_log_record_processor(log_record_processor)
+          @log_record_processors << log_record_processor
+        end
+
+        private
+
+        def initialize
+          super
+          @log_record_processors = []
+        end
+
+        # The logs_configuration_hook method is where we define the setup
+        # process for logs SDK.
+        def logs_configuration_hook
+          OpenTelemetry.logger_provider = Logs::LoggerProvider.new(resource: @resource)
+          configure_log_record_processors
+        end
+
+        def configure_log_record_processors
+          processors = @log_record_processors.empty? ? wrapped_log_exporters_from_env.compact : @log_record_processors
+          processors.each { |p| OpenTelemetry.logger_provider.add_log_record_processor(p) }
+        end
+
+        def wrapped_log_exporters_from_env
+          # TODO: set default to OTLP to match traces, default is console until other exporters merged
+          exporters = ENV.fetch('OTEL_LOGS_EXPORTER', 'console')
+
+          exporters.split(',').map do |exporter|
+            case exporter.strip
+            when 'none' then nil
+            when 'console' then Logs::Export::SimpleLogRecordProcessor.new(Logs::Export::ConsoleLogRecordExporter.new)
+            when 'otlp'
+              otlp_protocol = ENV['OTEL_EXPORTER_OTLP_LOGS_PROTOCOL'] || ENV['OTEL_EXPORTER_OTLP_PROTOCOL'] || 'http/protobuf'
+
+              if otlp_protocol != 'http/protobuf'
+                OpenTelemetry.logger.warn "The #{otlp_protocol} transport protocol is not supported by the OTLP exporter, log_records will not be exported."
+                nil
+              else
+                begin
+                  Logs::Export::BatchLogRecordProcessor.new(OpenTelemetry::Exporter::OTLP::Logs::LogsExporter.new)
+                rescue NameError
+                  OpenTelemetry.logger.warn 'The otlp logs exporter cannot be configured - please add opentelemetry-exporter-otlp-logs to your Gemfile. Logs will not be exported'
+                  nil
+                end
+              end
+            else
+              OpenTelemetry.logger.warn "The #{exporter} exporter is unknown and cannot be configured, log records will not be exported"
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+OpenTelemetry::SDK::Configurator.prepend(OpenTelemetry::SDK::Logs::ConfiguratorPatch)

data/lib/opentelemetry/sdk/logs/export/batch_log_record_processor.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Logs
+      module Export
+        # WARNING - The spec has some differences from the LogRecord version of this processor
+        # Implementation of the duck type LogRecordProcessor that batches
+        # log records exported by the SDK then pushes them to the exporter
+        # pipeline.
+        #
+        # Typically, the BatchLogRecordProcessor will be more suitable for
+        # production environments than the SimpleLogRecordProcessor.
+        class BatchLogRecordProcessor < LogRecordProcessor # rubocop:disable Metrics/ClassLength
+          # Returns a new instance of the {BatchLogRecordProcessor}.
+          #
+          # @param [LogRecordExporter] exporter The (duck type) LogRecordExporter to where the
+          #   recorded LogRecords are pushed after batching.
+          # @param [Numeric] exporter_timeout The maximum allowed time to export data.
+          #   Defaults to the value of the OTEL_BLRP_EXPORT_TIMEOUT
+          #   environment variable, if set, or 30,000 (30 seconds).
+          # @param [Numeric] schedule_delay the delay interval between two consecutive exports.
+          #   Defaults to the value of the OTEL_BLRP_SCHEDULE_DELAY environment
+          #   variable, if set, or 1,000 (1 second).
+          # @param [Integer] max_queue_size the maximum queue size in log records.
+          #   Defaults to the value of the OTEL_BLRP_MAX_QUEUE_SIZE environment
+          #   variable, if set, or 2048.
+          # @param [Integer] max_export_batch_size the maximum batch size in log records.
+          #   Defaults to the value of the OTEL_BLRP_MAX_EXPORT_BATCH_SIZE environment
+          #   variable, if set, or 512.
+          #
+          # @return a new instance of the {BatchLogRecordProcessor}.
+          def initialize(exporter,
+                         exporter_timeout: Float(ENV.fetch('OTEL_BLRP_EXPORT_TIMEOUT', 30_000)),
+                         schedule_delay: Float(ENV.fetch('OTEL_BLRP_SCHEDULE_DELAY', 1000)),
+                         max_queue_size: Integer(ENV.fetch('OTEL_BLRP_MAX_QUEUE_SIZE', 2048)),
+                         max_export_batch_size: Integer(ENV.fetch('OTEL_BLRP_MAX_EXPORT_BATCH_SIZE', 512)),
+                         start_thread_on_boot: String(ENV['OTEL_RUBY_BLRP_START_THREAD_ON_BOOT']) !~ /false/i)
+            unless max_export_batch_size <= max_queue_size
+              raise ArgumentError,
+                    'max_export_batch_size much be less than or equal to max_queue_size'
+            end
+
+            unless Common::Utilities.valid_exporter?(exporter)
+              raise ArgumentError,
+                    "exporter #{exporter.inspect} does not appear to be a valid exporter"
+            end
+
+            @exporter = exporter
+            @exporter_timeout_seconds = exporter_timeout / 1000.0
+            @mutex = Mutex.new
+            @export_mutex = Mutex.new
+            @condition = ConditionVariable.new
+            @keep_running = true
+            @stopped = false
+            @delay_seconds = schedule_delay / 1000.0
+            @max_queue_size = max_queue_size
+            @batch_size = max_export_batch_size
+            @log_records = []
+            @pid = nil
+            @thread = nil
+            reset_on_fork(restart_thread: start_thread_on_boot)
+          end
+
+          # Adds a log record to the batch. Thread-safe; may block on lock.
+          def on_emit(log_record, _context)
+            return if @stopped
+
+            lock do
+              reset_on_fork
+              n = log_records.size + 1 - max_queue_size
+              if n.positive?
+                log_records.shift(n)
+                report_dropped_log_records(n, reason: 'buffer-full')
+              end
+              log_records << log_record
+              @condition.signal if log_records.size > batch_size
+            end
+          end
+
+          # Export all emitted log records that have not yet been exported to
+          # the configured `Exporter`.
+          #
+          # This method should only be called in cases where it is absolutely
+          # necessary, such as when using some FaaS providers that may suspend
+          # the process after an invocation, but before the `Processor` exports
+          # the completed log records.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
+
+            snapshot = lock do
+              reset_on_fork if @keep_running
+              log_records.shift(log_records.size)
+            end
+
+            until snapshot.empty?
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              return TIMEOUT if remaining_timeout&.zero?
+
+              batch = snapshot.shift(batch_size).map!(&:to_log_record_data)
+              result_code = export_batch(batch, timeout: remaining_timeout)
+              return result_code unless result_code == SUCCESS
+            end
+
+            @exporter.force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
+          ensure
+            # Unshift the remaining log records if we timed out. We drop excess
+            # log records from the snapshot because they're older than any
+            # records in the buffer.
+            lock do
+              n = log_records.size + snapshot.size - max_queue_size
+
+              if n.positive?
+                snapshot.shift(n)
+                report_dropped_log_records(n, reason: 'buffer-full')
+              end
+
+              log_records.unshift(*snapshot) unless snapshot.empty?
+              @condition.signal if log_records.size > max_queue_size / 2
+            end
+          end
+
+          # Shuts the consumer thread down and flushes the current accumulated
+          # buffer will block until the thread is finished.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def shutdown(timeout: nil)
+            return if @stopped
+
+            start_time = OpenTelemetry::Common::Utilities.timeout_timestamp
+            thread = lock do
+              @keep_running = false
+              @stopped = true
+              @condition.signal
+              @thread
+            end
+
+            thread&.join(timeout)
+            force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
+            dropped_log_records = lock { log_records.size }
+            report_dropped_log_records(dropped_log_records, reason: 'terminating') if dropped_log_records.positive?
+
+            @exporter.shutdown(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
+          end
+
+          private
+
+          attr_reader :log_records, :max_queue_size, :batch_size
+
+          def work
+            loop do
+              batch = lock do
+                @condition.wait(@mutex, @delay_seconds) if log_records.size < batch_size && @keep_running
+                @condition.wait(@mutex, @delay_seconds) while log_records.empty? && @keep_running
+                return unless @keep_running
+
+                fetch_batch
+              end
+
+              export_batch(batch)
+            end
+          end
+
+          def reset_on_fork(restart_thread: true)
+            pid = Process.pid
+            return if @pid == pid
+
+            @pid = pid
+            log_records.clear
+            @thread = restart_thread ? Thread.new { work } : nil
+          rescue ThreadError => e
+            OpenTelemetry.handle_error(exception: e, message: 'unexpected error in BatchLogRecordProcessor#reset_on_fork')
+          end
+
+          def export_batch(batch, timeout: @exporter_timeout_seconds)
+            result_code = @export_mutex.synchronize { @exporter.export(batch, timeout: timeout) }
+            report_result(result_code, batch)
+            result_code
+          rescue StandardError => e
+            report_result(FAILURE, batch)
+            OpenTelemetry.handle_error(exception: e, message: 'unexpected error in BatchLogRecordProcessor#export_batch')
+          end
+
+          def report_result(result_code, batch)
+            if result_code == SUCCESS
+              OpenTelemetry.logger.debug("Successfully exported #{batch.size} log records")
+            else
+              OpenTelemetry.handle_error(exception: ExportError.new("Unable to export #{batch.size} log records"))
+              OpenTelemetry.logger.error("Result code: #{result_code}")
+            end
+          end
+
+          def report_dropped_log_records(count, reason:)
+            OpenTelemetry.logger.warn("#{count} log record(s) dropped. Reason: #{reason}")
+          end
+
+          def fetch_batch
+            log_records.shift(@batch_size).map!(&:to_log_record_data)
+          end
+
+          def lock(&block)
+            @mutex.synchronize(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/logs/export/console_log_record_exporter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Logs
+      module Export
+        # Outputs {LogRecordData} to the console.
+        #
+        # Potentially useful for exploratory purposes.
+        class ConsoleLogRecordExporter
+          def initialize
+            @stopped = false
+          end
+
+          def export(log_records, timeout: nil)
+            return FAILURE if @stopped
+
+            Array(log_records).each { |s| pp s }
+
+            SUCCESS
+          end
+
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
+          def shutdown(timeout: nil)
+            @stopped = true
+            SUCCESS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/logs/export/in_memory_log_record_exporter.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Logs
+      module Export
+        # A LogRecordExporter implementation that can be used to test OpenTelemetry integration.
+        #
+        # @example Usage in a test suite:
+        #   class MyClassTest
+        #     def setup
+        #       @logger_provider = LoggerProvider.new
+        #       @exporter = InMemoryLogRecordExporter.new
+        #       @logger_provider.add_log_record_processor(SimpleLogRecordProcessor.new(@exporter))
+        #     end
+        #
+        #     def test_emitted_log_records
+        #       log_record = OpenTelemetry::SDK::Logs::LogRecord.new(body: 'log')
+        #       @logger_provider.logger.on_emit(log_record, context)
+        #
+        #       log_records = @exporter.emitted_log_records
+
+        #       refute_nil(log_records)
+        #       assert_equal(1, log_records.size)
+        #       assert_equal(log_records[0].body, 'log')
+        #     end
+        #   end
+        class InMemoryLogRecordExporter
+          # Returns a new instance of the {InMemoryLogRecordExporter}.
+          #
+          # @return a new instance of the {InMemoryLogRecordExporter}.
+          def initialize
+            @emitted_log_records = []
+            @stopped = false
+            @mutex = Mutex.new
+          end
+
+          # Returns a frozen array of the emitted {LogRecordData}s, represented by
+          # {io.opentelemetry.proto.trace.v1.LogRecord}.
+          #
+          # @return [Array<LogRecordData>] a frozen array of the emitted {LogRecordData}s.
+          def emitted_log_records
+            @mutex.synchronize do
+              @emitted_log_records.clone.freeze
+            end
+          end
+
+          # Clears the internal collection of emitted {LogRecord}s.
+          #
+          # Does not reset the state of this exporter if already shutdown.
+          def reset
+            @mutex.synchronize do
+              @emitted_log_records.clear
+            end
+          end
+
+          # Called to export {LogRecordData}s.
+          #
+          # @param [Enumerable<LogRecordData>] log_record_datas the list of {LogRecordData}s to be
+          #   exported.
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] the result of the export, SUCCESS or
+          #   FAILURE
+          def export(log_record_datas, timeout: nil)
+            @mutex.synchronize do
+              return FAILURE if @stopped
+
+              @emitted_log_records.concat(log_record_datas.to_a)
+            end
+            SUCCESS
+          end
+
+          # Called when {LoggerProvider#force_flush} is called, if this exporter is
+          # registered to a {LoggerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
+          # Called when {LoggerProvider#shutdown} is called, if this exporter is
+          # registered to a {LoggerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def shutdown(timeout: nil)
+            @mutex.synchronize do
+              @emitted_log_records.clear
+              @stopped = true
+            end
+            SUCCESS
+          end
+        end
+      end
+    end
+  end
+end