Feature - Ginger Telemetry

[IamRanjeetSingh]

Thank you for your contribution. Before submitting this PR, please make sure:

• [ ] PR description and commit message should describe the changes done in this PR
• [ ] Verify the PR is pointing to correct branch i.e. Release or Beta branch if the code fix is for specific release , else point it to master
• [ ] Latest Code from master or specific release branch is merged to your branch
• [ ] No unwanted\commented\junk code is included
• [ ] No new warning upon build solution
• [ ] Code Summary\Comments are added to my code which explains what my code is doing
• [ ] Existing unit test cases are passed
• [ ] New Unit tests are added for your development
• [ ] Sanity Tests are successfully executed for New and Existing Functionality
• [ ] Verify that changes are compatible with all relevant browsers and platforms.
• [ ] After creating pull request there should not be any conflicts
• [ ] Resolve all Codacy comments
• [ ] Builds and checks are passed before PR is sent for review
• [ ] Resolve code review comments
• [ ] Update the Help Library document to match any feature changes

Summary by CodeRabbit

• New Features

  • Enhanced telemetry tracking for export processes, providing detailed insights into executed business flows, activities, and actions.
  • Introduced a structured TelemetryMetadata class for improved management and serialization of telemetry data.
  • Improved telemetry integration for API parsing operations, logging metadata for better monitoring.

• Bug Fixes

  • Enhanced error handling during API parsing to ensure accurate telemetry reporting.

• Documentation

  • Updated documentation to reflect the new telemetry features and enhancements.

• Chores

  • Upgraded dependencies to support the latest telemetry functionalities.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request enhances telemetry tracking across several methods related to exporting BPMN data and API parsing. It introduces the IFeatureTracker interface to gather detailed metadata about executed business flows, activity groups, activities, and actions. Additionally, a new TelemetryMetadata class is added to manage telemetry data in a structured manner. These updates improve the observability of export functionalities and API parsing processes without altering the core logic of the methods.

Changes

Files	Change Summary
Ginger/Ginger/Run/RunSetsExecutionsHistoryPage.xaml.cs, Ginger/Ginger/SolutionWindows/TreeViewItems/BusinessFlowTreeItem.cs, Ginger/Ginger/SolutionWindows/TreeViewItems/SharedActivitiesGroupTreeItem.cs	Enhanced export methods with telemetry tracking to monitor counts of executed business flows, activities, and actions.
Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs	Improved telemetry tracking in the ParseDocument method for monitoring API parsing operations for both YAML and JSON.
Ginger/GingerCoreCommon/Telemetry/TelemetryMetadata.cs	Introduced TelemetryMetadata class for structured telemetry data management, including key-value pairs and JSON serialization.

Possibly related PRs

• #3739: This PR enhances telemetry tracking in the ExportBPMNFromRunSetReportAsync method, which is directly related to the telemetry improvements made in the main PR for the export functionality.
• #3771: Although primarily focused on bug fixes, it involves changes in the PlaywrightDriver.cs file, which may indirectly relate to the overall telemetry and export functionalities in the project.
• #3902: The update of the RestSharp package could impact the HTTP request handling in the telemetry tracking, making it relevant to the main PR's focus on enhancing telemetry capabilities.

Poem

🐰 In the realm of code, where rabbits play,
Telemetry blooms, brightening the way.
With counts and logs, we track every flow,
Exporting with joy, watch our data grow!
Hops of progress, in every line,
Celebrate changes, oh how they shine! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` or `@coderabbitai title` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.