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-30734 Refactor the CSpan tracing classes #18060

Merged
merged 1 commit into from
Nov 28, 2023
Merged

HPCC-30734 Refactor the CSpan tracing classes #18060

merged 1 commit into from
Nov 28, 2023

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Nov 21, 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-30734
Jira updated

@ghalliday ghalliday requested a review from rpastrana November 21, 2023 15:59
@ghalliday
Copy link
Member Author

@rpastrana I would strongly recommend that you review this code before working on any other changes because they will almost certainly clash.
The PR is split into multiple commits to show each of the stages.

rpastrana
rpastrana reviewed Nov 21, 2023
View reviewed changes
system/jlib/jtrace.cpp
{
out.append("\"Type\":\"Server\"");
CSpan::toLog(out);

if (!isEmptyString(hpccGlobalId.get()))
Copy link
Member

Choose a reason for hiding this comment

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

Moving these to serverSpans makes sense. I will mention, all these LN specific IDs have a very limited expected lifespan. One major request I've heard is to provide these values during "transition" period (from LN IDs to OTel IDs). My concern is not reporting these values for non server spans could make the mapping of LN -> Otel IDs unnecessarily difficult. If I've misunderstood the net effect of moving these up, please ignore this comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

They should still be reported exactly as before. The difference is that they're not stored in any of the other spans.

Copy link
Member Author

Choose a reason for hiding this comment

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

It might be that the intent was that if you logged a client span it would log the global id, but it didn't before. That can be implemented as a separate PR if required (probably a sensible idea).

rpastrana
rpastrana approved these changes Nov 21, 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 I like a lot of these changes. I'm assuming CPPUNIT_TEST_SUITE(JlibTraceTest) pass successfully.

system/jlib/jtrace.cpp Outdated
public:
virtual bool getSpanContext(IProperties * ctxProps, bool otelFormatted) const override
{
//MORE: It is not clear what this return value represents, and whether it would veer be checked.
Copy link
Member

Choose a reason for hiding this comment

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

minor: veer?

Copy link
Member Author

Choose a reason for hiding this comment

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

Will fix -> ever

@ghalliday
Copy link
Member Author

@rpastrana squashed and fixed the typo.
Confirmed the unit tests still pass.

rpastrana
rpastrana approved these changes Nov 28, 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 approved

@ghalliday ghalliday merged commit f5ef1ea into hpcc-systems:candidate-9.4.x Nov 28, 2023
46 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

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