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

/health endpoint for K8 Liveness and Readiness probes #3855

Merged
merged 13 commits into from
Sep 4, 2024
Merged

/health endpoint for K8 Liveness and Readiness probes #3855

merged 13 commits into from
Sep 4, 2024

Conversation

samarth9201
Copy link
Contributor

@samarth9201 samarth9201 commented Aug 28, 2024 •
edited
Loading

All Submissions:

  • Have you followed the guidelines stated in CONTRIBUTING.md file?
  • Have you checked to ensure there aren't any other open Pull Requests for the desired changed?

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

New Feature Submission:

  • Does your submission pass the tests?
  • Have you linted your code locally prior to submission?

Changes To Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Created a '/health' endpoint which must be added as reserved API Route. The /health endpoint checks the connectivity to Database and Redis. If either service is unavailable or unhealthy, the endpoint returns a 503 HTTP status, and 200 HTTP status if everything is alright (Ref : Configure Liveness, Readiness and Startup Probes). Checking more services can be added to this if required.

Approach

  1. Created the /health endpoint asynchronous function that checks the status of database and Redis connections. It initializes a health status dictionary with default values indicating that both services are healthy.
  2. For Database, it attempts to connect to the database and execute a simple query (SELECT 1). If the connection fails or an error is raised, the health status for the database is updated to reflect the failure.
  3. For Redis, it tries to ping the Redis server. If the ping fails, the health status for Redis is updated to indicate a failure.
  4. The endpoint returns a JSON response containing the health status of both services along with an appropriate HTTP status code (200 for healthy, 503 for unhealthy).

closes #3506

masenf
masenf reviewed Aug 29, 2024
View reviewed changes
Copy link
Collaborator

@masenf masenf left a comment

Choose a reason for hiding this comment

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

mostly looks good, really like the tests. a couple of feedbacks

reflex/app.py Outdated Show resolved Hide resolved
reflex/app.py Outdated Show resolved Hide resolved
reflex/utils/prerequisites.py Outdated Show resolved Hide resolved
reflex/constants/event.py Outdated Show resolved Hide resolved
masenf
masenf reviewed Aug 29, 2024
View reviewed changes
reflex/constants/event.py Outdated Show resolved Hide resolved
benedikt-bartscher
benedikt-bartscher approved these changes Aug 29, 2024
View reviewed changes
Copy link
Contributor

@benedikt-bartscher benedikt-bartscher left a comment

Choose a reason for hiding this comment

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

Thank you, @samarth9201, LGTM!
We could make get_redis_status and get_db_status async and run them at the same time to slightly improve performance

reflex/model.py Outdated Show resolved Hide resolved
@samarth9201
Copy link
Contributor Author

Hi @masenf, could you please review the changes and approve the PR if everything looks good? Thank you!

masenf
masenf approved these changes Sep 4, 2024
View reviewed changes
Copy link
Collaborator

@masenf masenf left a comment

Choose a reason for hiding this comment

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

awesome thanks for your contribution and patience 🙏

@masenf masenf merged commit 5904730 into reflex-dev:main Sep 4, 2024
46 checks passed
adhami3310 pushed a commit that referenced this pull request Sep 9, 2024
@samarth9201 @adhami3310
/health endpoint for K8 Liveness and Readiness probes (#3855)
993c5e2 
* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions
adhami3310 pushed a commit that referenced this pull request Sep 9, 2024
@samarth9201 @adhami3310
/health endpoint for K8 Liveness and Readiness probes (#3855)
2dc0fd1 
* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions
adhami3310 pushed a commit that referenced this pull request Sep 9, 2024
@samarth9201 @adhami3310
/health endpoint for K8 Liveness and Readiness probes (#3855)
8d622ae 
* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions
adhami3310 pushed a commit that referenced this pull request Sep 9, 2024
@samarth9201 @adhami3310
/health endpoint for K8 Liveness and Readiness probes (#3855)
94064a6 
* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions
adhami3310 added a commit that referenced this pull request Sep 10, 2024
@adhami3310 @samarth9201
@ElijahAhianyo @masenf @benedikt-bartscher @VishDev12 @abulvenz
Use old serializer system in LiteralVar (#3875)
a5c73ad 
* use serializer system

* add checks for unsupported operands

* and and or are now supported

* format

* remove unnecessary call to JSON

* put base before rest

* fix failing testcase

* add hinting to get static analysis to complain

* damn

* big changes

* get typeguard from extensions

* please darglint

* dangit darglint

* remove one from vars

* add without data and use it in plotly

* DARGLINT

* change format for special props

* add pyi

* delete instances of Var.create

* modify client state to work

* fixed so much

* remove every Var.create

* delete all basevar stuff

* checkpoint

* fix pyi

* get older python to work

* dangit darglint

* add simple fix to last failing testcase

* remove var name unwrapped and put client state on immutable var

* fix older python

* fox event issues

* change forms pyi

* make test less strict

* use rx state directly

* add typeignore to page_id

* implement foreach

* delete .web states folder silly

* update reflex chakra

* fix issue when on mount or on unmount is not set

* nuke Var

* run pyi

* import immutablevar in critical location

* delete unwrap vars

* bring back array ref

* fix style props in app

* /health endpoint for K8 Liveness and Readiness probes (#3855)

* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions

* Update find_replace (#3886)

* [REF-3592]Promote `rx.progress` from radix themes (#3878)

* Promote `rx.progress` from radix themes

* fix pyi

* add warning when accessing `rx._x.progress`

* Use correct flexgen backend URL (#3891)

* Remove demo template (#3888)

* gitignore .web (#3885)

* update overflowY in AUTO_HEIGHT_JS from hidden to scroll (#3882)

* Retain mutability inside `async with self` block (#3884)

When emitting a state update, restore `_self_mutable` to the value it had
previously so that `yield` in the middle of `async with self` does not result
in an immutable StateProxy.

Fix #3869

* Include child imports in markdown component_map (#3883)

If a component in the markdown component_map contains children components, use
`_get_all_imports` to recursively enumerate them.

Fix #3880

* [REF-3570] Remove deprecated REDIS_URL syntax (#3892)

* mixin computed vars should only be applied to highest level state (#3833)

* improve state hierarchy validation, drop old testing special case (#3894)

* fix var dependency dicts (#3842)

* Adding array to array pluck operation. (#3868)

* fix initial state without cv fallback (#3670)

* add fragment to foreach (#3877)

* Update docker-example (#3324)

* /health endpoint for K8 Liveness and Readiness probes (#3855)

* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions

* /health endpoint for K8 Liveness and Readiness probes (#3855)

* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions

* Merge branch 'main' into use-old-serializer-in-literalvar

* [REF-3570] Remove deprecated REDIS_URL syntax (#3892)

* /health endpoint for K8 Liveness and Readiness probes (#3855)

* Added API Endpoint

* Added API Endpoint

* Added Unit Tests

* Added Unit Tests

* main

* Apply suggestions from Code Review

* Fix Ruff Formatting

* Update Socket Events

* Async Functions

* [REF-3570] Remove deprecated REDIS_URL syntax (#3892)

* remove extra var

Co-authored-by: Masen Furer <m_github@0x26.net>

* resolve typo

* write better doc for var.create

* return var value when we know it's literal var

* fix unit test

* less bloat for ToOperations

* simplify ImmutableComputedVar.__get__ (#3902)

* simplify ImmutableComputedVar.__get__

* ruff it

---------

Co-authored-by: Samarth Bhadane <samarthbhadane119@gmail.com>
Co-authored-by: Elijah Ahianyo <elijahahianyo@gmail.com>
Co-authored-by: Masen Furer <m_github@0x26.net>
Co-authored-by: benedikt-bartscher <31854409+benedikt-bartscher@users.noreply.github.com>
Co-authored-by: Vishnu Deva <vishnu.deva12@gmail.com>
Co-authored-by: abulvenz <a.eismann@senbax.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benedikt-bartscher benedikt-bartscher benedikt-bartscher approved these changes

@masenf masenf masenf approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[REF-3134] K8 Liveness and Readiness probes
3 participants
@samarth9201 @masenf @benedikt-bartscher