Added the --report-openmetrics option, allowing OpenMetrics reports

[Halleck45]

When the --report-openmetrics=report.txt option is used, it generates a file with something like:

# TYPE cyclomatic_complexity gauge
# HELP cyclomatic_complexity Cyclomatic complexity of the code
cyclomatic_complexity{path="file1"} 10
# TYPE lines_of_code gauge
# HELP lines_of_code Lines of code
lines_of_code{path="file1"} 100
# TYPE logical_lines_of_code gauge
# HELP logical_lines_of_code Logical lines of code
logical_lines_of_code{path="file1"} 80
# TYPE comment_lines_of_code gauge
# HELP comment_lines_of_code Comment lines of code
comment_lines_of_code{path="file1"} 20
# TYPE maintainability gauge
# HELP maintainability Maintainability index
maintainability{path="file1"} 75.5
# TYPE maintainability_without_comments gauge
# HELP maintainability_without_comments Maintainability index without comments
maintainability_without_comments{path="file1"} 70
# TYPE number_of_functions gauge
# HELP number_of_functions Number of functions
number_of_functions{path="file1"} 0
# TYPE number_of_classes gauge
# HELP number_of_classes Number of classes
number_of_classes{path="file1"} 0
# TYPE afferent_coupling gauge
# HELP afferent_coupling Afferent coupling
afferent_coupling{path="file1"} 5
# TYPE efferent_coupling gauge
# HELP efferent_coupling Efferent coupling
efferent_coupling{path="file1"} 3
# EOF

Summary by CodeRabbit

• New Features

  • Introduced a command-line flag for generating OpenMetrics reports, allowing users to specify a file path.
  • Added functionality to generate OpenMetrics reports alongside existing report types (HTML, Markdown, and JSON).
  • Default filename for OpenMetrics report set to metrics.txt if no filename is provided.

• Bug Fixes

  • Enhanced error handling during report generation to ensure proper logging and user feedback.

• Tests

  • Implemented unit tests for the OpenMetrics report generator to validate its functionality under various scenarios.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 85.59322% with 17 lines in your changes missing coverage. Please review.

Project coverage is 54.39%. Comparing base (94cfcdb) to head (6cf9324).

Files with missing lines	Patch %	Lines
src/Report/OpenMetrics/OpenMetricsGenerator.go	87.15%	10 Missing and 4 partials ⚠️
src/Command/AnalyzeCommand.go	0.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #70      +/-   ##
==========================================
+ Coverage   53.69%   54.39%   +0.69%     
==========================================
  Files          43       44       +1     
  Lines        4894     5006     +112     
==========================================
+ Hits         2628     2723      +95     
- Misses       2038     2050      +12     
- Partials      228      233       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new command-line flag, report-openmetrics, to the analyze command in the main.go file of the ast-metrics application, enabling users to generate OpenMetrics reports. The Action function is updated to handle this flag and set the corresponding configuration property. Additionally, a new OpenMetricsReportGenerator type is implemented to generate the reports, and unit tests are added to validate its functionality. The changes enhance the reporting capabilities of the application without altering existing functionalities.

Changes

File	Change Summary
main.go	Added report-openmetrics flag to analyze command; updated Action function to handle the flag and set default report filename in CI mode.
src/Command/AnalyzeCommand.go	Modified Execute method to include logic for generating OpenMetrics reports based on the new configuration.
src/Configuration/Configuration.go	Added OpenMetrics field to ConfigurationReport struct for report configuration.
src/Report/OpenMetrics/OpenMetricsGenerator.go	Introduced OpenMetricsReportGenerator type with methods for report generation and error handling.
src/Report/OpenMetrics/OpenMetricsGenerator_test.go	Added unit tests for OpenMetricsReportGenerator to validate report generation functionality under various conditions.

Possibly related PRs

• Improving DX, adding a --ci option and listing generated reports in output #68: The changes in this PR also involve modifications to the main.go file, specifically related to command-line flags and report generation, which aligns with the addition of the report-openmetrics flag in the main PR.

Warning

Rate limit exceeded

@Halleck45 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 14 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 94cfcdb and 6cf9324.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.