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-30349 Add open telemetry support to esp #17838

Merged
merged 1 commit into from
Sep 28, 2023
Merged

HPCC-30349 Add open telemetry support to esp #17838

merged 1 commit into from
Sep 28, 2023

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Sep 28, 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
Copy link

https://track.hpccsystems.com/browse/HPCC-30349
Jira not updated (user does not match)

@github-actions
Copy link

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

@ghalliday ghalliday requested a review from afishbeck September 28, 2023 13:25
afishbeck
afishbeck reviewed Sep 28, 2023
View reviewed changes
Copy link
Member

@afishbeck afishbeck left a comment

Choose a reason for hiding this comment

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

@ghalliday looks good, some comments.

esp/bindings/http/platform/httptransport.cpp
if(callerId.length())
m_context->setCallerId(callerId);

//MORE: The previous code would be better off querying httpHeaders...
Copy link
Member

Choose a reason for hiding this comment

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

Yes at some point we could look at using IProperties inside CHttpRequest/Message.

esp/platform/espcontext.cpp Outdated Show resolved Hide resolved
esp/services/ws_ecl/ws_ecl_service.cpp Outdated Show resolved Hide resolved
esp/services/ws_ecl/ws_ecl_service.cpp Outdated Show resolved Hide resolved
system/jlib/jprop.cpp Show resolved Hide resolved
@afishbeck
Copy link
Member

@ghalliday I think as a follow on to instrumenting roxie/thor and esp we should consider some quick win attributes to the spans that may be very helpful. We'll probably enhance them greatly over time.. but some quick wins like general status of the span for example. Any exception that caused the span to end would be very useful.

rpastrana
rpastrana reviewed Sep 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 a couple of comments

esp/bindings/http/platform/httptransport.cpp

//MORE: The previous code would be better off querying httpHeaders...
Owned<IProperties> httpHeaders = getHeadersAsProperties(m_headers);
Owned<ISpan> requestSpan = queryTraceManager().createServerSpan("request", httpHeaders, SpanFlags::EnsureGlobalId);
Copy link
Member

Choose a reason for hiding this comment

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

I believe there's a createServerSpan which accepts StringArray, unless we're reusing IProperties httpHeaders, I'd lean towards utilizing createServerSpan (..., StringArray,...)

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 think it is likely the rest of the code would be better using an IProperties - so I will leave.

esp/services/esdl_svc_engine/esdl_binding.cpp
ISpan * activeSpan = context.queryActiveSpan();
if (activeSpan)
clientSpan.setown(activeSpan->createClientSpan("soapcall"));

Copy link
Member

Choose a reason for hiding this comment

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

is an else condition possible?
if so, no 'soapcall' tracing in the else condition?
Otherwise, do we even need the if?

Copy link
Member Author

Choose a reason for hiding this comment

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

There may be no span if the request comes through on a protocol that doesn't support it. We should be creating server spans in those cases as well, but until we can guarantee they are all covered it is safer to check 1st.

afishbeck
afishbeck reviewed Sep 28, 2023
View reviewed changes
system/jlib/jtrace.cpp Outdated
if (!isEmptyString(hpccGlobalId.get()))
ctxProps->setProp(kGlobalIdHttpHeaderName, hpccGlobalId.get());
const char * globalId = queryGlobalId();
ctxProps->setNonEmptyProp(kGlobalIdHttpHeaderName, globalId);
Copy link
Member

Choose a reason for hiding this comment

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

Trivial, but I think you could now get rid of the variable globalId and write:
ctxProps->setNonEmptyProp(kGlobalIdHttpHeaderName, queryGlobalId());

afishbeck
afishbeck approved these changes Sep 28, 2023
View reviewed changes
Copy link
Member

@afishbeck afishbeck left a comment

Choose a reason for hiding this comment

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

Approved, but one trivial comment that could get rid of a variable.

@ghalliday ghalliday merged commit e057926 into hpcc-systems:candidate-9.4.x Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpastrana rpastrana rpastrana left review comments

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