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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

As an API user, I want to know how long a request took to complete #463

Closed
jordanpadams opened this issue Aug 11, 2021 · 3 comments
Closed
Assignees
Labels
B12.0 p.should-have requirement the current issue is a requirement

Comments

@jordanpadams
Copy link
Member

jordanpadams commented Aug 11, 2021

馃挭 Motivation

...so that I can use this for metrics purposes and/or for a better understanding of how to improve my access to the API from a client.

馃摉 Additional Details

鈿栵笍 Acceptance Criteria

Given a running API and registry with data ingested
When I perform a query to the API
Then I expect the response to include a took field with the amount of time it takes for the query to be pushed to the registry, parsed by the API service, and then tagged with with the time right before the response is returned by the API service

鈿欙笍 Engineering Details

Similar to ESDIS CMR response, something like:

{
  "hits" : 2,
  "took" : 11,
  "items" : [ {
...

seems like this is tightly coupled with NASA-PDS/pds-api#68 so figured I would add to this sprint as well

@al-niessner
Copy link
Contributor

Waiting for NASA-PDS/pds-api#87

@al-niessner
Copy link
Contributor

@jordanpadams @tloubrieu-jpl

"took" is in what units? If seconds, then float? It is currently number of milliseconds, since most requests are less than a second, and documented as such but could look strange if the did-not-read-the-manual assumption is seconds.

@jordanpadams
Copy link
Member Author

resolved per NASA-PDS/pds-api#87 and NASA-PDS/pds-api@7fe91eb

@jordanpadams jordanpadams transferred this issue from NASA-PDS/pds-api May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B12.0 p.should-have requirement the current issue is a requirement
Projects
None yet
Development

No branches or pull requests

2 participants