opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers #37787

therealak12 · 2024-12-21T10:05:11Z

Commit Message: implement TraceIDRatioBased and ParentBased samplers

Additional Description:
A previous issue existed for adding opentelemetry samplers to Envoy so I didn't create a new one. The PR at hand implements two of these samplers.
The implementation and testing strategies are inspired by the OTEL's Go and CPP SDKs.

Risk Level: Low

Testing: The PR has unit and integration tests which I've run locally.

Docs Changes:
Release Notes:
Platform Specific Features:

repokitteh-read-only · 2024-12-21T10:05:27Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @wbpcode
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).
CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to (bazel/.*repos.*\.bzl)|(bazel/dependency_imports\.bzl)|(api/bazel/.*\.bzl)|(.*/requirements\.txt)|(.*\.patch).
envoyproxy/dependency-shepherds assignee is @phlax

🐱

Caused by: #37787 was opened by therealak12.

see: more, trace.

therealak12 · 2024-12-21T15:50:47Z

The ci/do_ci.sh coverage job is failing. The only unusual log entry I can find is a warning message. I'd appreciate any assistance in identifying and resolving the issue.

Here's the warning message I mentioned.

phlax · 2024-12-21T15:57:11Z

the warning is not relevant

this is the important line

Code coverage for source/extensions/tracers/opentelemetry/samplers/trace_id_ratio_based is lower than limit of 96.6 (84.8)

/coverage

repokitteh-read-only · 2024-12-21T15:57:16Z

Coverage for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/37787/coverage/index.html

The coverage results are (re-)rendered each time the CI envoy-presubmit (check linux_x64 coverage) job completes.

🐱

Caused by: a #37787 (comment) was created by @phlax.

see: more, trace.

therealak12 · 2024-12-21T18:18:13Z

Thanks for your guidance, dear @phlax. Tests are passing now.

wbpcode · 2024-12-22T14:36:02Z

Thanks for the contribution. Please read the https://github.com/envoyproxy/envoy/blob/main/CONTRIBUTING.md and https://github.com/envoyproxy/envoy/blob/main/EXTENSION_POLICY.md to get more infomation about adding new extensions to see if the new extensions meet the requirement or not.

Thanks again!

therealak12 · 2024-12-22T18:28:57Z

Please read the https://github.com/envoyproxy/envoy/blob/main/CONTRIBUTING.md and https://github.com/envoyproxy/envoy/blob/main/EXTENSION_POLICY.md to get more information about adding new extensions to see if the new extensions meet the requirement or not.

Thanks for the links, @wbpcode! I’ve reviewed them and made the necessary adjustments to my PR. However, just to clarify, my PR doesn't add a new extension; rather, it implements two missing samplers for the OpenTelemetry tracer extension.

Could you please let me know if that matches your expectations?

therealak12 · 2024-12-24T13:27:26Z

If you get a chance, I'd appreciate any feedback or comments when you have time. No rush, I understand you're busy.

wbpcode · 2024-12-25T02:44:53Z

Thanks for the links, @wbpcode! I’ve reviewed them and made the necessary adjustments to my PR. However, just to clarify, my PR doesn't add a new extension; rather, it implements two missing samplers for the OpenTelemetry tracer extension.
Could you please let me know if that matches your expectations?

Sorry for the delay. I skipped messages from community these two days.

It's no doubt this add some new extensions. Although these extensions are not top level extensions but sub extensions for opentelmetry. But it doesn't change to much the characteristics.

So, at least, we should ensure the current owners of opentelmetry @AlexanderEllis @yanavlasov are willing to maintain these new two extensions.

wbpcode · 2024-12-25T02:45:02Z

/wait-any

therealak12 · 2024-12-30T06:47:59Z

I would appreciate it if you took a look at this when you have a moment.
@AlexanderEllis @yanavlasov

Signed-off-by: therealak12 <[email protected]>

wbpcode · 2025-04-28T03:08:09Z

...tensions/tracers/opentelemetry/samplers/trace_id_ratio_based/trace_id_ratio_based_sampler.cc

+uint64_t ratioToThreshold(double ratio) noexcept {
+  const uint64_t MAX_VALUE = Envoy::ProtobufPercentHelper::fractionalPercentDenominatorToInt(
+      envoy::type::v3::FractionalPercent::MILLION);
+
+  if (ratio <= 0.0) {
+    return 0;
+  }
+  if (ratio >= 1.0) {
+    return MAX_VALUE;
+  }
+
+  return static_cast<uint64_t>(ratio * static_cast<double>(MAX_VALUE));
+}


I actually didn't get this. If we have used fractionl percent helper here, why not use the envoy.type.v3.FractionalPercent directly and use evaluateFractionalPercent to get the decsion?

I refactored the code to use FractionalPercent and evaluateFractionalPercent.
Hope it's what you meant!

Hi @wbpcode,
would you mind taking another look at the code?

Signed-off-by: therealak12 <[email protected]>

wbpcode

LGTM overall with only one nit comment. Thanks for the update!!!

api/envoy/extensions/tracers/opentelemetry/samplers/v3/trace_id_ratio_based_sampler.proto

…d_ratio_based_sampler.proto Co-authored-by: code <[email protected]> Signed-off-by: Ahmad Karimi <[email protected]>

wbpcode

Sorry, I forget a comment.

wbpcode · 2025-05-07T08:54:28Z

...tensions/tracers/opentelemetry/samplers/trace_id_ratio_based/trace_id_ratio_based_sampler.cc

+uint64_t traceIdToUint64(const std::string& trace_id) noexcept {
+  uint8_t buffer[8] = {0};
+  for (size_t i = 0; i < 8; ++i) {
+    std::string byte_string = trace_id.substr(i * 2, 2);
+    buffer[i] = static_cast<uint8_t>(std::stoul(byte_string, nullptr, 16));
+  }
+
+  uint64_t first_8_bytes = 0;
+  Envoy::safeMemcpyUnsafeSrc(&first_8_bytes, buffer);
+
+  return first_8_bytes;
+}


Sorry, I forget this. Should we check the length of trace id here to ensure the trace id have enough data?

I remember at the time of creating this PR I saw somewhere else in the code checks this.
However, please let me ensure. I'll share the update in this thread.

There were no explicit checks previously, and I assumed the trace ID would always be valid, which, of course, was an unsafe assumption.

The necessary check has now been added.

Signed-off-by: therealak12 <[email protected]>

wbpcode

LGTM with one nit comment. I think we can land this today or tomorrow. :) Thanks again for all your great contribution.

source/extensions/tracers/opentelemetry/samplers/trace_id_ratio_based/BUILD

…o_based/BUILD Co-authored-by: code <[email protected]> Signed-off-by: Ahmad Karimi <[email protected]>

therealak12 · 2025-05-09T04:44:33Z

LGTM with one nit comment. I think we can land this today or tomorrow. :) Thanks again for all your great contribution.

Thanks for the review! I've addressed your comment - please let me know if you'd like any further adjustments.

wbpcode

LGTM. Thanks.

therealak12 requested a review from yanavlasov as a code owner December 21, 2024 10:05

repokitteh-read-only bot added api deps Approval required for changes to Envoy's external dependencies labels Dec 21, 2024

repokitteh-read-only bot assigned wbpcode and phlax Dec 21, 2024

therealak12 force-pushed the samplers branch 6 times, most recently from e186869 to b6bfb74 Compare December 21, 2024 13:13

therealak12 marked this pull request as draft December 21, 2024 17:33

therealak12 force-pushed the samplers branch from 1573f58 to 07cb847 Compare December 21, 2024 17:33

therealak12 marked this pull request as ready for review December 21, 2024 18:18

therealak12 force-pushed the samplers branch from 07cb847 to d70cd7e Compare December 22, 2024 18:28

therealak12 changed the title ~~Implement TraceIDRatioBased and ParentBased samplers~~ opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers Dec 22, 2024

repokitteh-read-only bot added the waiting:any label Dec 25, 2024

repokitteh-read-only bot removed the waiting:any label Dec 30, 2024

wbpcode added the waiting label Jan 6, 2025

therealak12 added 2 commits April 22, 2025 05:21

use getAndCheckFactory instead of getFactor

692523b

Signed-off-by: therealak12 <[email protected]>

use MILLION instead of UINT64_MAX

8bd8607

Signed-off-by: therealak12 <[email protected]>

ravenblackx requested a review from wbpcode April 25, 2025 20:04

wbpcode reviewed Apr 28, 2025

View reviewed changes

therealak12 marked this pull request as draft April 29, 2025 08:12

therealak12 force-pushed the samplers branch 9 times, most recently from fd712d3 to 8969d25 Compare April 29, 2025 16:56

replace double with fractional percent

010cd19

Signed-off-by: therealak12 <[email protected]>

therealak12 force-pushed the samplers branch from 8969d25 to 010cd19 Compare April 29, 2025 17:10

therealak12 marked this pull request as ready for review April 29, 2025 17:48

wbpcode reviewed May 7, 2025

View reviewed changes

api/envoy/extensions/tracers/opentelemetry/samplers/v3/trace_id_ratio_based_sampler.proto Outdated Show resolved Hide resolved

Update api/envoy/extensions/tracers/opentelemetry/samplers/v3/trace_i…

fb9896b

…d_ratio_based_sampler.proto Co-authored-by: code <[email protected]> Signed-off-by: Ahmad Karimi <[email protected]>

wbpcode approved these changes May 7, 2025

View reviewed changes

repokitteh-read-only bot removed the api label May 7, 2025

wbpcode requested changes May 7, 2025

View reviewed changes

therealak12 added 2 commits May 8, 2025 16:24

check of size of trace_id

115a6ef

Signed-off-by: therealak12 <[email protected]>

test traceIdToUint64

48866c9

Signed-off-by: therealak12 <[email protected]>

therealak12 force-pushed the samplers branch from 2c1b1b5 to 48866c9 Compare May 8, 2025 17:59

wbpcode reviewed May 9, 2025

View reviewed changes

source/extensions/tracers/opentelemetry/samplers/trace_id_ratio_based/BUILD Outdated Show resolved Hide resolved

Update source/extensions/tracers/opentelemetry/samplers/trace_id_rati…

0441830

…o_based/BUILD Co-authored-by: code <[email protected]> Signed-off-by: Ahmad Karimi <[email protected]>

wbpcode approved these changes May 9, 2025

View reviewed changes

wbpcode merged commit 05352f6 into envoyproxy:main May 9, 2025
25 of 26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers #37787

opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers #37787

therealak12 commented Dec 21, 2024

repokitteh-read-only bot commented Dec 21, 2024

therealak12 commented Dec 21, 2024 •

edited

Loading

phlax commented Dec 21, 2024

repokitteh-read-only bot commented Dec 21, 2024

therealak12 commented Dec 21, 2024 •

edited

Loading

wbpcode commented Dec 22, 2024 •

edited

Loading

therealak12 commented Dec 22, 2024

therealak12 commented Dec 24, 2024

wbpcode commented Dec 25, 2024

wbpcode commented Dec 25, 2024

therealak12 commented Dec 30, 2024

wbpcode Apr 28, 2025 •

edited

Loading

therealak12 Apr 29, 2025

therealak12 May 3, 2025

wbpcode left a comment

wbpcode left a comment

wbpcode May 7, 2025

therealak12 May 7, 2025

therealak12 May 8, 2025

wbpcode left a comment

therealak12 commented May 9, 2025

wbpcode left a comment

opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers #37787

opentelemetry tracer: implement TraceIDRatioBased and ParentBased samplers #37787

Conversation

therealak12 commented Dec 21, 2024

repokitteh-read-only bot commented Dec 21, 2024

therealak12 commented Dec 21, 2024 • edited Loading

phlax commented Dec 21, 2024

repokitteh-read-only bot commented Dec 21, 2024

therealak12 commented Dec 21, 2024 • edited Loading

wbpcode commented Dec 22, 2024 • edited Loading

therealak12 commented Dec 22, 2024

therealak12 commented Dec 24, 2024

wbpcode commented Dec 25, 2024

wbpcode commented Dec 25, 2024

therealak12 commented Dec 30, 2024

wbpcode Apr 28, 2025 • edited Loading

Choose a reason for hiding this comment

therealak12 Apr 29, 2025

Choose a reason for hiding this comment

therealak12 May 3, 2025

Choose a reason for hiding this comment

wbpcode left a comment

Choose a reason for hiding this comment

wbpcode left a comment

Choose a reason for hiding this comment

wbpcode May 7, 2025

Choose a reason for hiding this comment

therealak12 May 7, 2025

Choose a reason for hiding this comment

therealak12 May 8, 2025

Choose a reason for hiding this comment

wbpcode left a comment

Choose a reason for hiding this comment

therealak12 commented May 9, 2025

wbpcode left a comment

Choose a reason for hiding this comment

therealak12 commented Dec 21, 2024 •

edited

Loading

therealak12 commented Dec 21, 2024 •

edited

Loading

wbpcode commented Dec 22, 2024 •

edited

Loading

wbpcode Apr 28, 2025 •

edited

Loading