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

fix: license-api replicas too high due to CPU request being too low #15956

Merged
merged 3 commits into from
Sep 11, 2024

Conversation

peturgq
Copy link
Member

@peturgq peturgq commented Sep 11, 2024

...

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Increased CPU allocation for the license-api service from 15m to 50m across all environments, enhancing performance and responsiveness.
  • Bug Fixes

    • Adjusted resource management to better handle increased workloads for the license-api.

@peturgq peturgq requested a review from a team as a code owner September 11, 2024 13:36
@peturgq peturgq added the automerge Merge this PR as soon as all checks pass label Sep 11, 2024
@island-is island-is deleted a comment from coderabbitai bot Sep 11, 2024
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

The changes involve modifications to the resource allocation settings for the license-api service across multiple configuration files. Specifically, the CPU request has been increased from 15m to 50m, while the memory request remains unchanged at 256Mi. This adjustment is reflected in the serviceSetup function in the TypeScript file and in the YAML configuration files for development, production, and staging environments.

Changes

Files Change Summary
apps/services/license-api/infra/license-api.ts, charts/islandis/values.dev.yaml, charts/islandis/values.prod.yaml, charts/islandis/values.staging.yaml CPU request modified from 15m to 50m; memory request remains 256Mi.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 921dcaa and 78c4d2b.

Files selected for processing (3)
  • charts/islandis/values.dev.yaml (1 hunks)
  • charts/islandis/values.prod.yaml (1 hunks)
  • charts/islandis/values.staging.yaml (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • charts/islandis/values.dev.yaml
  • charts/islandis/values.prod.yaml
  • charts/islandis/values.staging.yaml

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
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.
    • @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.

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.

Copy link
Member

@robertaandersen robertaandersen left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (75e2db8) to head (921dcaa).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #15956   +/-   ##
=======================================
  Coverage   36.84%   36.84%           
=======================================
  Files        6709     6709           
  Lines      137553   137553           
  Branches    39102    39102           
=======================================
  Hits        50676    50676           
  Misses      86877    86877           
Flag Coverage Δ
api 3.39% <ø> (ø)
api-domains-auth-admin 49.89% <ø> (ø)
api-domains-communications 40.54% <ø> (ø)
application-system-api 41.69% <ø> (ø)
application-template-api-modules 23.48% <ø> (ø)
cms 0.42% <ø> (ø)
cms-translations 39.70% <ø> (ø)
judicial-system-api 19.35% <ø> (ø)
services-user-notification 47.74% <ø> (ø)
web 1.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 75e2db8...921dcaa. Read the comment docs.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
charts/islandis/values.staging.yaml (1)

1483-1483: Approve increasing CPU request. Monitor resource usage post-change.

Increasing the CPU request from 15m to 50m for the license-api service is approved as it may improve performance under load.

However, it's important to closely monitor the service's CPU utilization and key performance metrics (latency, error rates, etc.) after rolling out this change. This will help confirm if the new CPU request is appropriate and the extra resources are being effectively utilized without wastage. Make adjustments if needed based on the monitoring data.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75e2db8 and 921dcaa.

Files selected for processing (4)
  • apps/services/license-api/infra/license-api.ts (1 hunks)
  • charts/islandis/values.dev.yaml (1 hunks)
  • charts/islandis/values.prod.yaml (1 hunks)
  • charts/islandis/values.staging.yaml (1 hunks)
Additional context used
Path-based instructions (1)
apps/services/license-api/infra/license-api.ts (2)

Pattern apps/services/**/*: "Confirm that the code adheres to the following:

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Additional comments not posted (3)
apps/services/license-api/infra/license-api.ts (1)

16-16: LGTM! The change optimizes resource allocation.

The increase in CPU request from 15m to 50m is a positive change that aims to enhance the performance and responsiveness of the license-api service by allocating more CPU resources. This change aligns with the overall objective of the pull request to address the issue of having too many replicas due to low CPU request.

The change adheres to the NestJS architecture and dependency injection patterns, and it does not introduce any new warnings or errors. Additionally, the change does not require any updates to the tests or documentation.

Overall, this change contributes to better resource management and optimization of the license-api service.

charts/islandis/values.prod.yaml (1)

1605-1605: Approve the CPU request increase for license-api, but verify the reasoning and impact.

The CPU request for the license-api has been substantially increased from 15m to 50m, while the memory request remains unchanged.

This gives the service higher CPU scheduling priority and access when needed, which may be warranted based on increased load or utilization.

As long as there is sufficient cluster CPU capacity, this should not adversely starve other services. However, given the magnitude of the relative increase, please verify:

  1. The reasoning behind this change, such as increased traffic, slow response times, high CPU utilization, etc.
  2. The impact on cluster CPU utilization and headroom after this change.
charts/islandis/values.dev.yaml (1)

1738-1738: Approve increasing CPU request, but verify system impact.

Increasing the CPU request from 15m to 50m can help improve the performance of the license-api service.

However, ensure that this change is thoroughly tested to confirm that:

  • The license-api service behaves as expected with the increased CPU allocation.
  • There are no adverse effects on other parts of the system that interact with this service.

@datadog-island-is
Copy link

Datadog Report

All test runs 4e586a7 🔗

11 Total Test Services: 0 Failed, 10 Passed
➡️ Test Sessions change in coverage: 27 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.98s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 13.56s 1 no change Link
api-domains-communications 0 0 0 5 0 33.02s 1 no change Link
api-domains-license-service 0 0 0 0 0 592.73ms 1 no change Link
application-system-api 0 0 0 111 2 3m 40.31s 1 no change Link
application-template-api-modules 0 0 0 109 0 1m 51.84s 1 no change Link
cms-translations 0 0 0 3 0 31.84s 1 no change Link
judicial-system-api 0 0 0 57 0 6.52s 1 no change Link
judicial-system-backend 0 0 0 21086 0 0s N/A Link
services-user-notification 0 0 0 51 0 1m 37.23s 1 no change Link

@kodiakhq kodiakhq bot merged commit 82360b0 into main Sep 11, 2024
28 checks passed
@kodiakhq kodiakhq bot deleted the scaling/license-api branch September 11, 2024 14:04
jonnigs pushed a commit that referenced this pull request Sep 12, 2024
…15956)

* fix: license-api replicas too high due to CPU request being too low

* chore: charts update dirty files

---------

Co-authored-by: andes-it <builders@andes.is>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants