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

healthcheck: report API key status #162

Open
josephjclark opened this issue Jan 28, 2025 · 1 comment · May be fixed by #171
Open

healthcheck: report API key status #162

josephjclark opened this issue Jan 28, 2025 · 1 comment · May be fixed by #171

Comments

@josephjclark
Copy link
Collaborator

josephjclark commented Jan 28, 2025

When we call the healthcheck endpoint, we should report on the status of API keys. Whether they've been set and whether they're responding

We need a function that, on server start, calls some simple diagnostic API on any relevant services (at the time of writing it would be pinecone and openai). We need to find some simple no-op endpoint we can call just to validate the authentication

We should log the result on startup, maybe on the index page, and at the healthcheck endpoint

@josephjclark
Copy link
Collaborator Author

On reflection I don't think this can go on the healthcheck because it'll be slow to run. And we want healthcheck to be fast.

So we add a /status endpoint. When that page is loaded, we'll call out to each connected service and just "ping" it somehow to make sure it works

I think right now it's just pinecone and openai that the server natively supports. So we need to work out a cheap test from both systems.

The status page should return some simple HTML or just JSON data showing the status of each key. I suppose HTML by default but it should support a header of Accept: application/json.

@hanna-paasivirta hanna-paasivirta linked a pull request Feb 14, 2025 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant