Skip to content

Update semantic_conventions for rack #229

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.

Sign up for GitHub

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

Merged
xuan-cao-swi merged 4 commits into from
Oct 20, 2025
Merged

Update semantic_conventions for rack #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9c1ec3
update for rack
xuan-cao-swi Oct 20, 2025
b1a93b0
add test
xuan-cao-swi Oct 20, 2025
3c4028b
more test
xuan-cao-swi Oct 20, 2025
9fd1b88
update
xuan-cao-swi Oct 20, 2025
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
12 changes: 8 additions & 4 deletions lib/solarwinds_apm/opentelemetry/otlp_processor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ class OTLPProcessor
HTTP_STATUS_CODE = 'http.status_code'
HTTP_URL = 'http.url'

HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code'
HTTP_REQUEST_METHOD = 'http.request.method'

INVALID_HTTP_STATUS_CODE = 0

def initialize(txn_manager)
Expand Down Expand Up @@ -112,8 +115,9 @@ def meter_attributes(span)

if is_http_span
http_status_code = get_http_status_code(span)
meter_attrs['http.status_code'] = http_status_code if http_status_code != 0
meter_attrs['http.method'] = span.attributes[HTTP_METHOD] if span.attributes[HTTP_METHOD]
meter_attrs[HTTP_STATUS_CODE] = http_status_code if http_status_code != 0
meter_attrs[HTTP_METHOD] = span.attributes[HTTP_METHOD] if span.attributes[HTTP_METHOD]
meter_attrs[HTTP_METHOD] = span.attributes[HTTP_REQUEST_METHOD] if span.attributes[HTTP_REQUEST_METHOD]
end

SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] is_http_span: #{is_http_span}; meter_attrs: #{meter_attrs.inspect}" }
Expand Down Expand Up @@ -172,14 +176,14 @@ def error?(span)

# This span from inbound HTTP request if from a SERVER by some http.method
def span_http?(span)
span.kind == ::OpenTelemetry::Trace::SpanKind::SERVER && !span.attributes[HTTP_METHOD].nil?
(!span.attributes[HTTP_METHOD].nil? || !span.attributes[HTTP_REQUEST_METHOD].nil?) && span.kind == ::OpenTelemetry::Trace::SpanKind::SERVER
end

# Calculate HTTP status_code from span or default to UNAVAILABLE
# Something went wrong in OTel or instrumented service crashed early
# if no status_code in attributes of HTTP span
def get_http_status_code(span)
span.attributes[HTTP_STATUS_CODE] || INVALID_HTTP_STATUS_CODE
span.attributes[HTTP_RESPONSE_STATUS_CODE] || span.attributes[HTTP_STATUS_CODE] || INVALID_HTTP_STATUS_CODE
end

# check if it's entry span based on no parent or parent is remote
Expand Down
284 changes: 284 additions & 0 deletions test/opentelemetry/otlp_processor_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,288 @@
processor.on_start(span, OpenTelemetry::Context.current)
_(processor.txn_manager.get_root_context_h('77cb6ccc522d3106114dd6ecbb70036a')).must_equal '31e175128efc4018-00'
end

describe 'HTTP semantic convention tests' do
it 'test_get_http_status_code_with_new_semantic_convention' do
span_data = create_span_data
span_data.attributes['http.response.status_code'] = 201
result = @processor.send(:get_http_status_code, span_data)
_(result).must_equal 201
end

it 'test_span_http_with_old_http_method' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.method' => 'GET' }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'GET /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data

result = @processor.send(:span_http?, span_data)
_(result).must_equal true
end

it 'test_span_http_with_new_http_request_method' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.request.method' => 'POST' }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'POST /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data

result = @processor.send(:span_http?, span_data)
_(result).must_equal true
end

it 'test_span_http_with_both_old_and_new_conventions' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.method' => 'GET', 'http.request.method' => 'POST' }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'GET /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data

result = @processor.send(:span_http?, span_data)
_(result).must_equal true
end

it 'test_span_http_returns_false_for_non_server_span' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.request.method' => 'GET' }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'GET /users',
OpenTelemetry::Trace::SpanKind::CLIENT,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data

result = @processor.send(:span_http?, span_data)
_(result).must_equal false
end

it 'test_meter_attributes_with_old_http_method' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.method' => 'GET', 'http.status_code' => 200 }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'GET /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data
@processor.instance_variable_set(:@transaction_name, 'test_transaction')

result = @processor.send(:meter_attributes, span_data)
_(result['http.method']).must_equal 'GET'
_(result['http.status_code']).must_equal 200
_(result['sw.transaction']).must_equal 'test_transaction'
_(result['sw.is_error']).must_equal false
end

it 'test_meter_attributes_with_new_http_request_method' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.request.method' => 'POST', 'http.response.status_code' => 201 }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'POST /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data
@processor.instance_variable_set(:@transaction_name, 'test_transaction')

result = @processor.send(:meter_attributes, span_data)
_(result['http.method']).must_equal 'POST'
_(result['http.status_code']).must_equal 201
_(result['sw.transaction']).must_equal 'test_transaction'
_(result['sw.is_error']).must_equal false
end

it 'test_meter_attributes_with_new_and_old_status_code_as_same_code' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.request.method' => 'POST', 'http.status_code' => 201, 'http.response.status_code' => 201 }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'POST /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data
@processor.instance_variable_set(:@transaction_name, 'test_transaction')

result = @processor.send(:meter_attributes, span_data)
_(result['http.method']).must_equal 'POST'
_(result['http.status_code']).must_equal 201
_(result['sw.transaction']).must_equal 'test_transaction'
_(result['sw.is_error']).must_equal false
end

it 'test_meter_attributes_with_new_and_old_status_code_as_different_code' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = { 'http.request.method' => 'POST', 'http.status_code' => 200, 'http.response.status_code' => 201 }
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'POST /users',
OpenTelemetry::Trace::SpanKind::SERVER,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data
@processor.instance_variable_set(:@transaction_name, 'test_transaction')

result = @processor.send(:meter_attributes, span_data)
_(result['http.method']).must_equal 'POST'
_(result['http.status_code']).must_equal 201
_(result['sw.transaction']).must_equal 'test_transaction'
_(result['sw.is_error']).must_equal false
end

it 'test_meter_attributes_non_http_span' do
span_limits = OpenTelemetry::SDK::Trace::SpanLimits.new
attributes = {}
span_context = OpenTelemetry::Trace::SpanContext.new(
span_id: "1\xE1u\x12\x8E\xFC@\x18",
trace_id: "w\xCBl\xCCR-1\x06\x11M\xD6\xEC\xBBp\x03j"
)
span = OpenTelemetry::SDK::Trace::Span.new(
span_context,
OpenTelemetry::Context.empty,
OpenTelemetry::Trace::Span::INVALID,
'database_query',
OpenTelemetry::Trace::SpanKind::INTERNAL,
nil,
span_limits,
[],
attributes,
nil,
Time.now,
nil,
nil
)
span_data = span.to_span_data
@processor.instance_variable_set(:@transaction_name, 'test_transaction')

result = @processor.send(:span_http?, span_data)
_(result).must_equal false

result = @processor.send(:meter_attributes, span_data)
_(result.key?('http.method')).must_equal false
_(result.key?('http.status_code')).must_equal false
_(result['sw.transaction']).must_equal 'test_transaction'
_(result['sw.is_error']).must_equal false
end
end
end