opensafely-core / opensafely-core/opensafely-cli

Group jobs from same job request in telemetry

Open
#383 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2
Forks
5
Avg merge
2d 1h
Merged PRs (30d)
4

Description

The telemetry in the CLI was designed for job-runner, where we're mostly interested in the performance of a single job. But when looking at the telemetry for the CLI, it would also be useful to see the duration of an entire job request, because that gives a better picture of the user experience.

We could do this by creating a span for the whole opensafely run command, which is the parent of each individual job span.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the CLI implementation of the opensafely run command and locate the existing instrumentation for individual job spans. Add coverage for the whole job request, ensuring it is represented as the parent span of each job span, then verify the resulting telemetry shows the complete request duration.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, observability-sre
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.