Server scalability improvements #2752

stefannica · 2024-06-05T21:52:50Z

Describe changes

This PR brings a number of improvements meant to make the ZenML server more scalable and resilient under load:

make the health check endpoint async. This makes the health check responsive even when all the worker threads are otherwise occupied with other requests. It prevents Kubernetes from killing and restarting ZenML server pods when they are under sustained load.
configurable thread pool size (default is 40, same as FastAPI's). In addition to Kubernetes resources, auto-scaling and replica count options, this can be used to tweak the ZenML server configuration to achieve an optimal resource use.
sync the cloud API requests connection pool to the server's thread pool size. The previous configuration used the default value of 10 connections which is misaligned with the number of worker threads in the ZenML Pro tenants and therefore leading to warnings such as:

Connection pool is full, discarding connection: cloudapi.zenml.io. Connection pool size: 10

make all dashboard endpoints async as well. Given that these endpoints do not make any blocking I/O calls, they can also be implemented as asyncio coroutines which means then will no longer be competing over the limited amount of worker threads. This further improves the ZenML server responsiveness under load.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-06-05T21:54:52Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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 as 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.

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/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.

strickvl · 2024-06-06T07:00:07Z

Just adding @avishniakov as a reviewer on the PR as it feels like OSS team should have a sense of these changes

wjayesh

Looks good to me save for a few comments.

wjayesh · 2024-06-06T07:34:19Z

src/zenml/zen_server/cloud_utils.py

+                    # We only use one connection pool to be cached because we
+                    # only communicate with one remote server (the control
+                    # plane)
+                    pool_connections=1,


For my understanding, is it costly to have more cached hosts? I understand we need only one but want to know what impact this would have.

There is no impact in this case. We can set this to 10 or 100, there will only be one connection pool because we only need to connect to one host. This is better covered here, if you want the gruesome details: https://stackoverflow.com/questions/34837026/whats-the-meaning-of-pool-connections-in-requests-adapters-httpadapter

Really well explained answer; had this in bookmarks for a while ;) thanks!

wjayesh · 2024-06-06T07:45:06Z

src/zenml/zen_server/deploy/helm/templates/server-secret.yaml

+  ZENML_STORE_POOL_SIZE: {{ .Values.zenml.database.poolSize | b64enc | quote }}
+  {{- end }}
+  {{- if .Values.zenml.database.maxOverflow }}
+  ZENML_STORE_POOL_SIZE: {{ .Values.zenml.database.maxOverflow | b64enc | quote }}


Duplicate key?

good catch ! thank you !

schustmi · 2024-06-06T08:17:07Z

src/zenml/zen_server/zen_server_api.py

 from fastapi import FastAPI, HTTPException, Request
 from fastapi.exceptions import RequestValidationError
 from fastapi.responses import ORJSONResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
+from py import log


This and the sleep import seem unused?

Correct, I removed them. The linter was also flagging them.

* configurable thread pool size * sync the cloud API requests connection pool to the server's thread pool size * make the health check endpoint async * make all dashboard endpoints async as well

github-actions · 2024-06-06T19:10:11Z

Quickstart template updates in examples/quickstart have been pushed.

github-actions · 2024-06-06T19:16:34Z

E2E template updates in examples/e2e have been pushed.

github-actions · 2024-06-06T19:18:42Z

NLP template updates in examples/e2e_nlp have been pushed.

…ments

stefannica requested review from schustmi and wjayesh June 5, 2024 21:52

github-actions bot added internal To filter out internal PRs and issues bug Something isn't working labels Jun 5, 2024

stefannica added the run-slow-ci label Jun 5, 2024

strickvl requested a review from avishniakov June 6, 2024 06:59

wjayesh reviewed Jun 6, 2024

View reviewed changes

schustmi approved these changes Jun 6, 2024

View reviewed changes

stefannica requested a review from wjayesh June 6, 2024 08:52

Server scalability improvements

5a15ac7

* configurable thread pool size * sync the cloud API requests connection pool to the server's thread pool size * make the health check endpoint async * make all dashboard endpoints async as well

stefannica force-pushed the bug/cloudk-530-server-scalability-improvements branch from d1e5313 to 5a15ac7 Compare June 6, 2024 19:08

Auto-update of Starter template

624fb93

Auto-update of E2E template

819691f

Auto-update of NLP template

13f7298

Merge branch 'develop' into bug/cloudk-530-server-scalability-improve…

537f1a9

…ments

stefannica merged commit 95c113d into develop Jun 10, 2024
67 of 71 checks passed

stefannica deleted the bug/cloudk-530-server-scalability-improvements branch June 10, 2024 07:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Server scalability improvements #2752

Server scalability improvements #2752

stefannica commented Jun 5, 2024 •

edited

Loading

coderabbitai bot commented Jun 5, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

strickvl commented Jun 6, 2024

wjayesh left a comment

wjayesh Jun 6, 2024

stefannica Jun 6, 2024

wjayesh Jun 6, 2024

wjayesh Jun 6, 2024

stefannica Jun 6, 2024

schustmi Jun 6, 2024

stefannica Jun 6, 2024

github-actions bot commented Jun 6, 2024

github-actions bot commented Jun 6, 2024

github-actions bot commented Jun 6, 2024

Server scalability improvements #2752

Server scalability improvements #2752

Conversation

stefannica commented Jun 5, 2024 • edited Loading

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Jun 5, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

strickvl commented Jun 6, 2024

wjayesh left a comment

Choose a reason for hiding this comment

wjayesh Jun 6, 2024

Choose a reason for hiding this comment

stefannica Jun 6, 2024

Choose a reason for hiding this comment

wjayesh Jun 6, 2024

Choose a reason for hiding this comment

wjayesh Jun 6, 2024

Choose a reason for hiding this comment

stefannica Jun 6, 2024

Choose a reason for hiding this comment

schustmi Jun 6, 2024

Choose a reason for hiding this comment

stefannica Jun 6, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 6, 2024

github-actions bot commented Jun 6, 2024

github-actions bot commented Jun 6, 2024

stefannica commented Jun 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)