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.

Sign up for GitHub

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

Jump to bottom

Improve services logging and status #2436

Merged
merged 11 commits into from
Feb 21, 2024
Merged

Improve services logging and status #2436

merged 11 commits into from
Feb 21, 2024

Conversation

safoinme
Copy link
Contributor

@safoinme safoinme commented Feb 11, 2024 •
edited by coderabbitai bot
Loading

Describe changes

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)

Summary by CodeRabbit

  • New Features
    • Enhanced service management with automatic status updates and improved exception handling for starting and stopping services.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2024 •
edited
Loading

Important

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

Walkthrough

The recent modifications introduce a decorator to manage service status transitions efficiently, incorporating exception handling for robust operation. This enhancement primarily targets the start and stop methods, ensuring that service statuses are accurately managed before and after these operations, thereby improving the reliability and maintainability of the service management process.

Changes

File Path Change Summary
src/zenml/.../service.py Introduced update_service_status decorator for managing service statuses and added exception handling in update_status. Decorated start and stop methods for automated status management.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Feb 11, 2024
@safoinme safoinme changed the title Pre cleaning deployers improve services logging and status Feb 13, 2024
@safoinme safoinme marked this pull request as ready for review February 13, 2024 08:17
@github-actions GitHub Actions
Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

@safoinme
Copy link
Contributor Author

@coderabbitai review

coderabbitai[bot]
coderabbitai bot reviewed Feb 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 5c785c1 and ac2c751.
Files selected for processing (1)
  • src/zenml/services/service.py (5 hunks)
Additional comments: 2
src/zenml/services/service.py (2)
  • 288-309: The exception handling in the update_status method is correctly implemented, ensuring that any errors during status checks are logged and the service status is updated accordingly. This enhances the robustness of the service status management.
  • 436-439: The application of the update_service_status decorator on the start method with appropriate pre_status and post_status values effectively manages the service status transitions during the start process.

src/zenml/services/service.py Outdated Show resolved Hide resolved
src/zenml/services/service.py Show resolved Hide resolved
@strickvl strickvl changed the title improve services logging and status Improve services logging and status Feb 13, 2024
strickvl
strickvl approved these changes Feb 13, 2024
View reviewed changes
Copy link
Contributor

@strickvl strickvl left a comment

Choose a reason for hiding this comment

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

LGTM. Please update the description of this ticket with something for whoever is making the next release.

bcdurak
bcdurak approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@bcdurak bcdurak left a comment

Choose a reason for hiding this comment

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

Left a few minor comments. Otherwise LGTM.

src/zenml/services/service.py Show resolved Hide resolved
src/zenml/services/service.py

if self.endpoint:
self.endpoint.update_status()
if self.endpoint:
Copy link
Contributor

Choose a reason for hiding this comment

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

Just out of curiosity, if the status of the service is inactive, should we also update the status of the endpoint as well? The same goes for the except block.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think for the current service implementation we don't do that since we don't look for service endpoint directly. but with the new update services we might wanna do that

@avishniakov
Copy link
Contributor

@safoinme , based on what I see in the error log of the E2E template check - you need to update from develop. This is an issue with the s3fs version, yesterday Baris reported the same.

@safoinme safoinme merged commit 6aab39a into develop Feb 21, 2024
55 checks passed
@safoinme safoinme deleted the feature/OSSK-390-pre-cleaning-deployers branch February 21, 2024 12:02
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
@safoinme @actions-user
@strickvl @adtygan
Improve services logging and status (zenml-io#2436)
2060067 
* update service error catching

* Update service status decorator

* Refactor status update logic in BaseService

* Auto-update of Starter template

* Add logging statements to service.py

* Fix typo in update_status method

---------

Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@strickvl strickvl strickvl approved these changes

@bcdurak bcdurak bcdurak approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request internal To filter out internal PRs and issues run-slow-ci
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@safoinme @avishniakov @strickvl @bcdurak @actions-user