Integrated code lifecycle: Export metrics for monitoring

[Hialus]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I documented the Java code using JavaDoc style.

Motivation and Context

Currently, there is no option to monitor the number of builds through an external system like Prometheus when using LocalCI.

Description

Based on @bensofficial work in #8252.
We added several metrics:

• The number of total active builds
• The number of total queued builds
• The number of all build agent instances
• The number of the total max concurrent builds

Steps for Testing

Deploy this PR to Staging ICL and have a look at the statistics in Grafana.

Also, deploy this PR to a server without ICL and check that the server still starts.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Unchanged

Screenshots

Summary by CodeRabbit

• Refactor
  • Updated MetricsBean class for enhanced performance and integration with ProfileService for profile management.
  • Improved metrics registration to include local CI information.
• New Features
  • Introduced a helper service in ProfileService for active profile checking, supporting a broader range of profiles including development, scheduling, and various CI/CD tools.
• Chores
  • Deprecated the isBambooActive method in favor of more comprehensive profile checking methods.

[coderabbitai]

Walkthrough

The recent update significantly restructures the MetricsBean class, enhancing its functionality by incorporating new service dependencies, refining constructor parameters, and integrating ProfileService for improved profile management. Additionally, it introduces metrics registration tailored to local Continuous Integration (CI) setups. The ProfileService itself has been expanded with capabilities to check for active profiles, aiding in the identification of the environment setup, while marking previous methods as deprecated in favor of more comprehensive alternatives.

Changes

File	Summary
.../config/MetricsBean.java	Removed unused imports; added new service dependencies; refactored constructor parameters; integrated ProfileService for profile management; introduced metrics registration for local CI.
.../service/ProfileService.java	Added service for checking active profiles; introduced methods for specific profiles (development, scheduling, bamboo, gitlabci/jenkins, local VCS/CI, aeolus); deprecated isBambooActive method.

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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/coderabbit-overrides.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.