Oximeter types probably shouldn't be in the Dendrite API

未关闭
#359 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
52/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
rust
领域
api, backend

调研方向

首先,将未发布的 oximeter_collect_meta_endpoint() 和 Oximeter 类型(例如 OximeterMetadata)追踪到 dpd OpenAPI 文档中。查看 issues #357 和 #358 的上下文,然后确认移除这一 API 暴露后,可以将 oximeter 配置数据移动到包含 producer 特定方法的共享 crate 中。完成标准是内部 Oximeter 类型不再出现在 Dendrite API 中。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Rust
星标
22
派生
4
平均合并
4 天 20 小时
30 天内合并 PR
6

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

oxidecomputer/dendrite 的其他 Issue

查看 oxidecomputer/dendrite 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。