Skip to content

Add "inspection" mode to client libraries #1321

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

Closed
melange396 opened this issue Oct 23, 2023 · 0 comments · Fixed by #1418
Closed

Add "inspection" mode to client libraries #1321

melange396 opened this issue Oct 23, 2023 · 0 comments · Fixed by #1418
Assignees
Labels
good first issue help wanted js client changes the JavaScript client logs and monitoring logging, monitoring, alerting python client changes the Python client r client changes the R client

Comments

@melange396
Copy link
Collaborator

Add an inspection mode (like a debug mode) to client libraries so we can "see" (and/or log) what exact http[s] requests are made during its operation.

This can help identify redundant/repeated requests, or shed light on which might be taking unexpected amounts of time to return. It can also elucidate behaviors in the covidcast client, where a single method call may be decomposed into multiple http requests.

A simple implementation of this could just print info for each request as it is made (URL, method, headers, response time, response bytes/rows, etc). An additional deeper feature could print this info, BUT return empty/dummy data and not actually make the request. The latter could be useful for testing long-running or expensive data retrieval scripts without making the user wait for results or putting load on the server (obviously, this may not be very useful in instances when later query parameters are dependent on earlier query results).

@melange396 melange396 added help wanted good first issue r client changes the R client python client changes the Python client js client changes the JavaScript client logs and monitoring logging, monitoring, alerting labels Oct 23, 2023
@rzats rzats self-assigned this Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted js client changes the JavaScript client logs and monitoring logging, monitoring, alerting python client changes the Python client r client changes the R client
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants