Write reporting code? - Githubissues

ehmatthes / heroku-buildpack-python

A demonstration version of the official Heroku buildpack for Python apps, showing how Django deployment can be further simplified.

https://ehmatthes.com/blog/simplified_heroku/

MIT License

16 stars 2 forks source link

Write reporting code? #17

Closed ehmatthes closed 2 years ago

ehmatthes commented 3 years ago

Currently, I have no real idea how many times this deployment process has been used. I do not want to track individual users or projects. I would like a simple count of how many times this has been used.

Make a simple request to a server and log requests?
- The request carries no information.
- Document this clearly, so there are no surprises. Include in output that this counter was incremented.
- Offer a DISABLE_AUTOCONFIGURE_REPORTING env var that turns this feature off.

ehmatthes commented 3 years ago

Initial thinking was that this would be useful information to help convince Heroku to adopt an approach similar to this. But they can scan projects and count how many projects have been set to use this buildpack. So the only real reason to do this would be for my own information. That's still a really valuable piece of information as far as knowing if this project is meaningful or not.

ehmatthes commented 2 years ago

Does the GH project traffic show use?
- Re-pushing a project already set to use this does not bump any traffic numbers.
- Pushing a new project with this buildpack doesn't immediately bump any traffic numbers.
- Cloning via command line also doesn't immediately bump traffic numbers.
- Does an api call on this repo show different clone stats than the traffic page?
  - API delays event statistics by 5 minutes; traffic page may do the same.
  - Need to authenticate, and then make this api call: https://api.github.com/repos/ehmatthes/heroku-buildpack-python/traffic/clones
  - curl username:access_token https://api.github.com/repos/ehmatthes/heroku-buildpack-python/traffic/clones works
  - Also curl -u username:access_token https://api.github.com/repos/ehmatthes/heroku-buildpack-python/traffic/popular/paths
I don't think traffic will give an indication of how many times the buildpack has been used.

ehmatthes commented 2 years ago

Could I make a dummy page in this repository, and "visit" that page through a curl call? That might show up in traffic, and would be specific enough to get some sense of usage.

ehmatthes commented 2 years ago

I believe each deployment shows up as a clone. I cloned manually twice on Friday, and deployed test projects a number of times. There are 7 clones listed for Friday.

This is limited to the last 14 days, but that's plenty to see if the project is being used beyond test cases.