HPCC-33023 Prevent periodic sinks from collecting if prepare fails

[kenrowland]

Added return code to base class prepareToStartCollecting method to
prevent starting the collection thread.

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:

[github-actions]

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

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

[rpastrana]

@kenrowland this seems fine.
However, the logSink seems to assume logging is always available, it might not be worth querying the logmanager in order to avoid unnecessary metric processing if no logging is going to be reported anyway but you should look into that if you haven't done so already.

Also, I was initially surprised the prometheus sink wasn't updated but realized it implements a basic interface w/out the preparetostartcollecting method, did you consider preventing it from collecting if the startCollection fails?

[kenrowland]

@rpastrana
I did not consider that logging sink would fail preparing to collect since it simply writes to the logs. I see your point on returning false if the log messages were going to be suppressed because logging settings. If you feel this is something we should add before merging, let me know. Or, we can open another Jira to add it.

As far as prometheus goes, since it is a polled sink, it could decide to no do collection and simply not listen for the polling call. The call to startCollection only tells it to start listening. No other resources or actions are done by the framework, Failing the startCollection call wouldn't really do anything.

[rpastrana]

If the log sink prepareToStartCollent return value is not 100% accurate it should be fixed in this pr. If you plan to do that work in a separate PR, add the jira here.

[kenrowland]

@rpastrana Opened HPCC-33101 for the logging sink to check current log levels.

[kenrowland]

@ghalliday Please merge

[github-actions]

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