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.

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

HPCC-33338 Convert statically allocated metrics to dynamic allocation #19577

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kenrowland
Copy link
Contributor

@kenrowland kenrowland commented Feb 28, 2025

Removed statically allocated metrics in favor of using MODULE_INIT

Signed-Off-By: Kenneth Rowland [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:

Copy link

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

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

Choose a reason for hiding this comment

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

PR Overview

This PR converts statically allocated metrics to dynamic allocation and updates the documentation on metric creation methods. Key changes include:

  • Revised step-by-step guidance for creating and registering metrics.
  • Introduction of different initialization methods including module initialization and construction.
  • Updates to code examples to reflect dynamic metric registration.

Reviewed Changes

File Description
devdoc/Metrics.md Updated documentation and code examples for metric creation and registration

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

@hpcc-systems hpcc-systems deleted a comment from Copilot bot Mar 4, 2025
@hpcc-systems hpcc-systems deleted a comment from Copilot bot Mar 4, 2025
Copy link
Contributor

@JamesDeFabia JamesDeFabia 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 from my POV (I only reviewed the MD file)

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.

Seems fine. It might be helpful to describe the problems a developer would encounter and would force them to chose the 3rd option.

will be reported. Essentially, the metric is a black hole.
#### Static Creation
Static creation should be a last resort. If the above methods do not solve the problem of metric
allocation and registering, then static creation is the next best choice. The primary reason to
Copy link
Member

Choose a reason for hiding this comment

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

What are the symptoms of "problem of metric allocation and registering" that would lead a developer to chose this option?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a couple of bullet points detailing general reasons why registering can fail.

Removed statically allocated metrics in favor of using MODULE_INIT

Signed-Off-By: Kenneth Rowland [email protected]
@kenrowland
Copy link
Contributor Author

@ghalliday Ready for merging unless you'd like Jake to review the metric changes in the Dali source files.

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.

Looks ok afaics.

@kenrowland
Copy link
Contributor Author

@ghalliday Please merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants