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 摘要。