Status codes - Githubissues

sensein / etelemetry-client

Etelemetry client

Other

3 stars 9 forks source link

Status codes #31

Closed effigies closed 10 months ago

effigies commented 3 years ago

While "I'm using this!" is a nice flag for libraries, one feature that would make this more useful for end-user tools would be to be able to have the following statuses:

STARTED
SUCCESS
FAILURE

I would imagine the API roughly as:

import etelemetry

run_uuid = etelemetry.check_available_version("my/project", "1.0.0", status="START")

...

etelemetry.update_status(run_uuid, status="FAILURE" if exit_code else "SUCCESS")
sys.exit(exit_code)

WDYT?

oesteban commented 3 years ago

This would be very helpful.

Additional suggestions:

Introduce a concept of user (to have a notion of "new" and "returning" users)
Introduce a concept of session (have also some session_uuid that clients can set the way they consider useful). For instance, in the case of fMRIPrep I would consider "same-session" all the participants associated to the same input dataset by the same user.

I'm not sure of how rigorous these things can be done from a technical perspective (I know, e.g., on the web it took some time until browsers provided standard UserAgent information) and that tracking sessions heavily relied on cookies...

effigies commented 10 months ago

I think the solution is migas, not continuing to develop ET.

yarikoptic commented 10 months ago

oh, nice, didn't know that an alternative was born... by the same ppl... odd. Convenience link: https://github.com/nipreps/migas-server https://github.com/nipreps/migas-py