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-30917 Avoid core when eclagent terminates due to span destruction #18084

Merged
merged 1 commit into from
Nov 27, 2023
Merged

HPCC-30917 Avoid core when eclagent terminates due to span destruction #18084

merged 1 commit into from
Nov 27, 2023

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Nov 24, 2023 •
edited
Loading

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

https://track.hpccsystems.com/browse/HPCC-30917
Jira updated

ghalliday
ghalliday commented Nov 24, 2023
View reviewed changes
esp/bindings/http/platform/httpservice.cpp
@@ -377,18 +377,24 @@ int CEspHttpServer::processRequest()

checkSetCORSAllowOrigin(thebinding, m_request, m_response);

if (thebinding!=NULL)
if (thebinding && thebinding->isUnrestrictedSSType(stype))
Copy link
Member Author

Choose a reason for hiding this comment

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

Moved this earlier so that the span could be created whether or not thebinding is set.

esp/bindings/http/platform/httpservice.cpp
//which would remove the activeSpan when this function exits, use
//setActiveSpan()
//It is possible that using EspContextSpanScope would be better
Owned<ISpan> serverSpan = m_request->createServerSpan();
Copy link
Member Author

Choose a reason for hiding this comment

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

I changed this to create the span, but not set it in the context because there was no clean way to restore the span, and the HttpRequest class is used in other contexts than esp. For the moment I have left it using setActiveSpan, but it can now be changed to restore at the end of the function.
The correct behaviour may well be tied in with the behaviour of txsummary.

@ghalliday
Copy link
Member Author

@rpastrana this is a blocker for tagging 9.4.14 gold, so please review.

jakesmith
jakesmith approved these changes Nov 24, 2023
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

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

@ghalliday - 2 minor comments, but looks good to merge.

system/jlib/jtrace.hpp

// A variant of the class above that allows startSpan to be called after construction
template <class CONTEXT>
class DynamicContextSpanScopeImp
Copy link
Member

Choose a reason for hiding this comment

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

I get why different, but I'd have probably combined into ContextSpanScopeImp, i.e. separate ctor etc.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. I could revisit, but probably not for this PR.

esp/bindings/http/platform/httpservice.cpp
//setActiveSpan()
//It is possible that using EspContextSpanScope would be better
Owned<ISpan> serverSpan = m_request->createServerSpan();
ctx->setActiveSpan(serverSpan);
Copy link
Member

Choose a reason for hiding this comment

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

Not necessary to remove the span for reasons commented,
but if it were coded to use scoped object, it would need less explanation and be more intuitive I think.

rpastrana
rpastrana approved these changes Nov 27, 2023
View reviewed changes
Copy link
Member

@rpastrana rpastrana left a comment

Choose a reason for hiding this comment

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

@ghalliday this seems like a suitable solution.
However it seems ContextSpanScopeImp is a function of IContextLogger rather than jtrace.
Also, even though there's scattered code comments, it feels like this needs a dedicated README entry to fully articulate the use cases.

@ghalliday ghalliday merged commit fbf81a0 into hpcc-systems:candidate-9.4.x Nov 27, 2023
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpastrana rpastrana rpastrana approved these changes

@jakesmith jakesmith jakesmith 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.
3 participants
@ghalliday @jakesmith @rpastrana