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

[Errors] Provide clear messages about Elasticsearch status when running the server #1023

Closed
dvsrepo opened this issue Jan 24, 2022 · 1 comment · Fixed by #1030
Closed

[Errors] Provide clear messages about Elasticsearch status when running the server #1023

dvsrepo opened this issue Jan 24, 2022 · 1 comment · Fixed by #1030
Assignees
Labels
area: server Indicates that an issue or pull request is related to the server
Projects

Comments

@dvsrepo
Copy link
Member

dvsrepo commented Jan 24, 2022

I don't know where is the best place but I would like to have a very clear message when some starts the server and the Elasticsearch endpoint is not available/running, etc, I don't know if we check that at some point but I recall the message it's a standard trace. We should be very informative at this point, explaining:

We checked the elastic search endpoint at {ES_URL} and is not responding/available..
Please make sure your Elasticsearch is running, or (check the user roles config) <- whatever message it makes sense.
Ideally this should be applicable to other scenarios when the ES instance is not responding --> including a trace in the server process.

I think this is key to help our users troubleshoot the issues with Elastic which is frequently the only bottleneck for getting started.

@dvsrepo dvsrepo added the area: server Indicates that an issue or pull request is related to the server label Jan 24, 2022
@dvsrepo dvsrepo added this to Backlog in Release via automation Jan 24, 2022
@frascuchon frascuchon moved this from Backlog to Planified in Release Jan 24, 2022
@frascuchon frascuchon moved this from Planified to In progress in Release Jan 24, 2022
@frascuchon
Copy link
Member

We must keep in mind that this kind of info about error should be available ONLY at server startup. Returning detailed info about elasticsearch status or error details could compromise the infrastructure security and is not recommended at all

@frascuchon frascuchon changed the title [Server] Provide clear messages about Elasticsearch status when running the server [Errors] Provide clear messages about Elasticsearch status when running the server Jan 25, 2022
Release automation moved this from In progress to Done Jan 26, 2022
frascuchon added a commit that referenced this issue Jan 26, 2022
#1030)

* fix(#1023): handle elasticsearch connection problems on server startup

* Apply suggestions from code review

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* Update src/rubrix/server/server.py

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* fix message

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>
@frascuchon frascuchon moved this from Done to Release Ready in Release Jan 31, 2022
frascuchon added a commit that referenced this issue Jan 31, 2022
#1030)

* fix: handle elasticsearch connection problems on server startup

* Apply suggestions from code review

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* Update src/rubrix/server/server.py

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* fix message

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

(cherry picked from commit dd8aefc)
@frascuchon frascuchon moved this from Release Ready to Closed in Release Jan 31, 2022
frascuchon added a commit that referenced this issue Jan 31, 2022
#1030)

* fix: handle elasticsearch connection problems on server startup

* Apply suggestions from code review

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* Update src/rubrix/server/server.py

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* fix message

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

(cherry picked from commit dd8aefc)
frascuchon added a commit that referenced this issue Jan 31, 2022
#1030)

* fix: handle elasticsearch connection problems on server startup

* Apply suggestions from code review

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* Update src/rubrix/server/server.py

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

* fix message

Co-authored-by: Daniel Vila Suero <daniel@recogn.ai>

(cherry picked from commit dd8aefc)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: server Indicates that an issue or pull request is related to the server
Projects
No open projects
Release
Approved Release QA
Development

Successfully merging a pull request may close this issue.

3 participants