oxidecomputer / oxidecomputer/dropshot

Support naming Tokio tasks

Open
#853 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
104
Avg merge
1d 19h
Merged PRs (30d)
22

Description

Tokio has a task::Builder interface which lets you give tasks names. It's useful for identifying tasks in the Tokio console.

This API is only available on "tokio_unstable" Rust flag, and tokio crate feature tracing. So Dropshot would need to check for the "tokio_unstable" in RUSTFLAGS and conditionally enable the tracing tokio feature.

This builder API is open to change (obviously, given the "tokio_unstable" name). So maybe y'all aren't open to supporting this feature right now. But it would be a nice feature for people using tokio console.

Engineers at KittyCAD are open to doing the implementation of this, but just opening this issue to discuss if y'all are open to the idea :)

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 by reviewing Tokio's task::Builder API and how Dropshot currently configures the Tokio crate features and RUSTFLAGS. Done means task naming works when tokio_unstable and tracing are enabled, with names visible in the Tokio console, while preserving the existing configuration otherwise.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.