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

Metrics API: show number of user accounts #10260

Conversation

stevenferey
Copy link
Contributor

What this PR does / why we need it:

Closes issue #10177 following the pattern of existing metrics APIs:

http://$SERVER/api/info/metrics/$TYPE
http://$SERVER/api/info/metrics/$TYPE/pastDays/$DAYS
http://$SERVER/api/info/metrics/$TYPE/toMonth/$AAAA-MM
http://$SERVER/api/info/metrics/$TYPE/monthly

Which issue(s) this PR closes:

Closes #10177

Suggestions on how to test this:

curl -X GET -H 'Accept:application/json' http://$SERVER/api/info/metrics/accounts
curl -X GET -H 'Accept:application/json' http://$SERVER/api/info/metrics/accounts/pastDays/$DAYS
curl -X GET -H 'Accept:application/json' http://$SERVER/api/info/metrics/accounts/toMonth/$AAAA-MM
curl -X GET -H 'Accept:application/json' http://$SERVER/api/info/metrics/accounts/monthly
curl -X GET -H 'Accept:text/csv' http://$SERVER/api/info/metrics/accounts/monthly

Is there a release notes update needed for this change?:

Yes, the change is proposed with this file in PR:
doc/release-notes/10117-api-metrics-add-user-accounts-number.md

@pdurbin pdurbin added Feature: Metrics + Reports Size: 3 A percentage of a sprint. 2.1 hours. labels Jan 27, 2024
@pdurbin
Copy link
Member

pdurbin commented Jan 27, 2024

I'm excited to see this! Thanks, @stevenferey!

@coveralls
Copy link

Coverage Status

coverage: 20.254% (-0.01%) from 20.267%
when pulling d9625c6 on Recherche-Data-Gouv:10177-api-metrics-add-user-accounts-number
into ba730cf on IQSS:develop.

Copy link
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. W.r.t. QA testing, it would be good to verify that the total accounts is correct and that all the endpoints work. Without installing on a long-running instance, it will be hard to check the time series, but the queries all follow the example from other endpoints.

@stevenwinship stevenwinship self-assigned this Mar 1, 2024
@stevenwinship stevenwinship merged commit 891e421 into IQSS:develop Mar 1, 2024
12 checks passed
@stevenwinship stevenwinship removed their assignment Mar 1, 2024
@pdurbin pdurbin added this to the 6.2 milestone Mar 1, 2024
@pdurbin pdurbin changed the title 10177 api metrics add user accounts number Metrics API: show number of user accounts Aug 7, 2024
@luddaniel luddaniel deleted the 10177-api-metrics-add-user-accounts-number branch September 19, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Metrics + Reports Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: 🚀 Done (Recherche Data Gouv)
Development

Successfully merging this pull request may close these issues.

API Metrics : add user accounts number
6 participants