opensafely-core / opensafely-core/opensafely-cli
Tag local telemetry with repo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 5
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 4
Description
If we start collecting telemetry when users run jobs, it will be easier to analyse the data if we can group it in some way. Grouping by user or project would be great, but that information isn't easily available for local jobs.
One simpler option is to tag the telemetry with the repo. Not all local jobs will belong to a repo (since the user can run the OS CLI from any folder - it may not be version-controlled at all), but we think that most of the time they will be running in a directory with a git remote. We could adapt the code which used to check dataset permissions in the CLI, since it also tried to infer the repo name.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the telemetry work described in issue 369 and the former dataset-permission checking code referenced in issue 348. Determine how to infer a Git remote for the current directory, then verify that local telemetry includes the repository when available and still works for jobs outside a repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- cli, observability-sre
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100