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-32131 Jtrace exporters batch config support #18807

Merged
merged 1 commit into from
Jun 26, 2024
Merged

HPCC-32131 Jtrace exporters batch config support #18807

merged 1 commit into from
Jun 26, 2024

Conversation

rpastrana
Copy link
Member

@rpastrana rpastrana commented Jun 25, 2024 •
edited
Loading

  • Enables span batch export mode by default
  • Exposes batch configuration options
  • Updates sample otel export values files to include batch config
  • Updates helm schema to expose batch confi

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

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

Jirabot Action Result:
Workflow Transition: Merge Pending
Updated PR

@rpastrana rpastrana requested a review from ghalliday June 25, 2024 03:11
ghalliday
ghalliday reviewed Jun 25, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@rpastrana a few comments.

system/jlib/jtrace.cpp Outdated
@@ -1323,12 +1333,12 @@ void CTraceManager::initTracerProviderAndGlobalInternals(const IPropertyTree * t
enableDefaultLogExporter = traceConfig->getPropBool("enableDefaultLogExporter", enableDefaultLogExporter);
}

if (enableDefaultLogExporter)
{
//if (enableDefaultLogExporter)
Copy link
Member

Choose a reason for hiding this comment

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

Why is this commented out?

system/jlib/jtrace.cpp Outdated
*/
options.max_export_batch_size = exportConfig->getPropInt("batch/@maxExportBatchSize", 512);

DBGLOG("Tracing exporter set to batch mode");
Copy link
Member

Choose a reason for hiding this comment

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

Logging at this point has caused problems in the past, probably better not to include.

system/jlib/jtrace.cpp Outdated
@@ -1285,16 +1285,26 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createP
if (!exporter)
return nullptr;

if (exportConfig->getPropBool("batch/@enabled", false))
if (exportConfig->getPropBool("batch/@enabled", true))
Copy link
Member

Choose a reason for hiding this comment

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

It would be better if the jlog (and OS?) exporter was not batched by default. Two possible ways of doing that relatively cleanly i) return an extra flag from createExporter or ii) use a dynamic cast to check if it is a logging class instance.

@rpastrana rpastrana requested a review from ghalliday June 25, 2024 13:50
rpastrana
rpastrana commented Jun 25, 2024
View reviewed changes
system/jlib/jtrace.cpp Outdated
@@ -1285,7 +1288,11 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createP
if (!exporter)
return nullptr;

if (exportConfig->getPropBool("batch/@enabled", true))
if ( dynamic_cast<opentelemetry::exporter::trace::OStreamSpanExporterFactory * >(exporter.get()) != nullptr ||
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 don't like either approach, but included both so you can tell me which one you prefer, and hopefully avoid unnecessary back and forth discussion.

Copy link
Member

Choose a reason for hiding this comment

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

I definitely prefer the boolean return value

ghalliday
ghalliday reviewed Jun 25, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@rpastrana looks good. Please clean up and squash and I will merge

system/jlib/jtrace.cpp Outdated
@@ -1285,7 +1288,11 @@ std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor> CTraceManager::createP
if (!exporter)
return nullptr;

if (exportConfig->getPropBool("batch/@enabled", true))
if ( dynamic_cast<opentelemetry::exporter::trace::OStreamSpanExporterFactory * >(exporter.get()) != nullptr ||
Copy link
Member

Choose a reason for hiding this comment

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

I definitely prefer the boolean return value

system/jlib/jtrace.cpp
@@ -1159,7 +1159,7 @@ IProperties * getSpanContext(const ISpan * span)

//---------------------------------------------------------------------------------------------------------------------

std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createExporter(const IPropertyTree * exportConfig)
std::unique_ptr<opentelemetry::sdk::trace::SpanExporter> CTraceManager::createExporter(const IPropertyTree * exportConfig, bool & shouldBatch)
{
assertex(exportConfig);
Copy link
Member

Choose a reason for hiding this comment

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

Should probably assign true in the function as a default.

@rpastrana
HPCC-32131 Jtrace exporters batch config support
7fcb208 
- Enables span batch export mode by default for remote exporters
- Exposes batch configuration options
- Updates sample otel export values files to include batch config
- Updates helm schema to expose batch confi

Signed-off-by: Rodrigo Pastrana <[email protected]>
@rpastrana rpastrana force-pushed the HPCC-32131-JtraceExportersBatch branch from d267207 to 7fcb208 Compare June 25, 2024 16:11
@ghalliday ghalliday merged commit a7aeeb7 into hpcc-systems:candidate-9.4.x Jun 26, 2024
47 of 48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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