Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update DTrace probes #4302

Merged
merged 1 commit into from
Jan 17, 2023
Merged

Update DTrace probes #4302

merged 1 commit into from
Jan 17, 2023

Conversation

SeanTAllen
Copy link
Member

A user opened #4296 and noted that the probes were out of date. The names of @params in comments need to match the names in the function definitions.

While exploring the issue, I found that some functions lacked param definitions, some had missing params, some had misnamed params, and some functions were lacking useful information such as the actor in being run where only the scheduler was present and the actor is the most useful bit of information.

This commit fixes all the issues I found and in the process closes the original issue.

Fixes #4296

@SeanTAllen SeanTAllen requested a review from a team January 13, 2023 22:48
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Jan 13, 2023
@SeanTAllen
Copy link
Member Author

@jemc thoughts on if this needs a CHANGELOG entry and release notes?

*/
probe gc__start(uintptr_t scheduler);
probe gc__start(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

this one was incorrect and was already taking the actor.

*/
probe gc__recv__start(uintptr_t scheduler);
probe gc__recv__start(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

added actor to trace.

*/
probe gc__recv__end(uintptr_t scheduler);
probe gc__recv__end(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

added actor to trace.

*/
probe gc__send__start(uintptr_t scheduler);
probe gc__send__start(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

added actor to trace.

*/
probe gc__send__end(uintptr_t scheduler);
probe gc__send__end(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

added actor to trace.

*/
probe gc__end(uintptr_t scheduler);
probe gc__end(uintptr_t scheduler, uintptr_t actor);
Copy link
Member Author

Choose a reason for hiding this comment

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

added actor to trace

@SeanTAllen SeanTAllen force-pushed the issue-4296 branch 2 times, most recently from 05ad078 to 626936e Compare January 13, 2023 22:58
@SeanTAllen
Copy link
Member Author

A close review to make sure I didn't fubar anything would be appreciated.

@jemc
Copy link
Member

jemc commented Jan 15, 2023

thoughts on if this needs a CHANGELOG entry and release notes?

I don't know much about how dtrace is used, but my initial thought would be yes, a changelog entry would be nice.

@SeanTAllen SeanTAllen added do not merge This PR should not be merged at this time changelog - changed Automatically add "Changed" CHANGELOG entry on merge labels Jan 15, 2023
@ponylang-main
Copy link
Contributor

Hi @SeanTAllen,

The changelog - changed label was added to this pull request; all PRs with a changelog label need to have release notes included as part of the PR. If you haven't added release notes already, please do.

Release notes are added by creating a uniquely named file in the .release-notes directory. We suggest you call the file 4302.md to match the number of this pull request.

The basic format of the release notes (using markdown) should be:

## Title

End user description of changes, why it's important,
problems it solves etc.

If a breaking change, make sure to include 1 or more
examples what code would look like prior to this change
and how to update it to work after this change.

Thanks.

@SeanTAllen SeanTAllen changed the title Update dtrace probes Update DTrace probes Jan 16, 2023
A user opened #4296 and noted that the probes were out of date. The
names of @params in comments need to match the names in the function
definitions.

While exploring the issue, I found that some functions lacked param
definitions, some had missing params, some had misnamed params, and some
functions were lacking useful information such as the actor in being run
where only the scheduler was present and the actor is the most useful
bit of information.

This commit fixes all the issues I found and in the process closes the
original issue.

Fixes #4296
@SeanTAllen
Copy link
Member Author

Release notes added.

@SeanTAllen SeanTAllen removed the do not merge This PR should not be merged at this time label Jan 16, 2023
@SeanTAllen SeanTAllen merged commit c56adc4 into main Jan 17, 2023
@SeanTAllen SeanTAllen deleted the issue-4296 branch January 17, 2023 16:39
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Jan 17, 2023
github-actions bot pushed a commit that referenced this pull request Jan 17, 2023
github-actions bot pushed a commit that referenced this pull request Jan 17, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
changelog - changed Automatically add "Changed" CHANGELOG entry on merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect argument names and counts in dtrace probes documentation.
3 participants