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

Update documentation for Actor and Scheduler statistics #4406

Merged
merged 1 commit into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/runtime_info/actor_stats.pony
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ use @pony_actor_stats[_ActorStats]()

primitive ActorStats
"""
Provides functions that expose statistics about the current actor.
Provides functions that expose statistics about the current actor. All
methods will return '0' if the runtime used the program wasn't compiled with
runtime statistics turned on.
"""

fun heap_mem_allocated(auth: ActorStatsAuth): USize =>
Expand Down
4 changes: 3 additions & 1 deletion packages/runtime_info/scheduler_stats.pony
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ use @pony_scheduler_stats[_SchedulerStats]()

primitive SchedulerStats
"""
Provides functions that expose statistics about the current scheduler.
Provides functions that expose statistics about the current scheduler. All
methods will return '0' if the runtime used the program wasn't compiled with
runtime statistics turned on.
"""

fun total_mem_allocated(auth: SchedulerStatsAuth): I64 =>
Expand Down
Loading