fix(api): deprecate MetricAttributes and MetricAttributeValue (#3406)

* docs: fix comment in metrics api refering to span * fix(api): deprecate MetricsAttributes and MetricAttributeValue * fix: typo in changelog Co-authored-by: Daniel Dyla <[email protected]>
open-telemetry · Nov 16, 2022 · e133f3f · e133f3f
1 parent bd56547
commit e133f3f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 8 deletions.
diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+* fix(api): deprecate MetricAttributes and MetricAttributeValue [#3406](https:/open-telemetry/opentelemetry-js/pull/3406) @blumamir
 * test(api): disable module concatenation in tree-shaking test [#3409](https:/open-telemetry/opentelemetry-js/pull/3409) @legendecas
 
 ## [1.3.0](https://github.com/open-telemetry/opentelemetry-js-api/compare/v1.2.0...v1.3.0)

diff --git a/api/src/metrics/Metric.ts b/api/src/metrics/Metric.ts
@@ -83,19 +83,13 @@ export interface Histogram<AttributesTypes extends MetricAttributes = MetricAttr
  record(value: number, attributes?: AttributesTypes, context?: Context): void;
 }
 
-// api.SpanAttributes instead of api.Attributes is used here for api package backward compatibility.
 /**
- * Attributes is a map from string to attribute values.
- *
- * Note: only the own enumerable keys are counted as valid attribute keys.
+ * @deprecated please use {@link Attributes}
  */
 export type MetricAttributes = Attributes;
 
-// api.SpanAttributeValue instead of api.AttributeValue is used here for api package backward compatibility.
 /**
- * Attribute values may be any non-nullish primitive value except an object.
- *
- * null or undefined attribute values are invalid and will result in undefined behavior.
+ * @deprecated please use {@link AttributeValue}
  */
 export type MetricAttributeValue = AttributeValue;