feat(otel): add support for span events by mabdinur · Pull Request #3776 · DataDog/dd-trace-rb

mabdinur · 2024-07-10T20:26:46Z

What does this PR do?

Ensures span events generated via the OpenTelemetry SDK are copied from OpenTelemetry Spans to the underlying Datadog span. With change opentelemetry span events are no longer ignored. These events will be sent to the Datadog Agent.
Implements Span.record_exception. This ensures the status of the underlying Datadog span is updated when an exception is recorded on an OpenTelemetry Span.

Motivation:

The OpenTelemetry API supports setting Events on spans. Currently these events are ignored by the ddtrace library. To fully support the OpenTelemetry API the ddtrace library must support sending span events to the Datadog Agent.

Additional Notes:

How to test the change?

Unit tests + DataDog/system-tests#2735

Unsure? Have a question? Request a review!

codecov-commenter · 2024-07-11T20:41:30Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.91%. Comparing base (161e3eb) to head (da8c243).
⚠️ Report is 5424 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #3776    +/-   ##
========================================
  Coverage   97.91%   97.91%            
========================================
  Files        1246     1248     +2     
  Lines       74999    75154   +155     
  Branches     3627     3636     +9     
========================================
+ Hits        73435    73590   +155     
  Misses       1564     1564

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pr-commenter · 2024-07-17T17:14:38Z

Benchmarks

Benchmark execution time: 2024-07-18 17:53:28

Comparing candidate commit da8c243 in PR branch munir/add-span-events with baseline commit 161e3eb in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 10 metrics, 2 unstable metrics.

datadog-datadog-prod-us1 · 2024-07-18T16:28:10Z

Library Vulnerabilities

✅ No library vulnerabilities found (scanned da8c243).

Code Vulnerabilities

Code Quality Violations

datadog-datadog-staging-us1-all · 2024-07-18T17:58:10Z

Code Vulnerabilities

Code Quality Violations

github-actions Bot added otel OpenTelemetry-related changes tracing labels Jul 10, 2024

mabdinur force-pushed the munir/add-span-events branch from be2749a to 2e3e798 Compare July 10, 2024 20:30

datadog-datadog-prod-us1 Bot reviewed Jul 10, 2024

View reviewed changes

Comment thread spec/datadog/opentelemetry_spec.rb Outdated

Comment thread spec/datadog/opentelemetry_spec.rb Outdated

mabdinur force-pushed the munir/add-span-events branch from 080e3b0 to 78f8b78 Compare July 10, 2024 20:36

mabdinur commented Jul 10, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb Outdated

mabdinur force-pushed the munir/add-span-events branch from 589abcf to 5beeb47 Compare July 10, 2024 20:38

datadog-datadog-prod-us1 Bot reviewed Jul 10, 2024

View reviewed changes

mabdinur force-pushed the munir/add-span-events branch from 9230214 to 6d71a35 Compare July 11, 2024 20:26

mabdinur marked this pull request as ready for review July 11, 2024 20:26

mabdinur requested a review from a team as a code owner July 11, 2024 20:26

datadog-datadog-prod-us1 Bot reviewed Jul 11, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb Outdated

Comment thread spec/datadog/tracing/transport/serializable_trace_spec.rb Outdated

mabdinur commented Jul 12, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb Outdated

mabdinur commented Jul 12, 2024

View reviewed changes

Comment thread spec/datadog/opentelemetry_spec.rb Outdated

mabdinur commented Jul 12, 2024

View reviewed changes

Comment thread spec/datadog/opentelemetry_spec.rb Outdated

mabdinur commented Jul 12, 2024

View reviewed changes

Comment thread spec/datadog/tracing/transport/serializable_trace_spec.rb Outdated

mabdinur force-pushed the munir/add-span-events branch from e2b667a to f78f874 Compare July 12, 2024 20:00

datadog-datadog-staging-us1-all Bot reviewed Jul 12, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb Outdated

datadog-datadog-prod-us1 Bot reviewed Jul 15, 2024

View reviewed changes

Comment thread spec/datadog/opentelemetry_spec.rb Outdated

mabdinur commented Jul 16, 2024

View reviewed changes

Comment thread lib/datadog/opentelemetry/sdk/span_processor.rb Outdated

mabdinur commented Jul 16, 2024

View reviewed changes

Comment thread lib/datadog/opentelemetry/sdk/trace/span.rb Outdated

mabdinur commented Jul 16, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb Outdated

mabdinur commented Jul 16, 2024

View reviewed changes

Comment thread lib/datadog/tracing/transport/serializable_trace.rb Outdated

mabdinur changed the title ~~feat(otel): support span events~~ feat(otel): support for span events Jul 16, 2024

mabdinur changed the title ~~feat(otel): support for span events~~ feat(otel): add support for span events Jul 16, 2024

mabdinur and others added 4 commits July 16, 2024 11:24

feat(otel): support span events

fb6f101

fmt

fcad302

fix tests

f0deab2

linting fixes

172f9c3

github-actions Bot requested a review from a team as a code owner July 16, 2024 15:52

mabdinur force-pushed the munir/add-span-events branch from bb92318 to c1cd64f Compare July 16, 2024 16:45

Update gemfiles/*

e46997b

marcotc approved these changes Jul 16, 2024

View reviewed changes

TonyCTHsu reviewed Jul 17, 2024

View reviewed changes

Comment thread lib/datadog/opentelemetry/sdk/trace/span.rb Outdated

TonyCTHsu reviewed Jul 17, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_operation.rb

TonyCTHsu reviewed Jul 17, 2024

View reviewed changes

Comment thread lib/datadog/tracing/span_event.rb

TonyCTHsu approved these changes Jul 17, 2024

View reviewed changes

Comment thread lib/datadog/opentelemetry/sdk/trace/span.rb Outdated

do NOT set error status

be79136

p-datadog reviewed Jul 17, 2024

View reviewed changes

tony's suggestion, avoid using || in set_error_tags

28ebb4d

mabdinur force-pushed the munir/add-span-events branch from 7784672 to b6e3c5e Compare July 17, 2024 19:04

address Oleg's comments

54c757e

mabdinur force-pushed the munir/add-span-events branch from b6e3c5e to 54c757e Compare July 17, 2024 19:11

marcotc reviewed Jul 17, 2024

View reviewed changes

Comment thread spec/datadog/opentelemetry_spec.rb

mabdinur added 2 commits July 17, 2024 18:45

update record_exception docs and clean up implementation

3412fd2

test attributes with nil and empty string

9a7de18

mabdinur force-pushed the munir/add-span-events branch 2 times, most recently from f01655f to c9d6455 Compare July 18, 2024 16:26

improve test coverage for nil and empty attributes

64e29a1

mabdinur force-pushed the munir/add-span-events branch from c9d6455 to 64e29a1 Compare July 18, 2024 16:51

lint and fix docstring

da8c243

zarirhamza merged commit 2f089cd into master Jul 18, 2024

zarirhamza deleted the munir/add-span-events branch July 18, 2024 18:13

github-actions Bot added this to the 2.3.0 milestone Jul 18, 2024

mabdinur mentioned this pull request Jul 19, 2024

fix(errors): revert breaking change #3796

Merged

TonyCTHsu mentioned this pull request Aug 22, 2024

Bump to version 2.3.0 #3861

Merged

Uh oh!

Conversation

mabdinur commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jul 11, 2024 • edited by codecov Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pr-commenter Bot commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

datadog-datadog-prod-us1 Bot commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Library Vulnerabilities

Code Vulnerabilities

Code Quality Violations

Uh oh!

datadog-datadog-staging-us1-all Bot commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Vulnerabilities

Code Quality Violations

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

mabdinur commented Jul 10, 2024 •

edited

Loading

codecov-commenter commented Jul 11, 2024 •

edited by codecov Bot

Loading

pr-commenter Bot commented Jul 17, 2024 •

edited

Loading

datadog-datadog-prod-us1 Bot commented Jul 18, 2024 •

edited

Loading

datadog-datadog-staging-us1-all Bot commented Jul 18, 2024 •

edited

Loading