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-29468 Document STD.system.log.getElapsedMs #17949

Merged
merged 1 commit into from
Nov 10, 2023
Merged

HPCC-29468 Document STD.system.log.getElapsedMs #17949

merged 1 commit into from
Nov 10, 2023

Conversation

JamesDeFabia
Copy link
Contributor

@JamesDeFabia JamesDeFabia commented Oct 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
Copy link

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

g-pan
g-pan approved these changes Oct 24, 2023
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

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

Tested and Approved.

g-pan
g-pan reviewed Oct 24, 2023
View reviewed changes
docs/EN_US/ECLStandardLibraryReference/SLR-Mods/getElapsedMs.xml Outdated
<para>The <emphasis role="bold">getElapsedMs </emphasis>function returns the
current elapsed query time (in ms) in Roxie. </para>

<para><emphasis role="bold">For use Roxie only</emphasis>. An error is
Copy link
Member

Choose a reason for hiding this comment

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

add "in" - For use in Roxie only

@JamesDeFabia JamesDeFabia requested a review from g-pan October 25, 2023 12:50
g-pan
g-pan approved these changes Oct 25, 2023
View reviewed changes
Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

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

looks good

afishbeck
afishbeck reviewed Oct 27, 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.

@JamesDeFabia basically looks good but one comment about expectations for this function in ECL which is declarative.

docs/EN_US/ECLStandardLibraryReference/SLR-Mods/getElapsedMs.xml Outdated
</informaltable>

<para>The <emphasis role="bold">getElapsedMs </emphasis>function returns the
current elapsed query time (in ms) in Roxie.</para>
Copy link
Member

Choose a reason for hiding this comment

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

You may want to mention that this is the elapsed time when STD.System.Log.getElapsedMs() is called. Because ECL is a declarative language that can sometimes be confusing. ECL code is not executed in sequence so you have to be careful when trying to get the elapsed time for a particular point. @ghalliday may have better wording for that topic.

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

@g-pan g-pan g-pan approved these changes

@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.
4 participants
@JamesDeFabia @afishbeck @g-pan @ghalliday