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-33574 ActiveSpanScope false error message due to null spans #19600

Merged
merged 1 commit into from
Apr 3, 2025
Merged

HPCC-33574 ActiveSpanScope false error message due to null spans #19600

merged 1 commit into from
Apr 3, 2025

Conversation

jpmcmu
Copy link
Contributor

@jpmcmu jpmcmu commented Mar 7, 2025

  • Corrected ActiveSpanScope logic for checking if active span has changed unexpectedly

Signed-off-by: James McMullan [email protected]

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

github-actions bot commented Mar 7, 2025

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

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

@jpmcmu jpmcmu requested a review from ghalliday March 7, 2025 13:42
@jpmcmu
Copy link
Contributor Author

jpmcmu commented Mar 10, 2025

This PR addresses an issue that causes spurious error logging when the ActiveSpanScope has a nullptr. Which can be useful to simplify code that tracks work being done that may or may not be related to a span.

ghalliday
ghalliday reviewed Mar 11, 2025
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.

@jpmcmu one question.

system/jlib/jtrace.cpp Outdated
@@ -1591,7 +1591,11 @@ ActiveSpanScope::ActiveSpanScope(ISpan * _ptr, ISpan * _prev) : span(_ptr), prev
ActiveSpanScope::~ActiveSpanScope()
{
ISpan* current = queryThreadedActiveSpan();
if (current != span)

// NOTE: need to handle span == nullptr differently because queryThreadActiveSpan returns the cNullSpan in this case
Copy link
Member

Choose a reason for hiding this comment

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

When was this occurring? Can you provide some more details - because I would expect span to never be null.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ghalliday The only place I am aware of is here in the dafilesrv code: https://github.com/hpcc-systems/HPCC-Platform/blob/master/fs/dafsserver/dafsserver.cpp#L1127

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ghalliday thoughts on the above? I have been looking at ActiveSpanScope(nullptr) as a valid use case to make it easier for developers to handle code that may or may not be traced. However, I can see an argument for defaulting to CNullSpan in these cases.

Copy link
Member

Choose a reason for hiding this comment

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

This code would be simpler if null could not be passed to the constructor - only queryNullSpan(). The test on line 1601 would also be simpler.
I would be tempted to map nullptr to queryNullSpan() in the constructor. Is there a disadvantage in that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, I think that is a better approach. I will make that change

@jpmcmu jpmcmu requested a review from ghalliday March 27, 2025 10:14
ghalliday
ghalliday approved these changes Apr 2, 2025
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.

@jpmcmu please squash

@jpmcmu
HPCC-33574 ActiveSpanScope false error message due to null spans
d0fc74b 
- Modified ActiveSpanScope to convert nullptr to the cNullSpan

Signed-off-by: James McMullan [email protected]
@jpmcmu
Copy link
Contributor Author

jpmcmu commented Apr 2, 2025

@ghalliday squashed

@ghalliday ghalliday merged commit 52fb30c into hpcc-systems:candidate-9.8.x Apr 3, 2025
49 checks passed
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 3, 2025

Jirabot Action Result:
Added fix version: 9.8.72
Added fix version: 9.10.18
Workflow Transition: 'Resolve issue'

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
@jpmcmu @ghalliday