metric: Recommend defining units in UCUM (open-telemetry#4418)

* metric: Recommend defining units in UCUM * Update metric/instrument.go Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> --------- Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
JPFrancoia · Aug 8, 2023 · b8e8e5e · b8e8e5e
1 parent 10099bb
commit b8e8e5e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/metric/instrument.go b/metric/instrument.go
@@ -167,6 +167,8 @@ func (o unitOpt) applyInt64ObservableGauge(c Int64ObservableGaugeConfig) Int64Ob
 }
 
 // WithUnit sets the instrument unit.
+//
+// The unit u should be defined using the appropriate [UCUM](https://ucum.org) case-sensitive code.
 func WithUnit(u string) InstrumentOption { return unitOpt(u) }
 
 // AddOption applies options to an addition measurement. See