README Examples error

未关闭 适合新手
#257 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
76/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

从 repository README 中的 Metrics 示例开始。issue 指出该示例在 instrument 名称中使用了空格。阅读 issue 中链接的 OpenTelemetry instrument 名称语法,然后更新示例,使其使用有效名称。当 README 不再显示无效的 instrument 名称时,任务即完成。让 MATLAB 抛出错误的建议是另一项范围更大的改动。

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

描述

The Metrics example in the repo's readme shows the creation of a counter as follows

m = opentelemetry.metrics.getMeter("My Meter");
c = m.createCounter("My Counter");

When run in Matlab the following error is received.

c = m.createCounter("My Counter");
[Error] File: *\meter.cc:158 Meter::CreateDoubleCounter - failed. Invalid parameters.My Counter . Measurements won't be recorded.

It appears a no-op counter instead of throwing an error.

Per https://opentelemetry.io/docs/specs/otel/metrics/api/?utm_source=kapa#instrument-name-syntax Metric Instrument Names should not contain spaces. The readme should be updated to reflect that, it may also be worthwhile to have matlab throw an error and not create this no-op counter if a name is invalid.

主要语言
MATLAB
星标
19
派生
5
平均合并
1 分钟
30 天内合并 PR
2

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

mathworks/OpenTelemetry-MATLAB 的其他 Issue

查看 mathworks/OpenTelemetry-MATLAB 的全部 Issue

相似的 Issue

更多 MATLAB Issue

把新 issue 发到你的邮箱

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