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

Added Dynamic Analysis tool: Iroh #42

Open
wants to merge 5 commits into
base: f24
Choose a base branch
from
Open

Added Dynamic Analysis tool: Iroh #42

wants to merge 5 commits into from

Conversation

jullia02
Copy link

@jullia02 jullia02 commented Oct 24, 2024

Iroh

Iroh is a tool that enables runtime code analysis and performance monitoring. It will allow us to identify slow functions which could affect NodeeBB's functionality and performance. In this PR I Integrated Iroh to track execution time and performance of critical topic functions like creation and replies.

  • Note: Running this on all NodeBB functions will generate a lot of logs and impact performance so I chose to only run it on critical functions, specifically functions changed with our added features from project 2.

Concrete evidence that you had successfully installed the tool

  • Added iroh to install/package.json
    Screenshot 2024-10-24 at 5 16 50 PM
  • Added an iroh folder that contains a function that uses iroh to monitor functions and log their runtime
    Screenshot 2024-10-24 at 5 18 23 PM

Artifacts that demonstrate that you have successfully run the tool on your repository

Ran iroh on core nodeBB topic functions. Running node app.js and performing a topic function such as creating a new topic will produce the following output, shown on the terminal.
iroh-output.txt

Screenshot 2024-10-24 at 5 24 41 PM Screenshot 2024-10-24 at 5 23 51 PM

@jullia02 jullia02 added the enhancement New feature or request label Oct 24, 2024
@jullia02 jullia02 self-assigned this Oct 24, 2024
@jullia02 jullia02 changed the title Added dynamic analysis tool: Iroh Added Dynamic Analysis tool: Iroh Oct 24, 2024
@jullia02 jullia02 closed this Oct 24, 2024
@coveralls
Copy link

coveralls commented Oct 24, 2024

Pull Request Test Coverage Report for Build 11507553315

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.002%) to 82.723%

Files with Coverage Reduction New Missed Lines %
src/meta/errors.js 1 83.72%
Totals Coverage Status
Change from base Build 11506699284: 0.002%
Covered Lines: 22359
Relevant Lines: 25613

💛 - Coveralls

@jullia02 jullia02 reopened this Oct 24, 2024
@jullia02 jullia02 requested a review from mhli1260 October 24, 2024 21:35
Copy link

@mhli1260 mhli1260 left a comment

Choose a reason for hiding this comment

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

packages.json changes reflect iroh installation, and files in iroh folder show use of iroh to monitor functions and log their runtime. Thank you for including your terminal output, it was helpful to see a successful installation and use of the tool through console logs and the output file! Looks good to me.

@alicekang1 alicekang1 added this to the Sprint 3 milestone Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants