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

[Docs] Clarify description for propagation_extract_first #3762

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

brett0000FF
Copy link
Contributor

What does this PR do?

Update description for tracing.distributed_tracing.propagation_extract_first.

Motivation:

Feedback that "exiting" is confusing.

Additional Notes:

How to test the change?

Unsure? Have a question? Request a review!

@brett0000FF brett0000FF requested review from a team as code owners July 5, 2024 21:20
@github-actions github-actions bot added the docs Involves documentation label Jul 5, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.91%. Comparing base (849c60c) to head (bdafc58).
Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3762   +/-   ##
=======================================
  Coverage   97.91%   97.91%           
=======================================
  Files        1241     1241           
  Lines       74632    74692   +60     
  Branches     3605     3605           
=======================================
+ Hits        73074    73134   +60     
  Misses       1558     1558           

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

Copy link
Contributor

@p-datadog p-datadog left a comment

Choose a reason for hiding this comment

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

The change proposed in this PR makes sense to me, I would additionally mention what would happen if the "extract first" setting is not set (which format would be used if there are multiple ones found).

@brett0000FF
Copy link
Contributor Author

The change proposed in this PR makes sense to me, I would additionally mention what would happen if the "extract first" setting is not set (which format would be used if there are multiple ones found).

@p-datadog - Good feedback! I agree it'd be helpful to include information for when this option is set to false. In that case, would it use the last valid propagation format it finds? I'm not sure, so any clarification would be helpful. Thanks!

@p-datadog
Copy link
Contributor

@brett0000FF I actually don't know which is in part why I mentioned this (I do not work on tracer).

@marcotc marcotc merged commit 3c46876 into master Jul 25, 2024
170 checks passed
@marcotc marcotc deleted the brett0000FF/clarify-config-description branch July 25, 2024 21:42
@github-actions github-actions bot added this to the 2.3.0 milestone Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Involves documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants