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-30821 Use json format for metrics in the log #18307

Merged
merged 1 commit into from
Feb 19, 2024
Merged

HPCC-30821 Use json format for metrics in the log #18307

merged 1 commit into from
Feb 19, 2024

Conversation

ghalliday
Copy link
Member

@ghalliday ghalliday commented Feb 16, 2024 •
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:

@ghalliday ghalliday requested a review from kenrowland February 16, 2024 16:04
@ghalliday
Copy link
Member Author

Tested in combination with #18021

@github-actions GitHub Actions
Copy link

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

kenrowland
kenrowland approved these changes Feb 16, 2024
View reviewed changes
Copy link
Contributor

@kenrowland kenrowland left a comment

Choose a reason for hiding this comment

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

See comments in case there is a desire to remove the "Prometheus" personality from the output.

system/metrics/sinks/log/logSink.cpp
name.append(".").append(metaDataIt.value);
if (labels.length() > 0)
labels.append(",");
labels.appendf("{ \"name\":\"%s\", \"value\": \"%s\" }", metaDataIt.key.c_str(), metaDataIt.value.c_str());
Copy link
Contributor

Choose a reason for hiding this comment

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

Treating the meta data like labels is a Prometheus feature. I simply concatenated the meta data to create a unique name that would be easy to grep for in the logs if needed. The framework also concatenates the meta data to create the unique metric name when detecting duplicates during registration. That was another reason the same mechanism was used to create the name for the log entry.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. In this case the format is up to us, and I want it to be able to reflect the most detailed representation - so that the developers can clearly see the logical description of the metric in the logs.

system/metrics/sinks/log/logSink.cpp
std::vector<__uint64> values = pMetric->queryHistogramValues();
std::vector<__uint64> limits = pMetric->queryHistogramBucketLimits();
size_t countBucketValues = values.size();
__uint64 cumulative = 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

The base histogram does not accumulate bucket measurement counts. The Prometheus sink does since it is the required format. I left the log and file sinks to only report the actual counts per bucket to match the way the metric stored the data and possibly make it easier to extract certain counts from the log if needed. Accumulating the counts makes the output more like Prometheus. Just an overall comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I also deliberately changed this. The reason again was to help developers. If you have a list
[10,20,0,0,0,0,1,0] it is much easier to visually spot that you have an unexpected outlier than if you have a list
[10,30,30,30,30,30,31,31]

@ghalliday
Copy link
Member Author

@kenrowland see responses to comments.

@ghalliday ghalliday merged commit 038b9b9 into hpcc-systems:candidate-9.4.x Feb 19, 2024
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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