Oximeter types probably shouldn't be in the Dendrite API
Maintainers usually reply within 5 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
Research direction
Start by tracing the unpublished oximeter_collect_meta_endpoint() and the Oximeter types, such as OximeterMetadata, into the dpd OpenAPI document. Review the context from issues #357 and #358, then confirm that removing this API exposure permits the oximeter configuration data to move to a shared crate with producer-specific methods. Done means the internal Oximeter types no longer appear in the Dendrite API.
Written by the indexing model from the issue text.
Description
While resolving #357, we found that some of the Oximeter types, e.g., OximeterMetadata appear in the dpd OpenAPI document. That's because they are returned by the (unpublished) oximeter_collect_meta_endpoint() API endpoint. They probably shouldn't be. The type here is entirely internal to Dendrite, and even for debugging purposes, the data it exposes is almost never relevant and can be retrieved through other means (SMF, pfiles, omdb, etc.).
If we remove this, then we can follow @jgallagher's good suggestion on #358, and move the oximeter configuration data to a shared crate, and then have specific methods for the tfportd or dpd producer IDs, or whatever new ones are added.
- Dominant language
- Rust
- Stars
- 20
- Forks
- 3
- Avg merge
- 8h 29m
- Merged PRs (30d)
- 2
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
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.
More from oxidecomputer/dendrite
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oxidecomputer/dendrite#380 ·
Maintainers usually reply within 5 days
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
oxidecomputer/dendrite#375 ·
Maintainers usually reply within 5 days
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
oxidecomputer/dendrite#369 ·
Maintainers usually reply within 5 days
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
oxidecomputer/dendrite#368 ·
Maintainers usually reply within 5 days
-
One build multiple ASICsPossibly taken @cfzimmerman claimed this 23 days ago. Open
oxidecomputer/dendrite#355 · 1 comment · 1 reaction · 1 assignee ·
Maintainers usually reply within 5 days
All issues in oxidecomputer/dendrite
Similar issues
-
area:casework bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
registrystack/registry-stack#1623 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
leptos-rs/leptos#4885 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
longbridge/gpui-kit#3276 ·
Maintainers usually reply within 1 day
-
A-Migration Guides D-Straightforward S-Ready-For-Implementation X-Uncontroversial
Difficulty 1/5 Under an hour Newbie friendliness 88/100
bevyengine/bevy-website#2607 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day