Skip to content

chore: ConfiguratorPatch updates #1845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions logs_sdk/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ gemspec

eval_gemfile '../contrib/Gemfile.shared'

gem 'opentelemetry-api', path: '../api'
gem 'opentelemetry-logs-api', path: '../logs_api'
gem 'opentelemetry-sdk', path: '../sdk'
gem 'opentelemetry-test-helpers', path: '../test_helpers'
group :test, :development do
gem 'opentelemetry-api', path: '../api'
gem 'opentelemetry-exporter-otlp-logs', path: '../exporter/otlp-logs'
gem 'opentelemetry-logs-api', path: '../logs_api'
gem 'opentelemetry-sdk', path: '../sdk'
gem 'opentelemetry-test-helpers', path: '../test_helpers'
end
2 changes: 1 addition & 1 deletion logs_sdk/lib/opentelemetry/sdk/logs.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# SPDX-License-Identifier: Apache-2.0

require_relative 'logs/version'
require_relative 'logs/configuration_patch'
require_relative 'logs/configurator_patch'
require_relative 'logs/logger'
require_relative 'logs/logger_provider'
require_relative 'logs/log_record'
Expand Down
135 changes: 135 additions & 0 deletions logs_sdk/test/opentelemetry/sdk/logs/configurator_patch_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# frozen_string_literal: true

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

require 'test_helper'
require 'opentelemetry-exporter-otlp-logs' unless RUBY_ENGINE == 'jruby'

describe OpenTelemetry::SDK::Logs::ConfiguratorPatch do
let(:configurator) { OpenTelemetry::SDK::Configurator.new }
let(:default_resource_attributes) do
{
'telemetry.sdk.name' => 'opentelemetry',
'telemetry.sdk.language' => 'ruby',
'telemetry.sdk.version' => OpenTelemetry::SDK::VERSION,
'process.pid' => Process.pid,
'process.command' => $PROGRAM_NAME,
'process.runtime.name' => RUBY_ENGINE,
'process.runtime.version' => RUBY_VERSION,
'process.runtime.description' => RUBY_DESCRIPTION,
'service.name' => 'unknown_service'
}
end

describe '#configure' do
describe 'logger_provider' do
it 'is an instance of SDK::Logs::LoggerProvider' do
configurator.configure

_(OpenTelemetry.logger_provider).must_be_instance_of(
OpenTelemetry::SDK::Logs::LoggerProvider
)
end
end

describe 'processors' do
it 'defaults to a simple processor with a console exporter' do
configurator.configure

processors = OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)

assert_equal 1, processors.size
processor = processors[0]

assert_instance_of OpenTelemetry::SDK::Logs::Export::SimpleLogRecordProcessor, processor
assert_instance_of OpenTelemetry::SDK::Logs::Export::ConsoleLogRecordExporter, processor.instance_variable_get(:@log_record_exporter)
end

it 'can be set by environment variable' do
skip 'OTLP exporter not compatible with JRuby' if RUBY_ENGINE == 'jruby'

OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'otlp') do
configurator.configure
end

processors = OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)

assert_equal 1, processors.size
processor = processors[0]

assert_instance_of OpenTelemetry::SDK::Logs::Export::BatchLogRecordProcessor, processor
assert_instance_of OpenTelemetry::Exporter::OTLP::Logs::LogsExporter, processor.instance_variable_get(:@exporter)
end

it 'supports "none" as an environment variable' do
OpenTelemetry::TestHelpers.with_test_logger do |log_stream|
OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'none') do
configurator.configure
end

assert_empty OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)

refute_match(/The none exporter is unknown and cannot be configured/, log_stream.string)
end
end

it 'supports multiple exporters passed by environment variable' do
skip 'OTLP exporter not compatible with JRuby' if RUBY_ENGINE == 'jruby'

OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'console,otlp') do
configurator.configure
end

processors = OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)

assert_equal 2, processors.size

processor1 = processors[0]
processor2 = processors[1]

assert_instance_of OpenTelemetry::SDK::Logs::Export::SimpleLogRecordProcessor, processor1
assert_instance_of OpenTelemetry::SDK::Logs::Export::ConsoleLogRecordExporter, processor1.instance_variable_get(:@log_record_exporter)

assert_instance_of OpenTelemetry::SDK::Logs::Export::BatchLogRecordProcessor, processor2
assert_instance_of OpenTelemetry::Exporter::OTLP::Logs::LogsExporter, processor2.instance_variable_get(:@exporter)
end

it 'defaults to noop with invalid env var' do
OpenTelemetry::TestHelpers.with_test_logger do |log_stream|
OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'unladen_swallow') do
configurator.configure
end

assert_empty OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)
assert_match(/The unladen_swallow exporter is unknown and cannot be configured/, log_stream.string)
end
end

it 'rescues NameErrors when otlp set to env var and the library is not installed' do
if RUBY_ENGINE == 'jruby'
OpenTelemetry::TestHelpers.with_test_logger do |log_stream|
OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'otlp') do
configurator.configure
end

assert_empty OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)
assert_match(/The otlp logs exporter cannot be configured - please add opentelemetry-exporter-otlp-logs to your Gemfile. Logs will not be exported/, log_stream.string)
end
else
OpenTelemetry::TestHelpers.with_test_logger do |log_stream|
OpenTelemetry::Exporter::OTLP::Logs::LogsExporter.stub(:new, -> { raise NameError }) do
OpenTelemetry::TestHelpers.with_env('OTEL_LOGS_EXPORTER' => 'otlp') do
configurator.configure
end

assert_empty OpenTelemetry.logger_provider.instance_variable_get(:@log_record_processors)
assert_match(/The otlp logs exporter cannot be configured - please add opentelemetry-exporter-otlp-logs to your Gemfile. Logs will not be exported/, log_stream.string)
end
end
end
end
end
end
end
2 changes: 1 addition & 1 deletion metrics_sdk/lib/opentelemetry/sdk/metrics.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module Metrics
end

require 'opentelemetry/sdk/metrics/aggregation'
require 'opentelemetry/sdk/metrics/configuration_patch'
require 'opentelemetry/sdk/metrics/configurator_patch'
require 'opentelemetry/sdk/metrics/export'
require 'opentelemetry/sdk/metrics/instrument'
require 'opentelemetry/sdk/metrics/meter'
Expand Down
Loading