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.

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

Jump to bottom

HPCC-31570 SoapCall to propagate client span headers #18522

Merged
merged 1 commit into from
Apr 11, 2024
Merged

HPCC-31570 SoapCall to propagate client span headers #18522

merged 1 commit into from
Apr 11, 2024

Conversation

rpastrana
Copy link
Member

@rpastrana rpastrana commented Apr 10, 2024 •
edited
Loading

  • New method param allows trace headers passed in to http request
  • Supplies client span trace header
  • Delays http req creation after client span
  • Ensures client span lifespan remains as tight as possible

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-31570

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

@rpastrana rpastrana requested a review from ghalliday April 10, 2024 15:22
ghalliday
ghalliday reviewed Apr 11, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@rpastrana a couple of comments.

common/thorhelper/thorsoapcall.cpp Outdated
@@ -2563,6 +2561,11 @@ class CWSCAsyncFor : implements IWSCAsyncFor, public CInterface, public CAsyncFo
checkRoxieAbortMonitor(master->roxieAbortMonitor);
OwnedSpanScope socketOperationSpan = master->activitySpanScope->createClientSpan("Socket Write");
setSpanURLAttributes(socketOperationSpan, url);
if (isEmptyString(request))
Copy link
Member

Choose a reason for hiding this comment

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

If you are creating a spans for each retry then you will need to recreate the request each time - otherwise the parent span will be wrong. (Move the definition of request to here at the same time.)

(I don't think there is a problem if you do, the common case is to succeed.)

common/thorhelper/thorsoapcall.cpp Outdated
@@ -1958,7 +1958,7 @@ class CWSCAsyncFor : implements IWSCAsyncFor, public CInterface, public CAsyncFo
}
}

void createHttpRequest(Url &url, StringBuffer &request)
void createHttpRequest(Url &url, StringBuffer &request, IProperties * traceHeaders)
Copy link
Member

Choose a reason for hiding this comment

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

Very confusing (existing) parameters. The first parameter should be const it is input only - in which case your new parameter should come before the output parameter. (Output parameters should either be at the start of the list or the end, not in the middle.)

@rpastrana
HPCC-31570 SoapCall to propagate client span headers
aa5bf04 
- New method param allows trace headers passed in to http request
- Supplies client span trace header
- Delays http req creation after client span
- Ensures client span lifespan remains as tight as possible
- Re-orders createHttpRequest params
- Declares const param

Signed-off-by: Rodrigo Pastrana <[email protected]>
@rpastrana rpastrana force-pushed the HPCC-31570-SoapCallSpanFix branch from b8d39ad to aa5bf04 Compare April 11, 2024 15:57
@ghalliday ghalliday merged commit b29ebe4 into hpcc-systems:candidate-9.4.x Apr 11, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ghalliday ghalliday ghalliday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rpastrana @ghalliday