oxidecomputer / oxidecomputer/progenitor

Document how to create a client with tracing

Open
#870 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1k
Forks
136
Avg merge
8h 36m
Merged PRs (30d)
14

Description

Given the decision not to support reqwest middleware it would be beneficial to show how to build a client with tracing (or any other customization) using the pre and post hooks.

Taking tracing as an example, the reqwest-tracing middleware wraps a new tracing Span around each outgoing request including various OpenTelemetry defined fields and propagates trace context to the server via request headers.

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 reading the pre and post hooks and the decision in pull request #252, then compare the reqwest-tracing example linked in the issue. Document how to create a client with tracing or another customization through those hooks, including the request tracing and context propagation behavior described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, observability
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.