SeanOMik
/
lyra-engine
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

Simple Engine profiling #7

New Issue
Closed
opened 2024-03-23 10:49:32 -04:00 by SeanOMik · 1 comment
SeanOMik commented 2024-03-23 10:49:32 -04:00
Owner
Copy Link

The engine is already using tracing as a logging library, however it can also be used as an instrumentation tool.

The plan I have is to use the #[instrument] proc-macro in more places in the engine, and manually create spans wherever they are needed. There is a great tool called Tracy that can be used to view the profile. The tracing_tracy library is required to collect Tracy profiles from tracing instrumentation. There's also clippy-tracing that can be used to add the instrument attribute to all functions automatically.

The engine is already using [tracing](https://github.com/tokio-rs/tracing) as a logging library, however it can also be used as an instrumentation tool. The plan I have is to use the `#[instrument]` proc-macro in more places in the engine, and manually create spans wherever they are needed. There is a great tool called [Tracy](https://github.com/wolfpld/tracy) that can be used to view the profile. The [tracing_tracy](https://github.com/nagisa/rust_tracy_client) library is required to collect Tracy profiles from tracing instrumentation. There's also [clippy-tracing](https://crates.io/crates/clippy-tracing) that can be used to add the instrument attribute to all functions automatically.
SeanOMik added the
Kind/Feature
 label 2024-03-23 10:49:32 -04:00
SeanOMik changed title from Profiling the engine using Tracing to Engine profiling 2024-03-23 10:49:48 -04:00
SeanOMik changed title from Engine profiling to Simple Engine profiling 2024-04-24 18:30:04 -04:00
SeanOMik commented 2024-04-24 18:33:04 -04:00
Author
Owner
Copy Link

The profiling tools above have been implemented and tested. They work great. It will take some time to profile the entire engine, each portion can be instrumented when each part is being worked on. I think its safe to close this, even if the entire engine isn't profiled.

The profiling tools above have been implemented and tested. They work great. It will take some time to profile the entire engine, each portion can be instrumented when each part is being worked on. I think its safe to close this, even if the *entire* engine isn't profiled.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
main
chore/winit-wgpu-update
feat/shadow-maps
debug/sig-abort
feature/scene-as-ecs
Labels
Clear labels   
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No Label
Kind/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: SeanOMik/lyra-engine#7
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?