opensafely-core / codespaces-initiative

Improving the use of OpenSAFELY in Codespaces
MIT License
0 stars 0 forks source link

ADR: Codespaces metrics/telemetry #70

Closed Jongmassey closed 2 weeks ago

Jongmassey commented 3 weeks ago

Write an ADR in this format to record that we're gathering basic metrics on usage of metrics and what the consequences of that decision are.

[!NOTE] Please read Michael Nygard's blog post about how to document an architecture decision first.

Rough Decision

We've decided to record what codespaces are extant in the opensafely github organisation at 9am every day using the existing metrics framework. We're not gathering any further data on how the codespaces that exist are being used. We are not explicitly and publicly stating that we gather this information, we do not expect users to be surprised by this.

Rough Consequences

The once a day call to the github api for the opensafely org will miss some codespaces that are short-lived (and are created after 9am), or are attached to repos in different organisations. We know only that codespaces exist, not exactly what they are being used for.