Skip to content
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

Clarify doc comment for DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED #6791

Merged
merged 3 commits into from
Mar 21, 2025

Conversation

zacharycmontoya
Copy link
Contributor

@zacharycmontoya zacharycmontoya commented Mar 20, 2025

Summary of changes

Small docs update.

Reason for change

Adds more clarity.

Implementation details

Test coverage

N/A

Other details

@github-actions github-actions bot added the area:tracer The core tracer library (Datadog.Trace, does not include OpenTracing, native code, or integrations) label Mar 20, 2025
@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Mar 20, 2025

Datadog Report

Branch report: zach.montoya/clarify-128bit-config
Commit report: 8ec47fa
Test service: dd-trace-dotnet

✅ 0 Failed, 255227 Passed, 2409 Skipped, 21h 28m 12.7s Total Time

@andrewlock
Copy link
Member

andrewlock commented Mar 20, 2025

Execution-Time Benchmarks Report ⏱️

Execution-time results for samples comparing the following branches/commits:

Execution-time benchmarks measure the whole time it takes to execute a program. And are intended to measure the one-off costs. Cases where the execution time results for the PR are worse than latest master results are shown in red. The following thresholds were used for comparing the execution times:

  • Welch test with statistical test for significance of 5%
  • Only results indicating a difference greater than 5% and 5 ms are considered.

Note that these results are based on a single point-in-time result for each branch. For full results, see the dashboard.

Graphs show the p99 interval based on the mean and StdDev of the test run, as well as the mean value of the run (shown as a diamond below the graph).

Loading
gantt
    title Execution time (ms) FakeDbCommand (.NET Framework 4.6.2) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (77ms)  : 71, 83
     .   : milestone, 77,
    master - mean (69ms)  : 66, 73
     .   : milestone, 69,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (1,070ms)  : crit, 1036, 1103
     .   : crit, milestone, 1070,
    master - mean (1,008ms)  : 983, 1033
     .   : milestone, 1008,

Loading
gantt
    title Execution time (ms) FakeDbCommand (.NET Core 3.1) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (113ms)  : 109, 117
     .   : milestone, 113,
    master - mean (102ms)  : 100, 104
     .   : milestone, 102,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (738ms)  : crit, 713, 763
     .   : crit, milestone, 738,
    master - mean (688ms)  : 670, 706
     .   : milestone, 688,

Loading
gantt
    title Execution time (ms) FakeDbCommand (.NET 6) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (100ms)  : 95, 105
     .   : milestone, 100,
    master - mean (89ms)  : 87, 91
     .   : milestone, 89,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (696ms)  : crit, 678, 714
     .   : crit, milestone, 696,
    master - mean (642ms)  : 626, 658
     .   : milestone, 642,

Loading
gantt
    title Execution time (ms) HttpMessageHandler (.NET Framework 4.6.2) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (190ms)  : 185, 195
     .   : milestone, 190,
    master - mean (190ms)  : 186, 194
     .   : milestone, 190,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (1,106ms)  : 1075, 1137
     .   : milestone, 1106,
    master - mean (1,109ms)  : 1079, 1140
     .   : milestone, 1109,

Loading
gantt
    title Execution time (ms) HttpMessageHandler (.NET Core 3.1) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (269ms)  : 265, 272
     .   : milestone, 269,
    master - mean (269ms)  : 265, 273
     .   : milestone, 269,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (876ms)  : 843, 908
     .   : milestone, 876,
    master - mean (880ms)  : 847, 914
     .   : milestone, 880,

Loading
gantt
    title Execution time (ms) HttpMessageHandler (.NET 6) 
    dateFormat  X
    axisFormat %s
    todayMarker off
    section Baseline
    This PR (6791) - mean (261ms)  : 257, 265
     .   : milestone, 261,
    master - mean (263ms)  : 259, 267
     .   : milestone, 263,

    section CallTarget+Inlining+NGEN
    This PR (6791) - mean (860ms)  : 823, 897
     .   : milestone, 860,
    master - mean (858ms)  : 822, 895
     .   : milestone, 858,

@andrewlock
Copy link
Member

andrewlock commented Mar 20, 2025

Benchmarks Report for tracer 🐌

Benchmarks for #6791 compared to master:

  • 1 benchmarks are faster, with geometric mean 1.179
  • 2 benchmarks are slower, with geometric mean 1.165
  • 1 benchmarks have fewer allocations

The following thresholds were used for comparing the benchmark speeds:

  • Mann–Whitney U test with statistical test for significance of 5%
  • Only results indicating a difference greater than 10% and 0.3 ns are considered.

Allocation changes below 0.5% are ignored.

Benchmark details

Benchmarks.Trace.ActivityBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master StartStopWithChild net6.0 7.82μs 35.3ns 146ns 0.0204 0.00815 0 5.61 KB
master StartStopWithChild netcoreapp3.1 10.1μs 57ns 391ns 0.0201 0.00504 0 5.8 KB
master StartStopWithChild net472 16μs 49.1ns 190ns 1.03 0.301 0.0896 6.21 KB
#6791 StartStopWithChild net6.0 7.94μs 45ns 321ns 0.0158 0.00791 0 5.6 KB
#6791 StartStopWithChild netcoreapp3.1 10.1μs 56.2ns 364ns 0.0297 0.0148 0 5.8 KB
#6791 StartStopWithChild net472 16.1μs 33.6ns 130ns 1.04 0.303 0.0876 6.22 KB
Benchmarks.Trace.AgentWriterBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master WriteAndFlushEnrichedTraces net6.0 485μs 531ns 1.99μs 0 0 0 2.7 KB
master WriteAndFlushEnrichedTraces netcoreapp3.1 678μs 437ns 1.69μs 0 0 0 2.7 KB
master WriteAndFlushEnrichedTraces net472 840μs 1.11μs 4.28μs 0.419 0 0 3.3 KB
#6791 WriteAndFlushEnrichedTraces net6.0 491μs 483ns 1.87μs 0 0 0 2.7 KB
#6791 WriteAndFlushEnrichedTraces netcoreapp3.1 651μs 1.11μs 4.31μs 0 0 0 2.7 KB
#6791 WriteAndFlushEnrichedTraces net472 841μs 732ns 2.64μs 0.419 0 0 3.3 KB
Benchmarks.Trace.AspNetCoreBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master SendRequest net6.0 131μs 485ns 1.88μs 0.134 0 0 14.47 KB
master SendRequest netcoreapp3.1 147μs 420ns 1.63μs 0.221 0 0 17.27 KB
master SendRequest net472 0.00039ns 0.000291ns 0.00105ns 0 0 0 0 b
#6791 SendRequest net6.0 131μs 276ns 1.07μs 0.194 0 0 14.47 KB
#6791 SendRequest netcoreapp3.1 145μs 269ns 1.04μs 0.22 0 0 17.28 KB
#6791 SendRequest net472 0.0019ns 0.000536ns 0.00208ns 0 0 0 0 b
Benchmarks.Trace.CIVisibilityProtocolWriterBenchmark - Same speed ✔️ Fewer allocations 🎉

Fewer allocations 🎉 in #6791

Benchmark Base Allocated Diff Allocated Change Change %
Benchmarks.Trace.CIVisibilityProtocolWriterBenchmark.WriteAndFlushEnrichedTraces‑netcoreapp3.1 41.8 KB 41.51 KB -285 B -0.68%

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master WriteAndFlushEnrichedTraces net6.0 600μs 3.46μs 26.8μs 0.566 0 0 41.63 KB
master WriteAndFlushEnrichedTraces netcoreapp3.1 687μs 3.83μs 25.7μs 0.332 0 0 41.8 KB
master WriteAndFlushEnrichedTraces net472 872μs 4.22μs 18.4μs 8.42 2.66 0.443 53.31 KB
#6791 WriteAndFlushEnrichedTraces net6.0 582μs 3.32μs 24.9μs 0.536 0 0 41.56 KB
#6791 WriteAndFlushEnrichedTraces netcoreapp3.1 755μs 4.39μs 40.4μs 0.381 0 0 41.51 KB
#6791 WriteAndFlushEnrichedTraces net472 850μs 3.17μs 11.8μs 8.41 2.4 0.401 53.29 KB
Benchmarks.Trace.DbCommandBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master ExecuteNonQuery net6.0 1.37μs 0.817ns 3.06ns 0.0145 0 0 1.02 KB
master ExecuteNonQuery netcoreapp3.1 1.72μs 1.43ns 5.34ns 0.0138 0 0 1.02 KB
master ExecuteNonQuery net472 2.02μs 2.73ns 10.2ns 0.157 0.00101 0 987 B
#6791 ExecuteNonQuery net6.0 1.29μs 1.78ns 6.89ns 0.0144 0 0 1.02 KB
#6791 ExecuteNonQuery netcoreapp3.1 1.77μs 2.03ns 7.87ns 0.0132 0 0 1.02 KB
#6791 ExecuteNonQuery net472 2.08μs 3.21ns 12.4ns 0.156 0.00103 0 987 B
Benchmarks.Trace.ElasticsearchBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master CallElasticsearch net6.0 1.27μs 0.471ns 1.76ns 0.0134 0 0 976 B
master CallElasticsearch netcoreapp3.1 1.54μs 0.855ns 3.2ns 0.0131 0 0 976 B
master CallElasticsearch net472 2.65μs 1.24ns 4.81ns 0.157 0 0 995 B
master CallElasticsearchAsync net6.0 1.26μs 0.642ns 2.4ns 0.013 0 0 952 B
master CallElasticsearchAsync netcoreapp3.1 1.73μs 0.966ns 3.74ns 0.0138 0 0 1.02 KB
master CallElasticsearchAsync net472 2.71μs 0.728ns 2.73ns 0.167 0 0 1.05 KB
#6791 CallElasticsearch net6.0 1.25μs 0.986ns 3.82ns 0.0138 0 0 976 B
#6791 CallElasticsearch netcoreapp3.1 1.64μs 3.83ns 14.8ns 0.013 0 0 976 B
#6791 CallElasticsearch net472 2.59μs 1.12ns 4.17ns 0.157 0 0 995 B
#6791 CallElasticsearchAsync net6.0 1.34μs 0.407ns 1.58ns 0.0134 0 0 952 B
#6791 CallElasticsearchAsync netcoreapp3.1 1.64μs 1.02ns 3.83ns 0.014 0 0 1.02 KB
#6791 CallElasticsearchAsync net472 2.62μs 1.05ns 4.08ns 0.166 0 0 1.05 KB
Benchmarks.Trace.GraphQLBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master ExecuteAsync net6.0 1.29μs 0.502ns 1.88ns 0.0129 0 0 952 B
master ExecuteAsync netcoreapp3.1 1.61μs 0.484ns 1.74ns 0.0127 0 0 952 B
master ExecuteAsync net472 1.86μs 0.416ns 1.61ns 0.145 0 0 915 B
#6791 ExecuteAsync net6.0 1.3μs 0.664ns 2.4ns 0.0131 0 0 952 B
#6791 ExecuteAsync netcoreapp3.1 1.61μs 0.505ns 1.75ns 0.0128 0 0 952 B
#6791 ExecuteAsync net472 1.77μs 0.357ns 1.34ns 0.145 0 0 915 B
Benchmarks.Trace.HttpClientBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master SendAsync net6.0 4.24μs 1.62ns 6.29ns 0.0318 0 0 2.31 KB
master SendAsync netcoreapp3.1 5.32μs 4.96ns 18.6ns 0.0371 0 0 2.85 KB
master SendAsync net472 7.58μs 1.44ns 5.38ns 0.492 0 0 3.12 KB
#6791 SendAsync net6.0 4.2μs 2.66ns 10.3ns 0.0316 0 0 2.31 KB
#6791 SendAsync netcoreapp3.1 5.23μs 1.7ns 6.6ns 0.0368 0 0 2.85 KB
#6791 SendAsync net472 7.61μs 1.18ns 4.42ns 0.493 0 0 3.12 KB
Benchmarks.Trace.ILoggerBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master EnrichedLog net6.0 1.54μs 0.775ns 2.9ns 0.0239 0 0 1.69 KB
master EnrichedLog netcoreapp3.1 2.36μs 0.981ns 3.67ns 0.0232 0 0 1.69 KB
master EnrichedLog net472 2.59μs 0.982ns 3.68ns 0.258 0 0 1.62 KB
#6791 EnrichedLog net6.0 1.5μs 0.945ns 3.66ns 0.0241 0 0 1.69 KB
#6791 EnrichedLog netcoreapp3.1 2.16μs 0.65ns 2.52ns 0.0238 0 0 1.69 KB
#6791 EnrichedLog net472 2.66μs 0.944ns 3.53ns 0.257 0 0 1.62 KB
Benchmarks.Trace.Log4netBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master EnrichedLog net6.0 113μs 156ns 604ns 0 0 0 4.3 KB
master EnrichedLog netcoreapp3.1 117μs 210ns 814ns 0.0584 0 0 4.3 KB
master EnrichedLog net472 150μs 241ns 932ns 0.676 0.225 0 4.49 KB
#6791 EnrichedLog net6.0 114μs 174ns 674ns 0.0563 0 0 4.3 KB
#6791 EnrichedLog netcoreapp3.1 116μs 174ns 675ns 0.0581 0 0 4.3 KB
#6791 EnrichedLog net472 149μs 150ns 582ns 0.667 0.222 0 4.49 KB
Benchmarks.Trace.NLogBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master EnrichedLog net6.0 3.09μs 1.51ns 5.83ns 0.031 0 0 2.25 KB
master EnrichedLog netcoreapp3.1 4.26μs 1.64ns 6.12ns 0.03 0 0 2.25 KB
master EnrichedLog net472 4.89μs 1.93ns 7.47ns 0.329 0 0 2.07 KB
#6791 EnrichedLog net6.0 3.09μs 0.629ns 2.35ns 0.0308 0 0 2.25 KB
#6791 EnrichedLog netcoreapp3.1 4.32μs 3.67ns 14.2ns 0.0304 0 0 2.25 KB
#6791 EnrichedLog net472 4.81μs 0.958ns 3.71ns 0.329 0 0 2.07 KB
Benchmarks.Trace.RedisBenchmark - Slower ⚠️ Same allocations ✔️

Slower ⚠️ in #6791

Benchmark diff/base Base Median (ns) Diff Median (ns) Modality
Benchmarks.Trace.RedisBenchmark.SendReceive‑net6.0 1.131 1,297.72 1,467.22

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master SendReceive net6.0 1.3μs 0.665ns 2.49ns 0.0163 0 0 1.14 KB
master SendReceive netcoreapp3.1 1.7μs 0.708ns 2.74ns 0.0153 0 0 1.14 KB
master SendReceive net472 2.08μs 0.618ns 2.31ns 0.183 0 0 1.16 KB
#6791 SendReceive net6.0 1.47μs 0.871ns 3.37ns 0.0162 0 0 1.14 KB
#6791 SendReceive netcoreapp3.1 1.86μs 2.83ns 11ns 0.0148 0 0 1.14 KB
#6791 SendReceive net472 2.07μs 0.549ns 2.13ns 0.183 0 0 1.16 KB
Benchmarks.Trace.SerilogBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master EnrichedLog net6.0 2.71μs 1.23ns 4.75ns 0.0217 0 0 1.62 KB
master EnrichedLog netcoreapp3.1 3.97μs 1.41ns 5.27ns 0.0218 0 0 1.67 KB
master EnrichedLog net472 4.49μs 1.57ns 6.09ns 0.326 0 0 2.07 KB
#6791 EnrichedLog net6.0 2.69μs 1.15ns 4.46ns 0.0229 0 0 1.62 KB
#6791 EnrichedLog netcoreapp3.1 4μs 1.16ns 4.5ns 0.0219 0 0 1.67 KB
#6791 EnrichedLog net472 4.55μs 3.41ns 13.2ns 0.326 0 0 2.07 KB
Benchmarks.Trace.SpanBenchmark - Slower ⚠️ Same allocations ✔️

Slower ⚠️ in #6791

Benchmark diff/base Base Median (ns) Diff Median (ns) Modality
Benchmarks.Trace.SpanBenchmark.StartFinishSpan‑net472 1.200 598.00 717.38

Faster 🎉 in #6791

Benchmark base/diff Base Median (ns) Diff Median (ns) Modality
Benchmarks.Trace.SpanBenchmark.StartFinishSpan‑net6.0 1.179 468.60 397.60

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master StartFinishSpan net6.0 469ns 0.166ns 0.643ns 0.0082 0 0 576 B
master StartFinishSpan netcoreapp3.1 581ns 0.902ns 3.49ns 0.00774 0 0 576 B
master StartFinishSpan net472 598ns 0.148ns 0.573ns 0.0917 0 0 578 B
master StartFinishScope net6.0 495ns 0.178ns 0.69ns 0.00985 0 0 696 B
master StartFinishScope netcoreapp3.1 723ns 0.293ns 1.13ns 0.00935 0 0 696 B
master StartFinishScope net472 852ns 0.339ns 1.27ns 0.104 0 0 658 B
#6791 StartFinishSpan net6.0 398ns 0.195ns 0.755ns 0.00818 0 0 576 B
#6791 StartFinishSpan netcoreapp3.1 568ns 0.284ns 1.1ns 0.00794 0 0 576 B
#6791 StartFinishSpan net472 717ns 0.166ns 0.644ns 0.0916 0 0 578 B
#6791 StartFinishScope net6.0 484ns 0.169ns 0.655ns 0.00989 0 0 696 B
#6791 StartFinishScope netcoreapp3.1 707ns 0.375ns 1.45ns 0.00921 0 0 696 B
#6791 StartFinishScope net472 881ns 0.692ns 2.68ns 0.104 0 0 658 B
Benchmarks.Trace.TraceAnnotationsBenchmark - Same speed ✔️ Same allocations ✔️

Raw results

Branch Method Toolchain Mean StdError StdDev Gen 0 Gen 1 Gen 2 Allocated
master RunOnMethodBegin net6.0 676ns 0.192ns 0.745ns 0.00986 0 0 696 B
master RunOnMethodBegin netcoreapp3.1 957ns 0.315ns 1.22ns 0.00911 0 0 696 B
master RunOnMethodBegin net472 1.12μs 0.226ns 0.876ns 0.104 0 0 658 B
#6791 RunOnMethodBegin net6.0 681ns 0.313ns 1.21ns 0.00994 0 0 696 B
#6791 RunOnMethodBegin netcoreapp3.1 884ns 0.504ns 1.95ns 0.00914 0 0 696 B
#6791 RunOnMethodBegin net472 1.08μs 0.279ns 1.04ns 0.104 0 0 658 B

@zacharycmontoya zacharycmontoya marked this pull request as ready for review March 20, 2025 18:57
@zacharycmontoya zacharycmontoya requested a review from a team as a code owner March 20, 2025 18:57
Copy link
Contributor

@link04 link04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY cause this may be needed soon.

Co-authored-by: Andrew Lock <andrew.lock@datadoghq.com>
@zacharycmontoya zacharycmontoya merged commit 8e98459 into master Mar 21, 2025
128 of 130 checks passed
@zacharycmontoya zacharycmontoya deleted the zach.montoya/clarify-128bit-config branch March 21, 2025 20:13
@github-actions github-actions bot added this to the vNext-v3 milestone Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:tracer The core tracer library (Datadog.Trace, does not include OpenTracing, native code, or integrations)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants