This repository has been archived by the owner on Jun 14, 2024. It is now read-only.
feat: migrate /api/_status endpoint to /api/v1/status
#165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frascuchon
reviewed
May 10, 2024
| async def get_status(): | ||
| return Status( | ||
| version=info.argilla_version(), | ||
| elasticsearch=info.elasticsearch_status(), |
There was a problem hiding this comment.
We could change this to search_engine since in the code we have a lot of references to the search engine (which internally is an elasticsearch/openseach instance
There was a problem hiding this comment.
Also, I think using the SearchEngine for this would be better.
Suggested change
| elasticsearch=info.elasticsearch_status(), | |
| elasticsearch=info.engine_status(search_engine), |
And internally:
def engine_status(search_engine):
return search_engine.client.get_cluster_info() # In the future we can wrap this as a public interface method (.status) or something. There was a problem hiding this comment.
Ok to both suggestions. I will change them.
frascuchon
reviewed
May 10, 2024
src/argilla_server/contexts/info.py
Outdated
Comment on lines
27
to
28
| def elasticsearch_status() -> dict: | ||
| return GenericElasticEngineBackend.get_instance().client.get_cluster_info() |
There was a problem hiding this comment.
Just to not reuse old code:
Suggested change
| def elasticsearch_status() -> dict: | |
| return GenericElasticEngineBackend.get_instance().client.get_cluster_info() | |
| def elasticsearch_status(search_engine: SearchEngine) -> dict: | |
| return search_engine.client.get_cluster_info() |
frascuchon
approved these changes
May 13, 2024
Base automatically changed from
feat/migrate-info-v0-endpoint-to-version-v1
to
feat/move-api-v0-functionality-to-v1
May 13, 2024 11:39
…-status-v0-endpoint-to-v1
jfcalvo
merged commit 630ca2c
into
feat/move-api-v0-functionality-to-v1
12 checks passed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR add changes to migrate
/api/_statusendpoint to/api/v1/statusendpoint.The changes added in this PR compared to the endpoint from API v0:
mem_infoattribute name we are using nowmemory.infocontext with three functions that returns the Argilla version, ElasticSearch and Memory status. (Once we delete old endpoints we can remove the service code).Closes #164
Type of change
(Please delete options that are not relevant. Remember to title the PR according to the type of change)
How Has This Been Tested
(Please describe the tests that you ran to verify your changes. And ideally, reference
tests)Checklist