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 documentation for Performance Analyzer #3924

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

EdibSU
Copy link
Contributor

@EdibSU EdibSU commented Nov 13, 2024

No description provided.

@EdibSU EdibSU requested a review from a team as a code owner November 13, 2024 14:30
The Performance Analyzer NuGet is designed to track and log performance metrics for methods in single or multi-threaded environments. It provides developers with an easy way to monitor execution times and track method calls across systems by logging performance data to the storage of their choice.

> [!INSTALL]
> The NuGet can be installed by downloading [Skyline.DataMiner.Utils.PerformanceAnalyzer]().
Copy link
Member

Choose a reason for hiding this comment

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

link needs to be added

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm still waiting for approval to make the NuGet public.

> The NuGet can be installed by downloading [Skyline.DataMiner.Utils.PerformanceAnalyzer]().

> [!NOTE]
> The NuGet can be used as standalone tool.
Copy link
Member

Choose a reason for hiding this comment

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

This note is not really clear... I assume this means that the NuGet works on its own and the LCA is optional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes


![Performance Analyzer LCA](~/user-guide/images/performance_analyzer_lca.png)

1. **Performance Analyzer Metrics Folder**: Defines the folder where performance data files are located.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a default folder?

Copy link
Member

Choose a reason for hiding this comment

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

Should refer to the readme on the GitHub repo instead of adding the documentation here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants